One-Line Install Script

Downloads the compose files, generates a SECRET_KEY, starts all services, and sets up Watchtower for automatic daily updates.

Prerequisites: Docker Desktop must be installed and running.

For Linux/macOS users:

curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash

For Windows users (PowerShell):

irm https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.ps1 | iex

This creates a ./surfsense/ directory with docker-compose.yml and .env, then runs docker compose up -d.

To skip Watchtower (e.g. in production where you manage updates yourself):

curl -fsSL https://raw.githubusercontent.com/MODSetter/SurfSense/main/docker/scripts/install.sh | bash -s -- --no-watchtower

To customise the check interval (default 24h), use --watchtower-interval=SECONDS.

Access SurfSense

After starting, access SurfSense at:

• Frontend: http://localhost:3929
• Backend API: http://localhost:8929
• API Docs: http://localhost:8929/docs
• Electric SQL: http://localhost:5929