From 90f8170efbad0cec981a24e7831840aac65d8d70 Mon Sep 17 00:00:00 2001 From: Dries Augustyns Date: Mon, 8 Dec 2025 12:39:09 +0100 Subject: [PATCH] docs: dynamic link to Docker Compose for self-hosting --- README.md | 2 +- .../wiki/content/docs/self-hosting/docker.mdx | 30 ++++++++++++++----- .../docs/self-hosting/introduction.mdx | 29 +++++++++--------- 3 files changed, 38 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f12f76a..286118a 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ The easiest way to self-host Plunk is by using the `plunk` Docker image. You can pull the latest image from [Github](https://github.com/useplunk/plunk/pkgs/container/plunk). A complete guide on how to deploy Plunk can be found in -the [documentation](https://docs.useplunk.com/self-hosting/introduction). +the [documentation](https://next-wiki.useplunk.com/self-hosting/introduction). ## Contributing diff --git a/apps/wiki/content/docs/self-hosting/docker.mdx b/apps/wiki/content/docs/self-hosting/docker.mdx index f363d8b..2462ff2 100644 --- a/apps/wiki/content/docs/self-hosting/docker.mdx +++ b/apps/wiki/content/docs/self-hosting/docker.mdx @@ -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 diff --git a/apps/wiki/content/docs/self-hosting/introduction.mdx b/apps/wiki/content/docs/self-hosting/introduction.mdx index 44c32a1..d5c78b9 100644 --- a/apps/wiki/content/docs/self-hosting/introduction.mdx +++ b/apps/wiki/content/docs/self-hosting/introduction.mdx @@ -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