mirror of
https://github.com/documenso/documenso.git
synced 2025-11-15 09:12:02 +10:00
feat: documentation site (#1101)
## Description <!--- Describe the changes introduced by this pull request. --> <!--- Explain what problem it solves or what feature/fix it adds. --> ## Related Issue <!--- If this pull request is related to a specific issue, reference it here using #issue_number. --> <!--- For example, "Fixes #123" or "Addresses #456". --> ## Changes Made <!--- Provide a summary of the changes made in this pull request. --> <!--- Include any relevant technical details or architecture changes. --> - Change 1 - Change 2 - ... ## Testing Performed <!--- Describe the testing that you have performed to validate these changes. --> <!--- Include information about test cases, testing environments, and results. --> - Tested feature X in scenario Y. - Ran unit tests for component Z. - Tested on browsers A, B, and C. - ... ## Checklist <!--- Please check the boxes that apply to this pull request. --> <!--- You can add or remove items as needed. --> - [ ] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [ ] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## Additional Notes <!--- Provide any additional context or notes for the reviewers. --> <!--- This might include details about design decisions, potential concerns, or anything else relevant. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced project README for clarity and improved environment variables section. - Added comprehensive developer and user documentation, including guides on local development, public API, self-hosting, and compliance standards. - Introduced specific guides for contributing, creating API keys, using webhooks, and setting up security measures. - Detailed documentation on various fields available for document signing to improve user understanding. - Added metadata structuring to improve navigation within the documentation site. - **Chores** - Updated `.gitignore` to better handle project files. - **New Features** - Introduced detailed metadata and documentation for various Documenso functionalities, including signing documents, user profiles, and compliance levels. - Added functionality for Direct Link Signing, enabling easy sharing for document signing. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Timur Ercan <timur.ercan31@gmail.com> Co-authored-by: Lucas Smith <me@lucasjamessmith.me> Co-authored-by: David Nguyen <davidngu28@gmail.com>
This commit is contained in:
Catalin Pit
GitHub
18
apps/documentation/pages/users/_meta.json
Normal file
18
apps/documentation/pages/users/_meta.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"index": "Introduction",
|
||||
"-- How To Use": {
|
||||
"type": "separator",
|
||||
"title": "How To Use"
|
||||
},
|
||||
"get-started": "Get Started",
|
||||
"profile": "User Profile",
|
||||
"signing-documents": "Signing Documents",
|
||||
"templates": "Templates",
|
||||
"direct-links": "Direct Signing Links",
|
||||
"-- Legal Overview": {
|
||||
"type": "separator",
|
||||
"title": "Legal Overview"
|
||||
},
|
||||
"licenses": "Licenses",
|
||||
"compliance": "Compliance"
|
||||
}
|
||||
4
apps/documentation/pages/users/compliance/_meta.json
Normal file
4
apps/documentation/pages/users/compliance/_meta.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"signature-levels": "Signature Levels",
|
||||
"standards-and-regulations": "Standards and Regulations"
|
||||
}
|
||||
105
apps/documentation/pages/users/compliance/signature-levels.mdx
Normal file
105
apps/documentation/pages/users/compliance/signature-levels.mdx
Normal file
@ -0,0 +1,105 @@
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
# Signature Levels
|
||||
|
||||
This page outlines our adherence to key regulations across various jurisdictions, including:
|
||||
|
||||
- U.S. ESIGN Act
|
||||
- Uniform Electronic Transactions Act (UETA)
|
||||
- European Union's eIDAS regulation
|
||||
- Switzerland's ZertES
|
||||
|
||||
Whether you require simple electronic signatures or advanced cryptographic sealing, Documenso guarantees that all documents are securely sealed and compliant with the highest standards. Explore our compliance details below to understand how we maintain the integrity and enforceability of your electronic transactions.
|
||||
|
||||
<Callout emoji="🔏">
|
||||
Documenso seals all signed documents cryptographically, regardless of signature level, to prevent
|
||||
any alterations after signing.
|
||||
</Callout>
|
||||
|
||||
## 🇺🇸 ESIGN (Electronic Signatures in Global and National Commerce) Act
|
||||
|
||||
<Callout type="info" emoji="✅">
|
||||
Status: Compliant
|
||||
</Callout>
|
||||
The Electronic Signatures in Global and National Commerce Act (ESIGN Act) is a U.S. federal law that
|
||||
ensures the legal validity and enforceability of electronic signatures and records in commerce.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
- [x] Intent to Sign: "Parties must demonstrate their intent to sign [..]"
|
||||
- [x] Consent: "The ESIGN Act requires that all parties involved in a transaction consent to the use of electronic signatures and records [..]"
|
||||
- [x] Consumer Disclosures: Before obtaining their consent, financial institutions must provide the consumer a clear and conspicuous statement informing the consumer [..]
|
||||
- [x] Record Retention: Electronic Records must be maintained for later access by signers.
|
||||
- [x] Security: The ESIGN Act does not mandate specific security measures, but it does require that parties take reasonable steps to ensure the security and integrity of electronic signatures and records. This may include implementing encryption, access controls, and authentication measures.
|
||||
|
||||
## UETA (Uniform Electronic Transactions Act)
|
||||
|
||||
<Callout type="info" emoji="✅">
|
||||
Status: Compliant
|
||||
</Callout>
|
||||
The Uniform Electronic Transactions Act is a law that provides a legal framework for the use of electronic
|
||||
signatures and records in electronic transactions, ensuring they have the same validity and enforceability
|
||||
as paper documents and handwritten signatures.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
_See [ESIGN](/users/compliance/signature-levels#-esign-electronic-signatures-in-global-and-national-commerce-act)_
|
||||
|
||||
## 🇪🇺 eIDAS
|
||||
|
||||
<Callout type="info" emoji="✅">
|
||||
Status: Compliant for Level 1 - SES (Simple Electronic Signatures)
|
||||
</Callout>
|
||||
eIDAS (Electronic Identification, Authentication and Trust Services) is an EU regulation that standardizes
|
||||
electronic identification and trust services for secure and seamless electronic transactions across European
|
||||
member states.
|
||||
|
||||
### Level 1 - SES (Simple Electronic Signatures)
|
||||
|
||||
eIDAS SES (Simple Electronic Signature) is a basic electronic signature with minimal security features.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
- [x] Visual Signature
|
||||
- [x] Clear Intent to Sign
|
||||
|
||||
### Level 2 - AES (Advanced Electronic Signatures)
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/9) via third party until [Let's
|
||||
Sign](https://github.com/documenso/backlog/issues/21) is realized.
|
||||
</Callout>
|
||||
eIDAS AES (Advanced Electronic Signature) provides a higher level of security with unique identification
|
||||
of the signer and data integrity.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
- [x] Cryptographic Signature Sealing the Document against tampering
|
||||
- [x] Signing Using Dedicated Hardware (Hardware Security Module)
|
||||
- [ ] Embedding Signer Identity in the Cryptographic Signature
|
||||
- [ ] Being a Government Audited Trusted Qualified Services Provider
|
||||
|
||||
### Level 3 - QES (Qualified Electronic Signatures)
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/32) via third party until [Let's
|
||||
Sign](https://github.com/documenso/backlog/issues/21) is realized.
|
||||
</Callout>
|
||||
eIDAS QES (Qualified Electronic Signature) is the highest security level, legally equivalent to a handwritten
|
||||
signature within the EU.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
- [x] Cryptographic Signature Sealing the Document against tampering
|
||||
- [x] Signing using dedicated hardware (Hardware Security Module)
|
||||
- [ ] Embedding Signer Identity in the Cryptographic Signature
|
||||
- [ ] Being a government-trusted qualified services provider
|
||||
- [ ] eIDAS-compliant identification before signing using local passports or similar
|
||||
|
||||
## 🇨🇭 ZertES
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/34)
|
||||
</Callout>
|
||||
|
||||
ZertES is a Swiss Federal law that regulates electronic signature compliance.
|
||||
@ -0,0 +1,45 @@
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
## 21 CFR Part 11
|
||||
|
||||
<Callout type="info" emoji="✅">
|
||||
Status: Compliant (Enterprise License)
|
||||
</Callout>
|
||||
|
||||
21 CFR Part 11 is a regulation by the FDA that establishes the criteria for electronic records and electronic
|
||||
signatures to ensure their authenticity, integrity, and confidentiality in the pharmaceutical, medical
|
||||
device, and other FDA-regulated industries.
|
||||
|
||||
### Main Requirements
|
||||
|
||||
- [x] Strong Identity Checks for each Signature
|
||||
- [x] Signature and Audit Trails
|
||||
- [x] User Access Management
|
||||
- [x] Quality Assurance Documentation
|
||||
|
||||
## SOC/ SOC II
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/24)
|
||||
</Callout>
|
||||
|
||||
SOC II is a framework for managing and auditing the security, availability, processing integrity, confidentiality,
|
||||
and data privacy in cloud and IT service organizations, established by the American Institute of Certified
|
||||
Public Accountants (AICPA).
|
||||
|
||||
## ISO 27001
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/26)
|
||||
</Callout>
|
||||
ISO 27001 is an international standard for managing information security, specifying requirements for
|
||||
establishing, implementing, maintaining, and continually improving an information security management
|
||||
system (ISMS).
|
||||
|
||||
### HIPAA
|
||||
|
||||
<Callout type="warning" emoji="⏳">
|
||||
Status: [Planned](https://github.com/documenso/backlog/issues/25)
|
||||
</Callout>
|
||||
|
||||
The HIPAA (Health Insurance Portability and Accountability Act) is a U.S. law designed to protect patient health information's privacy and security and improve the healthcare system's efficiency and effectiveness.
|
||||
48
apps/documentation/pages/users/direct-links.mdx
Normal file
48
apps/documentation/pages/users/direct-links.mdx
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Direct Link Signing
|
||||
description: Create a shareable link for document signing.
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# Direct Link Signing
|
||||
|
||||
Direct Link Signing allows you to create a shareable link for document signing, where recipients can fill in their information and sign directly. Once the recipients sign the document, they will get it in their email. Also, if they have an account, the document gets saved in their account.
|
||||
|
||||
<Steps>
|
||||
|
||||
### Select a Document
|
||||
|
||||
Identify the template you want to share and make signable with a direct link. Then click on the 3 dots on the right side of the template and select "Direct link".
|
||||
|
||||
|
||||
|
||||
### Enable Direct Links
|
||||
|
||||
Once you click on "Direct link", you will be greeted with a modal where you can learn how direct links work. After reading the information, click "Enable direct link" to proceed.
|
||||
|
||||
|
||||
|
||||
### Select the Recipient
|
||||
|
||||
The next step is to select the recipient for the direct link. You can select an existing recipient or click the "Create one automatically" button to create a new direct link recipient.
|
||||
|
||||
|
||||
|
||||
### Send the Link
|
||||
|
||||
After selecting the recipient, you will get a direct link to share with the recipient. The format of the link is as follows:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/d/<random-generated-string>
|
||||
```
|
||||
|
||||
### Optional: Add Templates to Your Profile
|
||||
|
||||
You can add templates with direct links to your public [Documenso profile](/users/profile) to make them signable anytime.
|
||||
|
||||
|
||||
|
||||
The image above shows a template with a direct link added to the user's profile.
|
||||
|
||||
</Steps>
|
||||
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Create Your Account
|
||||
description: Learn how to create an account on Documenso.
|
||||
---
|
||||
|
||||
import { Steps } from 'nextra/components';
|
||||
|
||||
# Create Your Account
|
||||
|
||||
<Steps>
|
||||
### Pick a Plan
|
||||
|
||||
The first step to start using Documenso is to pick a plan and create an account. At the moment of writing this guide, we have 3 plans available: Free, Individual, and Teams.
|
||||
|
||||
Explore each plan's features and choose the one that best suits your needs. The [pricing page](https://documen.so/pricing) has more information about the plans.
|
||||
|
||||
### Create an account
|
||||
|
||||
If you are unsure which plan to choose, you can start with the free plan and upgrade later.
|
||||
|
||||
To create a free account, navigate to the [registration page](https://documen.so/free) and fill in the required information.
|
||||
|
||||
### Optional: Claim a Premium Username
|
||||
|
||||
You can claim a premium username by upgrading to a paid plan. After upgrading to a paid plan, you can update your [public profile](https://app.documenso.com/settings/public-profile).
|
||||
|
||||
### Optional: Create a Team
|
||||
|
||||
If you are working with others, you can create a team and invite your team members to collaborate on your documents. More information about teams is available in the [Teams section](/users/get-started/teams).
|
||||
|
||||
</Steps>
|
||||
@ -0,0 +1,91 @@
|
||||
---
|
||||
title: Secure Your Account
|
||||
description: Learn how to secure your Documenso account with Two-Factor Authentication (2FA) and Passkeys.
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# Account Security
|
||||
|
||||
Documenso offers several security features to help you protect your account and documents. This guide will walk you through the steps to set up Two-Factor Authentication (2FA) and Passkeys for your account.
|
||||
|
||||
Two-factor authentication (2FA) and Passkeys are used for high-security and high-compliance signatures.
|
||||
|
||||
## Enable Two-Factor Authentication (2FA)
|
||||
|
||||
<Steps>
|
||||
|
||||
### Navigate to Security Settings
|
||||
|
||||
Navigate to your account's [security settings](https://app.documenso.com/settings/security). Here, you can manage your password and other security settings.
|
||||
|
||||
|
||||
|
||||
### Enable 2FA
|
||||
|
||||
Click the "Enable 2FA" button to start setting up Two-Factor Authentication. You will be presented with a QR code that you can scan with your 2FA app or a code that you can manually enter.
|
||||
|
||||
|
||||
|
||||
### Scan the QR Code
|
||||
|
||||
Use your 2FA app (e.g. Google Authenticator, Microsoft Authenticator) to scan the QR code. This will link your account to the 2FA app and generate a code that you can use to log in.
|
||||
|
||||
### Enter the 2FA Generated Code
|
||||
|
||||
After scanning the QR code, you will be prompted to enter the code generated by your 2FA app. After entering the code, click the "Enable 2FA" button to complete the process.
|
||||
|
||||
### 2FA Enabled
|
||||
|
||||
You have successfully enabled Two-Factor Authentication (2FA) for your account. To log in, you must enter the code generated by your 2FA app.
|
||||
|
||||
<Callout>
|
||||
Logging in with Google will not require a 2FA code. As an authentication provider, your Google
|
||||
account is considered secure. e.g. configuring 2FA for your Google account.
|
||||
</Callout>
|
||||
|
||||
<Callout>
|
||||
Logging in using a passkey will also not require a 2FA code since passkeys are considered 2FA by
|
||||
design. The passkey itself is the first factor, and access to the device that holds it is
|
||||
considered the second factor.
|
||||
</Callout>
|
||||
|
||||
### Extra: Save the Backup Codes
|
||||
|
||||
Be sure to download and safely store the 2FA backup codes in case you lose access to your 2FA app. You can use these codes to log in to your account.
|
||||
|
||||
</Steps>
|
||||
|
||||
## Add Passkeys
|
||||
|
||||
A passkey is like a secret password stored locally on your device. You can log in from the device it was created on but not from another device.
|
||||
|
||||
<Steps>
|
||||
|
||||
### Navigate to Security Settings
|
||||
|
||||
Navigate to the [security settings](https://app.documenso.com/settings/security) in your account.
|
||||
|
||||
### Manage Passkeys
|
||||
|
||||
Click the "Manage passkeys" button to start setting up a passkey. You will be taken to a new page where you can manage your passkeys or add a new one.
|
||||
|
||||
|
||||
|
||||
### Add a New Passkey
|
||||
|
||||
To add a new passkey, click the "Add passkey" button. This opens a modal window where you can choose a passkey name.
|
||||
|
||||
|
||||
|
||||
After entering the passkey name, click the "Continue" button to proceed.
|
||||
|
||||
What happens next depends on the passkey provider you have configured. If you have a passkey provider installed in your browser, you will be prompted to add the passkey there. If not, you will be prompted to add the passkey to your browser's passkey manager.
|
||||
|
||||
Whatever option you choose, follow the on-screen instructions to add the passkey. Once the passkey is added, you can use it to log in to your account.
|
||||
|
||||
### Manage Passkeys
|
||||
|
||||
You can manage your passkeys from the passkeys page. You can see the list of passkeys you have added and remove them if needed.
|
||||
|
||||
</Steps>
|
||||
99
apps/documentation/pages/users/get-started/teams.mdx
Normal file
99
apps/documentation/pages/users/get-started/teams.mdx
Normal file
@ -0,0 +1,99 @@
|
||||
---
|
||||
title: Teams
|
||||
description: Learn how to create and manage teams in Documenso.
|
||||
---
|
||||
|
||||
import Image from 'next/image';
|
||||
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# Teams
|
||||
|
||||
Documenso allows you to create teams to collaborate with others on creating and signing documents.
|
||||
|
||||
<Steps>
|
||||
|
||||
### Create a New Team
|
||||
|
||||
Anyone can create a team from their account by clicking on the "+" (plus) button in the "Teams" section from the account dropdown.
|
||||
|
||||
|
||||
|
||||
Each team is a separate entity with its members, documents, and templates. You can create as many teams as you like but remember that each team is billed separately.
|
||||
|
||||
<Callout type="info">You can transfer the ownership of the team at any time.</Callout>
|
||||
|
||||
### Name and URL
|
||||
|
||||
Clicking the "+" button will open a modal where you must pick your team's name and URL. The URL is the team's identifier and will link to the team's page and settings. An example URL would be:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/t/<your-team-name>
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can select a different name and URL for your team, but we recommend using the same or similar name.
|
||||
|
||||
### Invite Team Members
|
||||
|
||||
After creating the team, you can invite team members by navigating to the "Members" tab in the team settings and clicking the "Invite member" button.
|
||||
|
||||
To access the team settings, click on the team's name in the account dropdown and select the appropriate team. Lastly, click again on the avatar and then "Team Settings".
|
||||
|
||||
Or you can copy this URL:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/t/<your-team-name>/settings/members
|
||||
```
|
||||
|
||||
Once you click on the "Invite member" button, you will be prompted to enter the email address of the person you want to invite. You can also select the role of the person you are inviting.
|
||||
|
||||
|
||||
|
||||
You can also bulk-invite members by uploading a CSV file with the email addresses and roles of the people you want to invite.
|
||||
|
||||
The table below shows how the CSV file should be structured:
|
||||
|
||||
| Email address | Role |
|
||||
| -------------------------- | ------- |
|
||||
| team-admin@documenso.com | Admin |
|
||||
| team-manager@documenso.com | Manager |
|
||||
| team-member@documenso.com | Member |
|
||||
|
||||
<Callout type="info">
|
||||
The basic team plan includes 5 members. You can invite as many members as you like by upgrading
|
||||
your team's seats on the team's billing page.
|
||||
</Callout>
|
||||
|
||||
#### Roles
|
||||
|
||||
You can assign different permissions to team members based on their roles. The roles available are:
|
||||
|
||||
| Role | Create, Edit, Send Documents | Manage Users | Manage Admins | Settings | Billing | Delete/ Transfer |
|
||||
| :-----: | :--------------------------: | :----------: | :-----------: | :------: | :-----: | :--------------: |
|
||||
| Member | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
||||
| Manager | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ |
|
||||
| Admin | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
|
||||
| Owner | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
|
||||
### Set a Team Email
|
||||
|
||||
You can add a team email to make signing and sending documents easier. Adding a team email allows you to:
|
||||
|
||||
- See a signing request sent to this email (Team Inbox)
|
||||
- See all documents sent on behalf of the team
|
||||
|
||||
### (Optional) Transfer Team Ownership
|
||||
|
||||
You can transfer the team's ownership at any time. To do this, navigate to the "General" tab in the team settings and click the "Transfer team" button.
|
||||
|
||||
Use this URL to get to the team settings:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/t/<your-team-name>/settings
|
||||
```
|
||||
|
||||
### [Send your First Document](https://app.documenso.com/)
|
||||
|
||||
</Steps>
|
||||
8
apps/documentation/pages/users/index.mdx
Normal file
8
apps/documentation/pages/users/index.mdx
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Get Started
|
||||
description: Get started with Documenso by creating an account, configuring your account security, collaborating with others via Teams, and using the basic features of Documenso.
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
This is a step-by-step guide to getting started with Documenso. You'll learn how to create a new account, configure your account security, collaborate with others via Teams, and use the features of Documenso.
|
||||
5
apps/documentation/pages/users/licenses/_meta.json
Normal file
5
apps/documentation/pages/users/licenses/_meta.json
Normal file
@ -0,0 +1,5 @@
|
||||
{
|
||||
"index": "Overview",
|
||||
"community-edition": "Community Edition",
|
||||
"enterprise-edition": "Enterprise Edition"
|
||||
}
|
||||
@ -0,0 +1,44 @@
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
# Community Edition
|
||||
|
||||
The purpose of the Community Edition is to allow anyone to run their signing infrastructure. You can take Documenso as is and run it yourself with barely any restrictions. We aim to keep self-hosting a realistic option and not force the product to become cloud-only.
|
||||
|
||||
## License
|
||||
|
||||
Documenso and the Community Edition are licensed under [AGPL3](https://github.com/documenso/documenso/blob/main/LICENSE). Below, you can find an overview of the significant licensing terms. The most important thing that you must remember is that if you use the community edition, you must keep it open source:
|
||||
|
||||
> Permissions of this most robust copyleft license are conditioned on making available the complete source code of licensed works and modifications, which include larger works using a licensed work under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available.
|
||||
|
||||
### Permissions
|
||||
|
||||
- Modification - You can fork and modify the community edition.
|
||||
- Distribution - You are free to redistribute the community edition.
|
||||
- Patent use - See license for details.
|
||||
- Private use - You can use the Community Edition privately.
|
||||
|
||||
<Callout type="info">
|
||||
You can use Documenso commercially by hosting the community edition or otherwise (as long as you
|
||||
keep the code open-source).
|
||||
</Callout>
|
||||
|
||||
### Limitations
|
||||
|
||||
- **Liability & Warranty** - While we aim to build a best-in-class product, the community edition comes without an official warranty or liability.
|
||||
|
||||
- **EE Folder** - Features in the EE folder are not licensed under AGPL3 and cannot be used without an enterprise license. You can find a list of enterprise-licensed features [here](https://github.com/documenso/documenso/blob/main/packages/ee/FEATURES).
|
||||
|
||||
- **Official Support** - The Community Edition is not eligible for official customer support. While you can request community support through our Discord Community, it's not guaranteed that you will receive help. The Documenso team might also be happy to help, but be advised that this is strictly voluntary.
|
||||
|
||||
### Conditions
|
||||
|
||||
ℹ️ License and copyright notice
|
||||
ℹ️ State changes
|
||||
ℹ️ Disclose source
|
||||
ℹ️ Network use is distribution
|
||||
|
||||
<Callout type="warning">
|
||||
It's important to remember that you must keep the AGPL3 license for your modified or non-modified
|
||||
version of Documenso. If you need clarification on whether this represents a problem or not for
|
||||
you, reach out to us on [Discord](documen.so/discord).
|
||||
</Callout>
|
||||
@ -0,0 +1,21 @@
|
||||
import { Callout } from 'nextra/components';
|
||||
|
||||
# Enterprise Edition
|
||||
|
||||
The Documenso Enterprise Edition is our license for self-hosters that need the full range of support and compliance. Everything in the EE folder and all features listed [here](https://github.com/documenso/documenso/blob/main/packages/ee/FEATURES) can be used after acquiring a paid license.
|
||||
|
||||
## Includes
|
||||
|
||||
- Self-Host Documenso in any context.
|
||||
- Premium Support via Slack, Discord and Email.
|
||||
- Flexible Licensing (e.g. MIT) for deeper custom integration (if needed).
|
||||
- Access to all Enterprise-grade compliance and administration features.
|
||||
|
||||
## Limitations
|
||||
|
||||
The Enterprise Edition currently has no limitations except custom contract terms.
|
||||
|
||||
<Callout type="info">
|
||||
The Enterprise Edition requires a paid subscription. [Contact us for a
|
||||
quote](https://documen.so/enterprise).
|
||||
</Callout>
|
||||
16
apps/documentation/pages/users/licenses/index.mdx
Normal file
16
apps/documentation/pages/users/licenses/index.mdx
Normal file
@ -0,0 +1,16 @@
|
||||
# Self-Hosting Licenses
|
||||
|
||||
Documenso comes in two versions for self-hosting:
|
||||
|
||||
### [Community Edition (Free)](licenses/community-edition)
|
||||
|
||||
- Free
|
||||
- No official support
|
||||
|
||||
### [Enterprise Edition (Paid)](licenses/enterprise-edition)
|
||||
|
||||
- Paid
|
||||
- Official support
|
||||
- Enterprise Features
|
||||
|
||||
The choice between the two editions is entirely yours, depending on your specific needs. If you require official support and enterprise-level compliance, the Enterprise Edition is likely the best fit. However, if you find that the Community Edition, with its almost unrestricted features and use cases (including commercial use), meets all your requirements, we encourage you to start with it. Remember, you can always upgrade later.
|
||||
68
apps/documentation/pages/users/profile.mdx
Normal file
68
apps/documentation/pages/users/profile.mdx
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: User Profile
|
||||
description: Learn how to set up your public profile on Documenso.
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# User Profile
|
||||
|
||||
Documenso allows you to create a public profile to share your templates for anyone to sign. This is useful for distributing and collecting signatures for commonly used documents, making it more efficient for both the document creator and the signers.
|
||||
|
||||
<Callout type="info">A free Documenso account gives you 5 free signatures per month.</Callout>
|
||||
|
||||
<Steps>
|
||||
|
||||
### Navigate to Your Profile Settings
|
||||
|
||||
Click on your profile picture in the top right corner and select "User settings". Then, navigate to the "Public Profile" tab to configure your profile.
|
||||
|
||||
|
||||
|
||||
### (Mandatory) Set Your Profile URL
|
||||
|
||||
This is the URL that people will use to access your profile. We recommend choosing something easy to remember and share.
|
||||
|
||||
The structure of the URL is as follows:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/p/<username>
|
||||
```
|
||||
|
||||
Setting the public profile URL is mandatory to publish your profile.
|
||||
|
||||
### (Optional) Add a Bio Description
|
||||
|
||||
If you want to add a description to your profile, you can do so here. This is a good place to introduce yourself and explain what kind of documents you have available for signing.
|
||||
|
||||
### (Optional) Add a Profile Picture
|
||||
|
||||
Uploading a profile picture is optional, but we recommend it to make your profile more recognizable.
|
||||
|
||||
### Private/Public Profile
|
||||
|
||||
You can choose to make your profile public or private. Only you can access it if you make it private. If you make it public, anyone with the link can access it.
|
||||
|
||||
To make your profile public, toggle the switch to the right ("Show") at the top right-hand side of the page.
|
||||
|
||||
### (Optional) Link Templates
|
||||
|
||||
Linking templates to your profile is optional, but it's what makes your profile helpful. Linking templates allow people to sign documents directly from your profile. As a result, we recommend linking at least one template you want to share with others.
|
||||
|
||||
Learn more about [templates](/users/templates).
|
||||
|
||||
### Publish your Profile
|
||||
|
||||
After configuring your profile, click the "Update" button at the bottom of the page to publish it. Once you have published your profile, you can share the link with others if you made it public.
|
||||
|
||||
|
||||
|
||||
The image above shows an example of a public profile on Documenso.
|
||||
|
||||
### Share the Link
|
||||
|
||||
Add the link to your other social profiles and share it on social media so people know they can quickly sign your documents from there.
|
||||
|
||||
<Callout>Tag @documenso on X to get a retweet and an endorsement from us.</Callout>
|
||||
|
||||
</Steps>
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"index": "Send Documents",
|
||||
"fields": "Document Fields"
|
||||
}
|
||||
446
apps/documentation/pages/users/signing-documents/fields.mdx
Normal file
446
apps/documentation/pages/users/signing-documents/fields.mdx
Normal file
@ -0,0 +1,446 @@
|
||||
---
|
||||
title: Document Fields
|
||||
description: Learn about the different fields you can add to your documents in Documenso.
|
||||
---
|
||||
|
||||
# Document Fields
|
||||
|
||||
Learn about the different fields you can add to your documents in Documenso and how to make the most of them.
|
||||
|
||||
## Signature Field
|
||||
|
||||
The signature field collects the signer's signature. It's required for each recipient with the "Signer" role.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
||||
|
||||
|
||||
|
||||
### Document Signing View
|
||||
|
||||
The recipient will see the signature field when they open the document to sign.
|
||||
|
||||
The recipient must click on the signature field to open the signing view, where they can sign using their mouse, touchpad, or touchscreen.
|
||||
|
||||
|
||||
|
||||
The image below shows the signature field signed by the recipient.
|
||||
|
||||
|
||||
|
||||
After signing, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Email Field
|
||||
|
||||
The email field is used to collect the signer's email address.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
||||
|
||||
|
||||
|
||||
### Document Signing View
|
||||
|
||||
When the recipient opens the document to sign, they will see the email field.
|
||||
|
||||
The recipient must click on the email field to automatically sign the field with the email associated with their account.
|
||||
|
||||
|
||||
|
||||
The image below shows the email field signed by the recipient.
|
||||
|
||||
|
||||
|
||||
After entering their email address, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Name Field
|
||||
|
||||
The name field is used to collect the signer's name.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
||||
|
||||
|
||||
|
||||
### Document Signing View
|
||||
|
||||
When the recipient opens the document to sign, they will see the name field.
|
||||
|
||||
The recipient must click on the name field, which will automatically sign the field with the name associated with their account.
|
||||
|
||||
|
||||
|
||||
The image below shows the name field signed by the recipient.
|
||||
|
||||
|
||||
|
||||
After entering their name, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Date Field
|
||||
|
||||
The date field is used to collect the date of the signature.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
The field doesn't have any additional settings. You just need to place it on the document where you want the signer to sign.
|
||||
|
||||
|
||||
|
||||
### Document Signing View
|
||||
|
||||
When the recipient opens the document to sign, they will see the date field.
|
||||
|
||||
The recipient must click on the date field to automatically sign the field with the current date and time.
|
||||
|
||||
|
||||
|
||||
The image below shows the date field signed by the recipient.
|
||||
|
||||
|
||||
|
||||
After entering the date, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Text Field
|
||||
|
||||
The text field is used to collect text input from the signer.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
Place the text field on the document where you want the signer to enter text. The text field comes with additional settings that can be configured.
|
||||
|
||||
|
||||
|
||||
To open the settings, click on the text field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
||||
|
||||
|
||||
|
||||
The text field settings include:
|
||||
|
||||
- **Label** - The label displayed in the field.
|
||||
- **Placeholder** - The placeholder text displayed in the field.
|
||||
- **Text** - The default text displayed in the field.
|
||||
- **Character limit** - The maximum number of characters allowed in the field.
|
||||
- **Required** - Whether the field is required or not.
|
||||
- **Read only** - Whether the field is read-only or not.
|
||||
|
||||
It also comes with a couple of rules:
|
||||
|
||||
- The field can't be required and read-only at the same time.
|
||||
- A read-only field can't have an empty text field. It must have a default text value.
|
||||
- The signer must fill out a required field.
|
||||
- The text field characters count can't exceed the character limit.
|
||||
- The signer can't modify a read-only field.
|
||||
- The field auto-signs if there is a default text value.
|
||||
|
||||
Let's look at the following example.
|
||||
|
||||
|
||||
|
||||
The field is configured as follows:
|
||||
|
||||
- Label: "Address"
|
||||
- Placeholder: "Your office address"
|
||||
- Default Text: "Signing Street 1, 241245"
|
||||
- Character Limit: 35
|
||||
- Required: False
|
||||
- Read Only: False
|
||||
|
||||
Since the field has a label set, the label is displayed instead of the default text field value - "Add text".
|
||||
|
||||
### Document Signing View
|
||||
|
||||
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
||||
|
||||
In this case, the recipient sees the text field signed with the default value.
|
||||
|
||||
|
||||
|
||||
The recipient can modify the text field value since the field is not read-only. To change the value, the recipient must click the field to un-sign it.
|
||||
|
||||
Once it's unsigned, the field uses the label set by the sender.
|
||||
|
||||
|
||||
|
||||
To sign the field with a different value, the recipient needs to click on the field and enter the new value.
|
||||
|
||||
|
||||
|
||||
Since the text field has a character limit, the recipient must enter a value that doesn't exceed the limit. Otherwise, an error message will appear, and the field will not be signed.
|
||||
|
||||
The image below illustrates the text field signed with a new value.
|
||||
|
||||
|
||||
|
||||
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Number Field
|
||||
|
||||
The number field is used for collecting a number input from the signer.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
Place the number field on the document where you want the signer to enter a number. The number field comes with additional settings that can be configured.
|
||||
|
||||
|
||||
|
||||
To open the settings, click on the number field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
||||
|
||||
|
||||
|
||||
The number field settings include:
|
||||
|
||||
- **Label** - The label displayed is the field.
|
||||
- **Placeholder** - The placeholder text displayed in the field.
|
||||
- **Value** - The default number displayed in the field.
|
||||
- **Number format** - The format of the number.
|
||||
- **Required** - Whether the field is required or not.
|
||||
- **Read only** - Whether the field is read-only or not.
|
||||
- **Validation** - The validation rules for the field.
|
||||
|
||||
It also comes with a couple of rules:
|
||||
|
||||
- The value must be a number.
|
||||
- The field can't be required and read-only at the same time.
|
||||
- A read-only field can't have an empty number field. It must have a default number value.
|
||||
- The signer must fill out a required field.
|
||||
- If the default number and a max value are set, the default number must be less than the max value.
|
||||
- If the default number and a min value are set, the default number must be greater than the min value.
|
||||
- The value must match the number format if a number format is set.
|
||||
|
||||
In this example, the number field is configured as follows:
|
||||
|
||||
- Label: "Quantity"
|
||||
- Placeholder: "Enter the preferred quantity"
|
||||
- Default Value: 12
|
||||
- Number Format: "123,456,789.00"
|
||||
- Required: False
|
||||
- Read Only: False
|
||||
- Validation:
|
||||
- Min value: 5, Max value: 50
|
||||
|
||||
|
||||
|
||||
Since the field has a label set, the label is displayed instead of the default number field value - "Add number".
|
||||
|
||||
### Document Signing View
|
||||
|
||||
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
||||
|
||||
The recipient sees the number field signed with the default value in this case.
|
||||
|
||||
|
||||
|
||||
Since the number field is not read-only, the recipient can modify its value. To change the value, the recipient must click the field to un-sign it.
|
||||
|
||||
Once it's unsigned, the field uses the label set by the sender.
|
||||
|
||||
|
||||
|
||||
To sign the field with a different value, the recipient needs to click on the field and enter the new value.
|
||||
|
||||
|
||||
|
||||
Since the number field has a validation rule set, the recipient must enter a value that meets the rules. In this example, the value needs to be between 5 and 50. Otherwise, an error message will appear, and the field will not be signed.
|
||||
|
||||
The image below illustrates the text field signed with a new value.
|
||||
|
||||
|
||||
|
||||
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Radio Field
|
||||
|
||||
The radio field is used to collect a single choice from the signer.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
Place the radio field on the document where you want the signer to select a choice. The radio field comes with additional settings that can be configured.
|
||||
|
||||
|
||||
|
||||
To open the settings, click on the radio field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
||||
|
||||
|
||||
|
||||
The radio field settings include:
|
||||
|
||||
- **Required** - Whether the field is required or not.
|
||||
- **Read only** - Whether the field is read-only or not.
|
||||
- **Values** - The list of choices for the field.
|
||||
|
||||
It also comes with a couple of rules:
|
||||
|
||||
- The field can't be required and read-only at the same time.
|
||||
- A read-only field can't have an empty radio field. It must have at least one option.
|
||||
- The signer must fill out a required field.
|
||||
- The field auto-signs if there is a default value.
|
||||
- The signer can't sign with a value not in the options list.
|
||||
- The signer can't modify the field if it's read-only.
|
||||
- It should contain at least one option.
|
||||
- The field can't have more than one option selected.
|
||||
|
||||
In this example, the radio field is configured as follows:
|
||||
|
||||
- Required: False
|
||||
- Read Only: False
|
||||
- Options:
|
||||
- Option 1
|
||||
- Option 2
|
||||
- Empty value
|
||||
- Empty value
|
||||
- Option 3
|
||||
|
||||
|
||||
|
||||
Since the field contains radio options, it displays them instead of the default radio field value, "Radio".
|
||||
|
||||
### Document Signing View
|
||||
|
||||
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
||||
|
||||
In this case, the recipient sees the radio field unsigned because the sender didn't select a value.
|
||||
|
||||
|
||||
|
||||
The recipient can select one of the options by clicking on the radio button next to the option.
|
||||
|
||||
|
||||
|
||||
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Checkbox Field
|
||||
|
||||
The checkbox field is used to collect multiple choices from the signer.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
Place the checkbox field on the document where you want the signer to select choices. The checkbox field comes with additional settings that can be configured.
|
||||
|
||||
|
||||
|
||||
To open the settings, click on the checkbox field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
||||
|
||||
|
||||
|
||||
The checkbox field settings include the following:
|
||||
|
||||
- **Validation** - The validation rules for the field.
|
||||
- **Rule** - The rule specifies "At least", "At most", and "Exactly".
|
||||
- **Number** - The number of choices that must be selected.
|
||||
- **Required** - Whether the field is required or not.
|
||||
- **Read only** - Whether the field is read-only or not.
|
||||
- **Options** - The list of choices for the field.
|
||||
|
||||
It also comes with a couple of rules:
|
||||
|
||||
- The field can't be required and read-only at the same time.
|
||||
- A read-only field can't have an empty checkbox field. It must have at least one checked option.
|
||||
- The signer must fill out a required field.
|
||||
- The field auto-signs if there is a default value.
|
||||
- The signer can't sign with a value not in the options list.
|
||||
- The signer can't modify the field if it's read-only.
|
||||
- It should contain at least one option.
|
||||
|
||||
In this example, the checkbox field is configured as follows:
|
||||
|
||||
- No validation rules
|
||||
- Required: True
|
||||
- Read Only: False
|
||||
- Options:
|
||||
- Option 1
|
||||
- Empty value (checked)
|
||||
- Option 2
|
||||
- Option 3 (checked)
|
||||
- Empty value
|
||||
|
||||
|
||||
|
||||
Since the field contains checkbox options, it displays them instead of the default checkbox field value, "Checkbox".
|
||||
|
||||
### Document Signing View
|
||||
|
||||
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
||||
|
||||
In this case, the recipient sees the checkbox field signed with the values selected by the sender.
|
||||
|
||||
|
||||
|
||||
Since the field is required, the recipient can either sign with the values selected by the sender or modify the values.
|
||||
|
||||
The values can be modified in 2 ways:
|
||||
|
||||
- Click on the options you want to select or deselect.
|
||||
- Hover over the field and click the "X" button to clear all the selected values.
|
||||
|
||||
The image below illustrates the checkbox field with the values cleared by the recipient. Since the field is required, it has a red border instead of the yellow one (non-required fields).
|
||||
|
||||
|
||||
|
||||
Then, the recipient can select values other than the ones chosen by the sender.
|
||||
|
||||
|
||||
|
||||
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
||||
|
||||
## Dropdown/Select Field
|
||||
|
||||
The dropdown/select field collects a single choice from a list of options.
|
||||
|
||||
### Document Editor View
|
||||
|
||||
Place the dropdown/select field on the document where you want the signer to select a choice. The dropdown/select field comes with additional settings that can be configured.
|
||||
|
||||
|
||||
|
||||
To open the settings, click on the dropdown/select field and then on the "Sliders" icon. That opens the settings panel on the right side of the screen.
|
||||
|
||||
|
||||
|
||||
The dropdown/select field settings include:
|
||||
|
||||
- **Required** - Whether the field is required or not.
|
||||
- **Read only** - Whether the field is read-only or not.
|
||||
- **Options** - The list of choices for the field.
|
||||
- **Default** value - The default value selected in the field.
|
||||
|
||||
It also comes with a couple of rules:
|
||||
|
||||
- The field can't be required and read-only at the same time.
|
||||
- A read-only field can't have an empty select field. It must have a default value.
|
||||
- The signer must fill out a required field.
|
||||
- The default value must be one of the options.
|
||||
- The field auto-signs if there is a default value.
|
||||
- The field can't be signed with a value not in the options list.
|
||||
- The signer can't modify the field if it's read-only.
|
||||
- It should contain at least one option.
|
||||
|
||||
In this example, the dropdown/select field is configured as follows:
|
||||
|
||||
- Required: False
|
||||
- Read Only: False
|
||||
- Default Value: None
|
||||
- Options:
|
||||
- Document
|
||||
- Template
|
||||
- Other
|
||||
|
||||
### Document Signing View
|
||||
|
||||
What the recipient sees when they open the document to sign depends on the settings configured by the sender.
|
||||
|
||||
In this case, the recipient sees the dropdown/select field with the default label, "-- Select ---" since the sender has not set a default value.
|
||||
|
||||
|
||||
|
||||
The recipient can modify the dropdown/select field value since the field is not read-only. To change the value, the recipient must click on the field for the dropdown list to appear.
|
||||
|
||||
|
||||
|
||||
The recipient can select one of the options from the list. The image below illustrates the dropdown/select field signed with a new value.
|
||||
|
||||
|
||||
|
||||
After signing the field, the recipient can click the "Complete" button to complete the signing process.
|
||||
152
apps/documentation/pages/users/signing-documents/index.mdx
Normal file
152
apps/documentation/pages/users/signing-documents/index.mdx
Normal file
@ -0,0 +1,152 @@
|
||||
---
|
||||
title: Send a document for signing
|
||||
description: The guide gives a detailed description of all options available when sending out a document for signing.
|
||||
---
|
||||
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# Send Documents for Signing
|
||||
|
||||
This guide will walk you through the process of sending a document out for signing. You will learn how to upload a document, add recipients, place signature fields, and send the document for signing.
|
||||
|
||||
<Steps>
|
||||
### Login Into Your Account
|
||||
|
||||
The guide assumes you have a Documenso account. If you don't, you can create a free account [here](https://documen.so/free-docs).
|
||||
|
||||
### Upload Document
|
||||
|
||||
Navigate to the [Documenso dashboard](https://app.documenso.com/documents) and click on the "Add a document" button. Select the document you want to upload and wait for the upload to complete.
|
||||
|
||||
|
||||
|
||||
After the upload is complete, you will be redirected to the document's page. You can configure the document's settings and add recipients and fields here.
|
||||
|
||||
|
||||
|
||||
### (Optional) Advanced Options
|
||||
|
||||
Click on the "Advanced options" button to access additional settings for the document. You can set an external ID, date format, time zone, and the redirect URL.
|
||||
|
||||
|
||||
|
||||
The external ID allows you to set a custom ID for the document that can be used to identify the document in your external system(s).
|
||||
|
||||
The date format and time zone settings allow you to customize how the date and time are displayed in the document.
|
||||
|
||||
The redirect URL allows you to specify a URL where the signer will be redirected after signing the document.
|
||||
|
||||
### (Optional) Document Access
|
||||
|
||||
Documenso enables you to set up access control for your documents. You can require authentication for viewing the document.
|
||||
|
||||
The available options are:
|
||||
|
||||
- **Require account** - The recipient must be signed in to view the document.
|
||||
- **None** - The document can be accessed directly by the URL sent to the recipient.
|
||||
|
||||
|
||||
|
||||
<Callout type="info">
|
||||
The "Document Access" feature is only available for Enterprise accounts.
|
||||
</Callout>
|
||||
|
||||
### (Optional) Recipient Authentication
|
||||
|
||||
The "Recipient Authentication" feature allows you to specify the authentication method required for recipients to sign the signature field.
|
||||
|
||||
The available options are:
|
||||
|
||||
- **Require passkey** - The recipient must have an account and passkey configured via their settings.
|
||||
- **Require 2FA** - The recipient must have an account and 2FA enabled via their settings.
|
||||
- **None** - No authentication required.
|
||||
|
||||
|
||||
|
||||
This can be overridden by setting the authentication requirements directly for each recipient in the next step.
|
||||
|
||||
<Callout type="info">
|
||||
The "Recipient Authentication" feature is only available for Enterprise accounts.
|
||||
</Callout>
|
||||
|
||||
### Recipients
|
||||
|
||||
Click the "+ Add Signer" button to add a new recipient. You can configure the recipient's email address, name, role, and authentication method on this page.
|
||||
|
||||
You can choose any option from the ["Recipient Authentication"](#optional-recipient-authentication) section, or you can set it to "Inherit authentication method" to use the global action signing authentication method configured in the "General Settings" step.
|
||||
|
||||
|
||||
|
||||
You can also set the recipient's role, which determines their actions and permissions in the document.
|
||||
|
||||
|
||||
|
||||
#### Roles
|
||||
|
||||
Documenso has 4 roles for recipients with different permissions and actions.
|
||||
|
||||
| Role | Function | Action required | Signature |
|
||||
| :------: | :-----------------------------------------------------------------------------: | :-------------: | :-------: |
|
||||
| Signer | Needs to sign signatures fields assigned to them. | Yes | Yes |
|
||||
| Approver | Needs to approve the document as a whole. Signature optional. | Yes | Optional |
|
||||
| Viewer | Needs to confirm they viewed the document. | Yes | No |
|
||||
| BCC | Receives a copy of the signed document after completion. No action is required. | No | No |
|
||||
|
||||
### Fields
|
||||
|
||||
Documenso supports 9 different field types that can be added to the document. Each field type collects various information from the recipients when they sign the document.
|
||||
|
||||
|
||||
|
||||
The available field types are:
|
||||
|
||||
- **Signature** - Collects the signer's signature
|
||||
- **Email** - Collects the signer's email address
|
||||
- **Name** - Collects the signer's name
|
||||
- **Date** - Collects the date of the signature
|
||||
- **Text** - Collects text input from the signer
|
||||
- **Number** - Collects a number input from the signer
|
||||
- **Radio** - Collects a single choice from the signer
|
||||
- **Checkbox** - Collects multiple choices from the signer
|
||||
- **Dropdown/Select** - Collects a single choice from a list of choices
|
||||
|
||||
All fields can be placed anywhere on the document and resized as needed.
|
||||
|
||||
<Callout type="info">
|
||||
Learn more about the available field types and how to use them on the [Fields
|
||||
page](signing-documents/fields).
|
||||
</Callout>
|
||||
|
||||
#### Signature Required
|
||||
|
||||
Signer Roles require at least 1 signature field. You will get an error message if you try to send a document without a signature field.
|
||||
|
||||
|
||||
|
||||
### Email Settings
|
||||
|
||||
Before sending the document, you can configure the email settings and customize the subject line, message, and sender name.
|
||||
|
||||
|
||||
|
||||
If you leave the email subject and message empty, Documenso will use the default email template.
|
||||
|
||||
### Sending the Document
|
||||
|
||||
After configuring the document, click the "Send" button to send the document to the recipients. The recipients will receive an email with a link to sign the document.
|
||||
|
||||
|
||||
|
||||
#### Signing Link
|
||||
|
||||
If you need to copy the signing link for each recipient, you can do so by clicking on the recipient whose link you want to copy. The signing link is copied automatically to your clipboard.
|
||||
|
||||
|
||||
|
||||
The signing link has the following format:
|
||||
|
||||
```bash
|
||||
https://app.documenso.com/sign/12ACP777zxQLO52hjj_vCB
|
||||
```
|
||||
|
||||
</Steps>
|
||||
100
apps/documentation/pages/users/templates.mdx
Normal file
100
apps/documentation/pages/users/templates.mdx
Normal file
@ -0,0 +1,100 @@
|
||||
import { Callout, Steps } from 'nextra/components';
|
||||
|
||||
# Document Templates
|
||||
|
||||
Documenso allows you to create templates, which are reusable documents. Templates are helpful if you often send the same type of document, such as contracts, agreements, or invoices, as they help you save time.
|
||||
|
||||
<Steps>
|
||||
|
||||
### Create New Template
|
||||
|
||||
To create a new template, navigate to the ["Templates" page](https://app.documenso.com/templates) and click on the "New Template" button.
|
||||
|
||||
|
||||
|
||||
Clicking on the "New Template" button opens a new modal to upload the document you want to use as a template. Select the document and wait for Documenso to upload it to your account.
|
||||
|
||||
|
||||
|
||||
Once the upload is complete, Documenso opens the template configuration page.
|
||||
|
||||
|
||||
|
||||
You can then configure the template by adding recipients, fields, and other options.
|
||||
|
||||
### (Optional) Email options
|
||||
|
||||
When you send a document for signing, Documenso emails the recipients with a link to the document. The email contains a subject, message, and the document.
|
||||
|
||||
Documenso uses a generic subject and message but also allows you to customize them for each document and template.
|
||||
|
||||
|
||||
|
||||
To configure the email options, click the "Email Options" tab and fill in the subject and message fields. Every time you use this template for signing, Documenso will use the custom subject and message you provided. They can also be overridden before sending the document.
|
||||
|
||||
### (Optional) Advanced Options
|
||||
|
||||
The template also has advanced options that you can configure. These options include settings such as the external ID, date format, time zone and the redirect URL.
|
||||
|
||||
|
||||
|
||||
The external ID allows you to set a custom ID for the document that can be used to identify the document in your external system(s).
|
||||
|
||||
The date format and time zone settings allow you to customize how the date and time are displayed in the document.
|
||||
|
||||
The redirect URL allows you to specify a URL where the signer will be redirected after signing the document.
|
||||
|
||||
### Add Placeholders or Recipients
|
||||
|
||||
You can add placeholders for the template recipients. Placeholders specify where the recipient's name, email, and other information should be in the document.
|
||||
|
||||
You can also add recipients directly to the template. Recipients are the people who will receive the document for signing.
|
||||
|
||||
|
||||
|
||||
If you add placeholders to the template, you must replace them with actual recipients when creating a document from it. See the modal from the ["Use a Template"](#use-a-template) section.
|
||||
|
||||
### Add Fields
|
||||
|
||||
The last step involves adding fields to the document. These fields collect information from the recipients when they sign the document.
|
||||
|
||||
Documenso provides the following field types:
|
||||
|
||||
- **Signature** - Collects the signer's signature
|
||||
- **Email** - Collects the signer's email address
|
||||
- **Name** - Collects the signer's name
|
||||
- **Date** - Collects the date of the signature
|
||||
- **Text** - Collects text input from the signer
|
||||
- **Number** - Collects a number input from the signer
|
||||
- **Radio** - Collects a single choice from the signer
|
||||
- **Checkbox** - Collects multiple choices from the signer
|
||||
- **Dropdown/Select** - Collects a single choice from a list of choices
|
||||
|
||||
|
||||
|
||||
After adding the fields, press the "Save Template" button to save the template.
|
||||
|
||||
<Callout type="info">
|
||||
Learn more about the available field types and how to use them on the [Fields
|
||||
page](signing-documents/fields).
|
||||
</Callout>
|
||||
|
||||
### Use a Template
|
||||
|
||||
Click on the "Use Template" button to create a new document from the template. Before creating the document, you are asked to fill in the recipients for the placeholders you added to the template.
|
||||
|
||||
After filling in the recipients, click the "Create Document" button to create the document in your account.
|
||||
|
||||
|
||||
|
||||
You can also send the document straight to the recipients for signing by checking the "Send document" checkbox.
|
||||
|
||||
### (Optional) Create A Direct Signing Link
|
||||
|
||||
A direct signing link allows you to create a shareable link for document signing, where recipients can fill in their information and sign the document. See the "Create Direct Link" button in the image from [step 4](#add-placeholders-or-recipients).
|
||||
|
||||
<Callout type="info">
|
||||
Check out the [Direct Signing Links](/users/direct-links) section for more information.
|
||||
</Callout>
|
||||
|
||||
</Steps>
|
||||
Reference in New Issue
Block a user