mirror of
https://github.com/documenso/documenso.git
synced 2026-07-10 21:15:15 +10:00
Lucas Smith
94adea149d
Refresh README/docs for the current stack, add a security policy, note the external-PR pause, and remove dead config and workflows.
162 lines
4.4 KiB
Plaintext
162 lines
4.4 KiB
Plaintext
---
|
|
title: Self-Hosting
|
|
description: Deploy and manage your own Documenso instance for complete control over your data, compliance, and customization.
|
|
---
|
|
|
|
import { Callout } from 'fumadocs-ui/components/callout';
|
|
|
|
## Getting Started
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Requirements"
|
|
description="System requirements and prerequisites."
|
|
href="/docs/self-hosting/getting-started/requirements"
|
|
/>
|
|
<Card
|
|
title="Quick Start"
|
|
description="Get running with Docker in 5 minutes."
|
|
href="/docs/self-hosting/getting-started/quick-start"
|
|
/>
|
|
</Cards>
|
|
|
|
<Callout type="error">
|
|
**You must generate a signing certificate.** Documenso does not ship with one. Without a
|
|
certificate, the application starts normally but document signing will fail.
|
|
|
|
Please see all the [requirements](/docs/self-hosting/getting-started/requirements) before proceeding.
|
|
</Callout>
|
|
|
|
<Callout type="warn">
|
|
**You are responsible for your own network security.** Documenso applies best-effort, non-exhaustive
|
|
checks to outbound requests such as webhooks, but these are not a complete SSRF mitigation and they
|
|
fail open. A self-hosted instance can reach internal addresses on your network. Restricting outbound
|
|
traffic, egress filtering, and blocking access to internal services and cloud metadata endpoints is
|
|
your responsibility through your firewall and network configuration.
|
|
</Callout>
|
|
|
|
---
|
|
|
|
## Deployment Options
|
|
|
|
Choose a deployment method based on your needs:
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Docker"
|
|
description="Single container with external database."
|
|
href="/docs/self-hosting/deployment/docker"
|
|
/>
|
|
<Card
|
|
title="Docker Compose"
|
|
description="Production-ready setup with all dependencies."
|
|
href="/docs/self-hosting/deployment/docker-compose"
|
|
/>
|
|
<Card
|
|
title="Railway"
|
|
description="One-click deployment on managed infrastructure."
|
|
href="/docs/self-hosting/deployment/railway"
|
|
/>
|
|
<Card
|
|
title="Kubernetes"
|
|
description="High availability for enterprise deployments."
|
|
href="/docs/self-hosting/deployment/kubernetes"
|
|
/>
|
|
</Cards>
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Environment Variables"
|
|
description="Complete reference of all configuration options."
|
|
href="/docs/self-hosting/configuration/environment"
|
|
/>
|
|
<Card
|
|
title="Database"
|
|
description="PostgreSQL setup and connection."
|
|
href="/docs/self-hosting/configuration/database"
|
|
/>
|
|
<Card
|
|
title="Email"
|
|
description="SMTP configuration for notifications."
|
|
href="/docs/self-hosting/configuration/email"
|
|
/>
|
|
<Card
|
|
title="Storage"
|
|
description="S3-compatible file storage setup."
|
|
href="/docs/self-hosting/configuration/storage"
|
|
/>
|
|
<Card
|
|
title="Signing Certificate"
|
|
description="Digital signature certificate for documents."
|
|
href="/docs/self-hosting/configuration/signing-certificate"
|
|
/>
|
|
</Cards>
|
|
|
|
---
|
|
|
|
## Maintenance
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Upgrades"
|
|
description="Upgrade to new versions safely."
|
|
href="/docs/self-hosting/maintenance/upgrades"
|
|
/>
|
|
<Card
|
|
title="Backups"
|
|
description="Backup strategies for your data."
|
|
href="/docs/self-hosting/maintenance/backups"
|
|
/>
|
|
<Card
|
|
title="Troubleshooting"
|
|
description="Common issues and solutions."
|
|
href="/docs/self-hosting/maintenance/troubleshooting"
|
|
/>
|
|
</Cards>
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
Get Documenso running locally in under 5 minutes:
|
|
|
|
```bash
|
|
git clone https://github.com/documenso/documenso.git
|
|
cd documenso
|
|
cp .env.example .env
|
|
docker compose -f docker/development/compose.yml up -d
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) to access your instance.
|
|
|
|
See the [Quick Start guide](/docs/self-hosting/getting-started/quick-start) for detailed instructions and next steps.
|
|
|
|
---
|
|
|
|
## Enterprise Edition
|
|
|
|
Self-hosted Documenso includes full core functionality under the AGPL-3.0 license. If you need enterprise features such as SSO, embed editor white label, or 21 CFR Part 11 compliance, you can activate them with a license key.
|
|
|
|
See [Enterprise Edition](/docs/policies/enterprise-edition) for details and [Licenses](/docs/policies/licenses) for a comparison.
|
|
|
|
---
|
|
|
|
## Looking for Something Else?
|
|
|
|
<Cards>
|
|
<Card
|
|
title="User Guide"
|
|
description="Learn how to use Documenso for document signing."
|
|
href="/docs/users"
|
|
/>
|
|
<Card
|
|
title="Developer Guide"
|
|
description="Integrate Documenso into your applications using the API."
|
|
href="/docs/developers"
|
|
/>
|
|
</Cards>
|