docs: dynamic link to Docker Compose for self-hosting

This commit is contained in:
Dries Augustyns
2025-12-08 12:39:09 +01:00
parent 1a10448af3
commit 90f8170efb
3 changed files with 38 additions and 23 deletions
+23 -7
View File
@@ -5,15 +5,32 @@ description: Deploy with Docker Compose
## Quick Start
1. Download [docker-compose.yml](https://raw.githubusercontent.com/useplunk/plunk/next/docker-compose.yml)
2. Configure environment variables
3. Run `docker compose up -d`
## Minimal .env
```bash
git clone https://github.com/useplunk/plunk.git
cd plunk
cp .env.self-host.example .env
# Edit .env (see Environment Variables)
docker compose up -d
# Required
JWT_SECRET="$(openssl rand -base64 32)"
DB_PASSWORD="your-secure-password"
# Domains (point these to your server)
API_DOMAIN="api.yourdomain.com"
DASHBOARD_DOMAIN="app.yourdomain.com"
LANDING_DOMAIN="www.yourdomain.com"
WIKI_DOMAIN="docs.yourdomain.com"
USE_HTTPS="true"
# AWS SES
AWS_SES_REGION="us-east-1"
AWS_SES_ACCESS_KEY_ID="your-key"
AWS_SES_SECRET_ACCESS_KEY="your-secret"
SES_CONFIGURATION_SET="plunk-tracking"
```
See [Environment Variables](/self-hosting/environment-variables) for all configuration options.
See [Environment Variables](/self-hosting/environment-variables) for all options.
## Services
@@ -33,7 +50,6 @@ See [Environment Variables](/self-hosting/environment-variables) for all configu
| 465 | SMTP (implicit TLS) |
| 587 | SMTP (STARTTLS) |
| 9000 | Minio API |
| 9001 | Minio Console |
## Running Individual Services
@@ -7,26 +7,25 @@ description: Deploy Plunk on your own infrastructure
- Docker and Docker Compose
- AWS SES account (for sending emails)
- Domain name (for production)
- Domain name with subdomains for each service
## Quick Start
```bash
git clone https://github.com/useplunk/plunk.git
cd plunk
cp .env.self-host.example .env
# Edit .env with your settings
docker compose up -d
```
1. Download the [docker-compose.yml](https://raw.githubusercontent.com/useplunk/plunk/next/docker-compose.yml)
2. Create environment variables with your configuration (see [Environment Variables](/self-hosting/environment-variables))
3. Run `docker compose up -d`
## Access
## Domain Setup
| Service | URL |
|---------|-----|
| Dashboard | http://app.localhost |
| API | http://api.localhost |
| Docs | http://docs.localhost |
| Minio Console | http://localhost:9001 |
Configure these subdomains pointing to your server:
| Subdomain | Service |
|-----------|---------|
| `app.yourdomain.com` | Dashboard |
| `api.yourdomain.com` | API |
| `docs.yourdomain.com` | Documentation |
| `www.yourdomain.com` | Landing page |
| `smtp.yourdomain.com` | SMTP relay (optional) |
## Next Steps