Skip to content

Latest commit

 

History

History
259 lines (178 loc) · 10.9 KB

README.md

File metadata and controls

259 lines (178 loc) · 10.9 KB
Raw
Documenso Logo

The Open Source DocuSign Alternative.
Learn more »

Discord · Website · Issues · Roadmap · Upcoming Launches

Join Documenso on Discord Github Stars License Commits-per-month open in devcontainer Contributor Covenant

🦺 Documenso 1.0 is deployed to our Staging Environment.

The code can be found on the feat/refresh branch.

The new version will be released after the current testing phase.

Join us in testing Documenso 1.0 during MALFUNCTION MANIA

About this project

Signing documents digitally should be fast and easy and should be the 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

Documenso - The open source DocuSign alternative | Product Hunt Documenso - The Open Source DocuSign Alternative. | Product Hunt

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 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

Contact us

Contact us if you are interested in our Enterprise plan for large organizations that need extra flexibility and control.

Book us with Cal.com

Tech Stack

Local Development

Requirements

To run Documenso locally you will need

  • Node.js
  • Postgres SQL Database
  • Docker (optional)

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:

  1. Clone the repository it to your local device.
git clone https://github.com/documenso/documenso

  1. Set up your .env file using the recommendations in the .env.example file. Alternatively just run cp .env.example .env to get started with our handpicked defaults.

  2. Run npm run dx in the root directory

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

  3. Run npm run dev in the root directory

  4. Want it even faster? Just use

npm run d

Access Points for Your Application

  1. App - http://localhost:3000

  2. Incoming Mail Access - http://localhost:9000

  3. Database Connection Details

    • Port: 54320
    • Connection: Use your favorite database client to connect using the provided port.

Developer Setup

Manual Setup

Follow these steps to setup documenso on you local machine:

  1. Clone the repository it to your local device.
git clone https://github.com/documenso/documenso

  1. Run npm i in root directory

  2. Create your .env from the .env.example. You can use cp .env.example .env to get started with our handpicked defaults.

  3. Set the following environement 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

  4. Create the database schema by running npm run prisma:migrate-dev -w @documenso/prisma

  5. Run npm run dev root directory to start

  6. Register a new user at http://localhost:3000/signup

  • Optional: Seed the database using npm run prisma:seed -w @documenso/prisma to create a test user and document
  • Optional: Create your own signing certificate

Run in Gitpod

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

Open in Gitpod

Run in DevContainer

We support DevContainers for VSCode. Click here to get started.

Docker

🚧 Docker containers and images are current in progress. We are actively working on bringing a simple docker build and publish pipeline for Documenso.

Self Hosting

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

Please note the below deployment methods are for v0.9, we will update these to v1.0 once it has been released.

Railway

Deploy on Railway

Render

Deploy to 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 Next.js 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
      - '::'

Repo Activity

Repository Activity