The Open Source DocuSign Alternative.
Learn more »

Discord · Website · Issues · Roadmap

🚧 We're currently working on a large scale refactor which can be found on the feat/refresh branch.

Read more on why 👀

Documenso 0.9 - Developer Preview

Note This project is currently under community review and will publish it's first production release soon™.

About this project

Signing documents digitally is fast, easy and should be best practice for every document signed worldwide. This is technically quite easy today, but it also introduces a new party to every signature: The signing tool providers. While this is not a problem in itself, it should make us think about how we want these providers of trust to work. Documenso aims to be the world's most trusted document signing tool. This trust is built by empowering you to self-host Documenso and review how it works under the hood. Join us in creating the next generation of open trust infrastructure.

Recognition

Community and Next Steps 🎯

We're currently working on a redesign of the application including a revamp of the codebase so Documenso can be more intuitive to use and robust to develop upon.

Check out the first source code release in this repository and test it
Tell us what you think in the current Discussions
Join the Discord server for any questions and getting to know to other community members
⭐ the repository to help us raise awareness
Spread the word on Twitter, that Documenso is working towards a more open signing tool
Fix or create issues, that are needed for the first production release

Contributing

To contribute, please see our contribution guide.

Contact us

Activity

Tech

Documenso is built using awesome open source tech including:

Typescript
Javascript (when necessary)
NextJS (JS Fullstack Framework)
Postgres SQL (Database)
Prisma (ORM - Object-relational mapping)
Tailwind CSS (Styling)
Node SignPDF (Digital Signature)
React-PDF for viewing PDFs
PDF-Lib for PDF manipulation
Check out /package.json and /apps/web/package.json for more
Support for opensignpdf (requires Java on server) is currently planned.

Getting Started

Requirements

To run Documenso locally you need

Node.js (Version: >=18.x)
Node Package Manager NPM - included in Node.js
PostgreSQL (local or remote)

Developer Quickstart

Note: This is a quickstart for developers. It assumes that you have both docker and docker-compose installed on your machine.

Want to get up and running quickly? Follow these steps:

Clone the repository it to your local device.

git clone https://github.com/documenso/documenso

Set up your .env file using the recommendations in the .env.example file.
Run npm run dx in the root directory
- This will spin up a postgres database and inbucket mail server in docker containers.
Run npm run dev in the root directory
Want it even faster? Just use
```
npm run d
```

That's it! You should now be able to access the app at http://localhost:3000

Incoming mail will be available at http://localhost:9000

Your database will also be available on port 54320. You can connect to it using your favorite database client.

Developer Setup

Manual Setup

Follow these steps to setup documenso on you local machine:

Clone the repository it to your local device.

git clone https://github.com/documenso/documenso

Run npm i in root directory
Rename .env.example to .env
Set DATABASE_URL value in .env file
- You can use the provided test database url (may be wiped at any point)
- Or setup a local postgres sql instance (recommended)
Create the database scheme by running db-migrate:dev
Setup your mail provider
- Set SENDGRID_API_KEY value in .env file
- You need a SendGrid account, which you can create here.
- Documenso uses Nodemailer so you can easily use your own SMTP server by setting the `SMTP _
- variables` in your .env
Run npm run dev root directory to start
Register a new user at http://localhost:3000/signup

Optional: Seed the database using npm run db-seed to create a test user and document
Optional: Upload and sign apps/web/resources/example.pdf manually to test your setup
Optional: Create your own signing certificate
- A demo certificate is provided in /app/web/resources/certificate.p12
- To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL) see Create your own signing certificate.

Run in Gitpod

Click below to launch a ready-to-use Gitpod workspace in your browser.

Updating

If you pull the newest version from main, using git pull, it may be necessary to regenerate your database client
You can do this by running the generate command in /packages/prisma:
```
npx prisma generate
```
This is not necessary on first clone.

Creating your own signing certificate

For the digital signature of your documents you need a signing certificate in .p12 format (public and private key). You can buy one (not recommended for dev) or use the steps to create a self-signed one:

Generate a private key using the OpenSSL command. You can run the following command to generate a 2048-bit RSA key:

openssl genrsa -out private.key 2048
Generate a self-signed certificate using the private key. You can run the following command to generate a self-signed certificate:

openssl req -new -x509 -key private.key -out certificate.crt -days 365

This will prompt you to enter some information, such as the Common Name (CN) for the certificate. Make sure you enter the correct information. The -days parameter sets the number of days for which the certificate is valid.
Combine the private key and the self-signed certificate to create the p12 certificate. You can run the following command to do this:

openssl pkcs12 -export -out certificate.p12 -inkey private.key -in certificate.crt
You will be prompted to enter a password for the p12 file. Choose a strong password and remember it, as you will need it to use the certificate (can be empty for dev certificates)
Place the certificate /apps/web/resources/certificate.p12

Docker

We are still working on the publishing of docker images, in the meantime you can follow the steps below to create a production ready docker image.

Want to create a production ready docker image? Follow these steps:

cd into docker directory
Make build.sh executable by running chmod +x build.sh
Run ./build.sh to start building the docker image.
Publish the image to your docker registry of choice (or) If you prefer running the image from local, run the below command

docker run -d --restart=unless-stopped -p 3000:3000 -v documenso:/app/data --name documenso documenso:latest

Command Breakdown:

-d - Let's you run the container in background
-p - Passes down which ports to use. First half is the host port, Second half is the app port. You can change the first half anything you want and reverse proxy to that port.
-v - Volume let's you persist the data
--name - Name of the container
documenso:latest - Image you have built

Deployment

We support a variety of deployment methods, and are actively working on adding more. Stay tuned for updates!

Railway

Render

Troubleshooting

I'm not receiving any emails when using the developer quickstart

When using the developer quickstart an Inbucket server will be spun up in a docker container that will store all outgoing email locally for you to view.

The Web UI can be found at http://localhost:9000 while the SMTP port will be on localhost:2500.

Support IPv6

In case you are deploying to a cluster that uses only IPv6. You can use a custom command to pass a parameter to the NextJS start command

For local docker run

docker run -it documenso:latest npm run start -- -H ::

For k8s or docker-compose

containers:
  - name: documenso
    image: documenso:latest
    imagePullPolicy: IfNotPresent
    command:
      - npm
    args:
      - run
      - start
      - --
      - -H
      - "::"

codingiscrazy / documenso Goto Github PK

documenso's Introduction