Skip to content

Installation

Jump to bottom
Elyld edited this page Sep 28, 2026 · 1 revision

Installation

Docker (recommended)

The included docker-compose.yml is a plug-n-play setup — the prebuilt image from GitHub Container Registry, two folders for your data, nothing else to configure:

docker compose up -d

Open http://localhost:3113. Interactive API docs: http://localhost:3113/docs.

That's genuinely the whole setup: no .env file needed, no build step, and your data lives in the ./data and ./uploads folders next to the compose file, so it survives rebuilds and restarts. Paste the same file into Dockge or Portainer and it just works there too.

The image (ghcr.io/elyld/verdant:latest, also tagged per release) builds for both linux/amd64 and linux/arm64 (handy for a Raspberry Pi).

Upgrading

Pull and recreate — your data lives in the bind-mounted folders, not the image:

docker compose pull && docker compose up -d

In Dockge: hit the update/redeploy button on the stack. On startup Verdant automatically adds any missing database columns, so old databases (even v1.x) upgrade cleanly without manual migrations.

What persists where

Host path Container path Contents
./data /data garden.db (SQLite, WAL)
./uploads /uploads Uploaded images

Back up those two folders and you have everything. (There's also a one-click backup & restore inside the app under Settings — the database-only option makes a small zip you can grab before every upgrade.)

Configuration

To change the host port, point Verdant at your Immich server, or turn on the Discord digest, copy .env.example to .env and fill in what you need, then re-run docker compose up -d.

Variable What it does
GARDEN_PORT Host port (default 3113)
IMMICH_BASE_URL Your Immich server, e.g. http://host.docker.internal:2283 when Verdant runs in Docker on the same machine as Immich
IMMICH_API_KEY Immich API key
TUNNEL_MODE true when behind a Cloudflare Tunnel — HSTS on, /docs off, proxy headers trusted
TUNNEL_TOKEN Cloudflare tunnel token (only with the cloudflared service uncommented)
FIRST_FROST_DATE Your average first fall frost (YYYY-MM-DD) — shows a countdown pill in the header

Garden coordinates (for the weather strip and frost countdown) live on the Settings page in the app, not in env vars — there's a 📍 "use my location" button if you don't know them.

Reaching Verdant outside your LAN (Cloudflare Tunnel)

Verdant is tunnel-ready: no sign-on inside the app, Cloudflare handles identity at the edge.

  1. In the Cloudflare dashboard: Zero Trust → Networks → Tunnels → create a tunnel, add a public hostname pointing at http://garden:8000, and copy the tunnel token.
  2. In docker-compose.yml: comment out the ports: block on the garden service (so the app is not on your LAN directly — only the tunnel can reach it), and uncomment the cloudflared service at the bottom.
  3. In your .env: TUNNEL_TOKEN=<your token>.
  4. docker compose up -d.
  5. Add a Cloudflare Access policy (e.g. email one-time PIN) on the hostname — that's the sign-on, handled by Cloudflare, not Verdant.

Set TUNNEL_MODE=true too. (Keep ports: if you still want LAN access — the tunnel keeps working, but LAN clients bypass Cloudflare Access.)

Clone this wiki locally