Developer Quickstart

Quickly set up Documenso on your machine for local development with Docker and Docker Compose.

Quickstart

Note: This guide assumes that you have both docker and docker-compose installed on your machine.

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

Fork the Documenso repository to your GitHub account.

After forking the repository, clone it to your local device by using the following command:

git clone https://github.com/<your-username>/documenso

Set up your environment variables in the .env file using the .env.example file as a reference.

Alternatively, you can run cp .env.example .env to get started with our handpicked defaults.

Run npm run dx in the root directory.

This will spin up a Postgres database and inbucket mailserver in a docker container.

Run npm run dev in the root directory to start the application.

Want it even faster? Just use:

npm run d

You can access the following services:

Main application - http://localhost:3000
Incoming Mail Access - http://localhost:9000
Database Connection Details:
- Port: 54320
- Connection: Use your favorite database client to connect to the database.
S3 Storage Dashboard - http://localhost:9001