docs: dynamic link to Docker Compose for self-hosting
This commit is contained in:
@@ -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).
|
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
|
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
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
@@ -5,15 +5,32 @@ description: Deploy with Docker Compose
|
|||||||
|
|
||||||
## Quick Start
|
## 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
|
```bash
|
||||||
git clone https://github.com/useplunk/plunk.git
|
# Required
|
||||||
cd plunk
|
JWT_SECRET="$(openssl rand -base64 32)"
|
||||||
cp .env.self-host.example .env
|
DB_PASSWORD="your-secure-password"
|
||||||
# Edit .env (see Environment Variables)
|
|
||||||
docker compose up -d
|
# 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
|
## Services
|
||||||
|
|
||||||
@@ -33,7 +50,6 @@ See [Environment Variables](/self-hosting/environment-variables) for all configu
|
|||||||
| 465 | SMTP (implicit TLS) |
|
| 465 | SMTP (implicit TLS) |
|
||||||
| 587 | SMTP (STARTTLS) |
|
| 587 | SMTP (STARTTLS) |
|
||||||
| 9000 | Minio API |
|
| 9000 | Minio API |
|
||||||
| 9001 | Minio Console |
|
|
||||||
|
|
||||||
## Running Individual Services
|
## Running Individual Services
|
||||||
|
|
||||||
|
|||||||
@@ -7,26 +7,25 @@ description: Deploy Plunk on your own infrastructure
|
|||||||
|
|
||||||
- Docker and Docker Compose
|
- Docker and Docker Compose
|
||||||
- AWS SES account (for sending emails)
|
- AWS SES account (for sending emails)
|
||||||
- Domain name (for production)
|
- Domain name with subdomains for each service
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```bash
|
1. Download the [docker-compose.yml](https://raw.githubusercontent.com/useplunk/plunk/next/docker-compose.yml)
|
||||||
git clone https://github.com/useplunk/plunk.git
|
2. Create environment variables with your configuration (see [Environment Variables](/self-hosting/environment-variables))
|
||||||
cd plunk
|
3. Run `docker compose up -d`
|
||||||
cp .env.self-host.example .env
|
|
||||||
# Edit .env with your settings
|
|
||||||
docker compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
## Access
|
## Domain Setup
|
||||||
|
|
||||||
| Service | URL |
|
Configure these subdomains pointing to your server:
|
||||||
|---------|-----|
|
|
||||||
| Dashboard | http://app.localhost |
|
| Subdomain | Service |
|
||||||
| API | http://api.localhost |
|
|-----------|---------|
|
||||||
| Docs | http://docs.localhost |
|
| `app.yourdomain.com` | Dashboard |
|
||||||
| Minio Console | http://localhost:9001 |
|
| `api.yourdomain.com` | API |
|
||||||
|
| `docs.yourdomain.com` | Documentation |
|
||||||
|
| `www.yourdomain.com` | Landing page |
|
||||||
|
| `smtp.yourdomain.com` | SMTP relay (optional) |
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user