Skip to main content

​
Manual Setup

Follow these steps to set up Documenso on your local machine:
1
Fork Documenso
2
Fork the Documenso repository to your GitHub account.
3
Clone Repository
4
After forking the repository, clone it to your local device by using the following command:
5
git clone https://github.com/<your-username>/documenso
6
Install Dependencies
7
Run npm i in the root directory to install the dependencies required for the project.
8
Set Up Environment Variables
9
Set up the following environment variables in the .env file:
10
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
11
Alternatively, you can run cp .env.example .env to get started with our handpicked defaults.
12
Create Database Schema
13
Create the database schema by running the following command:
14
npm run prisma:migrate-dev
15
Optional: Seed the Database
16
Seed the database with test data by running the following command:
17
npm run prisma:seed -w @documenso/prisma
18
Start the Application
19
Run npm run dev in the root directory to start the application.
20
Access the Application
21
Access the Documenso application by visiting http://localhost:3000 in your web browser.
Optional: Create your signing certificate. To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL), see Create your signing certificate.