mirror of
https://github.com/documenso/documenso.git
synced 2025-11-12 07:43:16 +10:00
8367878395
## 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>
45 lines
2.6 KiB
Plaintext
45 lines
2.6 KiB
Plaintext
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>
|