Installation & Roles

Installing the app

From your Frappe bench:

cd $PATH_TO_YOUR_BENCH
bench get-app https://github.com/buff0k/frappe_sign --branch version-16
bench --site $SITE_NAME install-app frappe_sign
bench --site $SITE_NAME migrate
bench build --app frappe_sign
bench restart

Updating

cd $PATH_TO_YOUR_BENCH/apps/frappe_sign
git pull

cd $PATH_TO_YOUR_BENCH
bench --site $SITE_NAME migrate
bench build --app frappe_sign
bench --site $SITE_NAME clear-cache
bench restart

Required assets

Frappe Sign uses PDF.js in the Designer and the signing portal. After building, confirm these files exist:

/assets/frappe_sign/js/pdfjs/pdf.min.js
/assets/frappe_sign/js/pdfjs/pdf.worker.min.js

If PDF rendering fails anywhere in the app, rebuild and clear cache:

bench build --app frappe_sign
bench --site $SITE_NAME clear-cache
bench restart

Roles

Frappe Sign defines three roles:

Role	Purpose
Frappe Sign User	Can maintain a signing profile (signature, initials) and sign documents they've been added to as a signer.
Frappe Sign Sender	Can create and send signing requests, subject to whichever source DocTypes are configured, and can cancel a not-yet-concluded request they created.
Frappe Sign Manager	Can manage Frappe Sign Settings and Templates, and can view, cancel (if not yet concluded), and review any signing request. Certificate and Event records stay read-only for every role, including Manager - they're immutable evidence and are never edited or deleted, by design.

System Manager has full administrative access on top of these.

Assign roles under User in the normal way before your team starts using Frappe Sign.

Initial setup

Once installed, open Frappe Sign Settings from the Frappe Sign workspace and work through:

General signing configuration and security settings - see Frappe Sign Settings.
Which Frappe DocTypes can be used as signing sources - see Configured Source DocTypes.
(Optional) A PDF signing certificate, if you want certificate-based PDF signing.

Then each signer should set up their own Signer Profile.