feat: deploy by docker on vps

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
index e4e9ca6..eb7dca9 100644
--- a/README.md
+++ b/README.md
@@ -53,3 +53,24 @@ pics.example.com {
 go test ./...
 ```
 
+## Deploy
+
+The VPS runs the gallery as a Docker Compose service behind Caddy at
+`https://pics.kagamino.dev`. The replacement service starts with a fresh local
+`./gallery-data` folder next to the VPS Compose file; the former systemd data is
+archived separately and is not imported.
+
+Authenticate the local and VPS Docker clients once, then deploy with:
+
+```sh
+docker login container.registry.kagamino.dev
+ssh ubuntu@feed.kagamino.dev "sudo docker login container.registry.kagamino.dev"
+mise run deploy
+```
+
+Create a new gallery in the empty deployment from the VPS:
+
+```sh
+ssh ubuntu@feed.kagamino.dev \
+  "sudo docker compose exec gallery /app/gallery create <name> '<password>' --data /app/data"
+```