matt/mailship
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

More deployment section updates
All checks were successful
CI / checks (pull_request) Successful in 57s
Details

Browse source
This commit is contained in:
matt 2026-10-01 20:32:57 +00:00
parent e6b48796ff
commit 212edabc5d
1 changed files with 30 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -24,6 +24,36 @@ Flotilla ──HTTP──▶ Mailship (PUT /subscription/email)
cron fires ──▶ render digest ──▶ SMTP ──▶ email
```
## Deployment
The recommended deployment method for mailship is via Docker. Currently the image is not published anywhere. You can build it locally from the repo root with:
```sh
docker build -t mailship .
```
The image listens on **port 4738**, expects a writable **`/data`** volume for the SQLite
database, and runs as a non-root user (`app`) for security hardening.
### Docker Compose (Recommended)
To deploy using Docker Compose copy the environment template, configure your variables, and start:
```sh
cp .env.template .env
# Edit .env with your production values (see Configuration section in README)
docker compose up -d --build
```
The compose file (`docker-compose.yml`) configures:
- **Automatic restarts** via `restart: unless-stopped`
- **Named volume** `mailship-data` mounted at `/data` for database persistence
- **Port 4738** published to the host
- **Environment variables** passed from your `.env` file with `.env` substitution
- **Required vars** (`MAILSHIP_SECRET`, `MAILSHIP_URL`, `BASE_URL`, `SMTP_*`) — the
compose file uses `${VAR:?required}` to fail early if any are missing
## Configuration
| Variable | Required | Description |
@ -147,43 +177,3 @@ result in your browser:
pnpm run preview:digest
open digest-preview.html
```
## Deployment
The recommended deployment method for mailship is using Docker. You can build the docker image from the repo root with:
```sh
docker build -t mailship .
```
The image listens on **port 4738**, expects a writable **`/data`** volume for the SQLite
database, and runs as a non-root user (`app`) for security hardening.
### Docker Compose (Recommended)
Copy the environment template, fill in your secrets, and start:
```sh
cp .env.template .env
# Edit .env with your production values (see Configuration section in README)
docker compose up -d
```
The compose file (`docker-compose.yml`) configures:
- **Automatic restarts** via `restart: unless-stopped`
- **Named volume** `mailship-data` mounted at `/data` for database persistence
- **Port 4738** published to the host
- **Environment variables** passed from your `.env` file with `.env` substitution
- **Required vars** (`MAILSHIP_SECRET`, `MAILSHIP_URL`, `BASE_URL`, `SMTP_*`) — the
compose file uses `${VAR:?required}` to fail early if any are missing
To pull the latest image and recreate the container after a rebuild:
```sh
docker compose build --pull
# or if using a pre-built image:
docker compose pull
docker compose up -d
```