spasmnetwork/spasm-forum-server repository overview

⁠Spasm forum docker/podman deployment

Launch Spasm⁠ under three minutes.

The entire stack runs in isolated containers without exposing ports, routing traffic through a proxy container. Frontend and db stay on an internal network, backend uses external for federation. It's secure, self-contained, and easy to deploy.

This repo is for deploying Spasm on existing servers. For new server setups, use spasm-ansible⁠ repo to automate everything from hardening to deployment with just one script.

⁠Prerequisites

Docker or Podman (with docker-compose or podman‑compose). Podman is recommended for better isolation (rootless, daemonless). If you gonna use podman, then simply change docker to podman in all commands, e.g. podman compose up -d.

Note: the run script automatically detects whether Docker or Podman is installed and uses it.

⁠Installation

# get the deploy repo
git clone https://github.com/spasm-network/spasm-docker spasm-docker/
cd spasm-docker/

# set ADMINS and POSTGRES_PASSWORD in .env
cp .env.example .env
nano .env

# start the app
docker compose up -d

The app listens on port 33333 by default (you can change HOST_PORT in .env).

You can verify the app is running with curl http://127.0.0.1:33333/api/health

⁠Make your forum public

Prereqs: DNS points⁠ to this server IP; firewall allows ports 80 and 443.

⁠Automatic setup

# configure nginx, obtain SSL cert, add auto-renewal
sudo bash run setup your-domain.com 33333

⁠Manual setup

• Route port 80 to 33333 to make forum accessible by IP.
• Get SSL cert and route 443 to 33333 to make forum accessible by domain.

See detailed nginx setup instructions⁠

⁠Customize forum

Open web admin panel at http://<your-ip-address>/admin or https://your-domain.com/admin, connect your extension with admin keys and customize your forum.

⁠Update forum

# automatic: pull code, fetch images, restart containers
bash run update

# or manual:
git pull --ff-only
docker compose pull && docker compose up -d

⁠Database management

# backup database (saves .gz into backups/ folder)
bash run db-backup

# restore database (supports .sql and .gz, restarts containers)
bash run db-restore backups/spasm-docker_spasm_database_20260101.sql.gz