Self Hosting

Clone the Repository

The first step is to clone the repository:

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

Configure the Environment Variables

Navigate to the documenso folder and create a .env file from the example .env.example file:

cp .env.example .env

Open the .env file and fill in the following variables:

- NEXTAUTH_URL
- NEXTAUTH_SECRET
- NEXT_PUBLIC_WEBAPP_URL
- NEXT_PUBLIC_MARKETING_URL
- NEXT_PRIVATE_DATABASE_URL
- NEXT_PRIVATE_DIRECT_DATABASE_URL
- NEXT_PRIVATE_SMTP_FROM_NAME
- NEXT_PRIVATE_SMTP_FROM_ADDRESS

Install the Dependencies

Install the project dependencies as follows:

npm i
npm run build:web
npm run prisma:migrate-deploy

Start the Application

Finally, start the application:

npm run start

This will start the server on localhost:3000. Any reverse proxy can handle the front end and SSL termination.

Download the Docker Compose File

Download the Docker Compose file from the Documenso repository - compose.yml (opens in a new tab).

Navigate to the compose.yml File

Once downloaded, navigate to the directory containing the compose.yml file.

Set Up Environment Variables

Create a .env file in the same directory as the compose.yml file.

Then add your SMTP details as well as the following environment variables:

NEXTAUTH_SECRET="<your-secret>"
NEXT_PRIVATE_ENCRYPTION_KEY="<your-key>"
NEXT_PRIVATE_ENCRYPTION_SECONDARY_KEY="<your-secondary-key>"
NEXT_PUBLIC_WEBAPP_URL="<your-url>"
NEXT_PRIVATE_SMTP_TRANSPORT="smtp-auth"
NEXT_PRIVATE_SMTP_HOST="<your-host>"
NEXT_PRIVATE_SMTP_PORT=<your-port>
NEXT_PRIVATE_SMTP_USERNAME="<your-username>"
NEXT_PRIVATE_SMTP_PASSWORD="<your-password>"

Update the Volume Binding

The cert.p12 file is required to sign and encrypt documents, so you must provide your key file. Update the volume binding in the compose.yml file to point to your key file:

volumes:
  - /path/to/your/keyfile.p12:/opt/documenso/cert.p12

After updating the volume binding, save the compose.yml file and run the following command to start the containers:

docker-compose --env-file ./.env up -d

The command will start the PostgreSQL database and the Documenso application containers.

Access the Application

Access the Documenso application by visiting http://localhost:3000 in your web browser.

Pull the Docker Image

Pull the Documenso Docker image from DockerHub:

docker pull documenso/documenso

Or, pull the image from GitHub Container Registry:

docker pull ghcr.io/documenso/documenso

Run the Docker Container

Run the Docker container with the required environment variables:

docker run -d \
 -p 3000:3000 \
 -e NEXTAUTH_URL="<your-nextauth-url>"
 -e NEXTAUTH_SECRET="<your-nextauth-secret>"
 -e NEXT_PRIVATE_ENCRYPTION_KEY="<your-next-private-encryption-key>"
 -e NEXT_PRIVATE_ENCRYPTION_SECONDARY_KEY="<your-next-private-encryption-secondary-key>"
 -e NEXT_PUBLIC_WEBAPP_URL="<your-next-public-webapp-url>"
 -e NEXT_PRIVATE_DATABASE_URL="<your-next-private-database-url>"
 -e NEXT_PRIVATE_DIRECT_DATABASE_URL="<your-next-private-database-url>"
 -e NEXT_PRIVATE_SMTP_TRANSPORT="<your-next-private-smtp-transport>"
 -e NEXT_PRIVATE_SMTP_FROM_NAME="<your-next-private-smtp-from-name>"
 -e NEXT_PRIVATE_SMTP_FROM_ADDRESS="<your-next-private-smtp-from-address>"
 -v /path/to/your/keyfile.p12:/opt/documenso/cert.p12
 documenso/documenso

Replace the placeholders with the actual values.

Access the Application

You can access the Documenso application by visiting the URL you provided for the NEXT_PUBLIC_WEBAPP_URL environment variable in your web browser.