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
Frappe Sign targets Frappe Framework version 16 (it is tested against 16.50 and later).
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 pages. 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 the cache:
bench build --app frappe_sign
bench --site $SITE_NAME clear-cache
bench restart
Scheduled jobs
Three daily jobs are registered automatically when the app is installed. There is nothing to wire up in hooks.py:
| Job | What it does |
|---|---|
send_daily_signing_reminders |
Re-sends the signing email to signers who can sign now, at most once every Default Reminder Days. See Tamper Detection & Notifications. |
expire_overdue_signing_requests |
Moves requests whose Expires On has passed to Expired. |
run_scheduled_tamper_checks |
Re-checks stored files against their recorded hashes when Enable Tamper Detection is on. |
The site's scheduler must be enabled (bench --site $SITE_NAME enable-scheduler) for these to run.
Roles
Frappe Sign installs three roles:
| Role | Purpose |
|---|---|
| Frappe Sign User | Maintains their own Signer Profile (signature, initials, consent) and signs documents they have been added to. |
| Frappe Sign Sender | Creates and sends signing requests, subject to the configured source DocTypes and any Required Sender Role, and can cancel a not-yet-concluded request they created. |
| Frappe Sign Manager | Manages Frappe Sign Settings and Templates, and can view, cancel (if not yet concluded) and review any signing request. |
System Manager has full administrative access on top of these.
Frappe Sign Certificate and Frappe Sign Event records are read-only evidence for every role, including Frappe Sign Manager. They are never edited or deleted, by design.
Older installations may still have users with the historical Frappe Sign Signer role. It is still recognised for signing access, but new users should be given Frappe Sign User.
External signers (people without a Frappe user account) need no role at all. They sign through their unique emailed link.
Assign roles under User in the normal way before your team starts using Frappe Sign. What each role sees in the sidebar is shown in Navigating Frappe Sign.
Initial setup
Once installed, open Settings from the Frappe Sign sidebar 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.
- Optionally, a PDF signing certificate for certificate-based PDF signing.
Then each signer sets up their own Signer Profile.