Skip to content
Try the demo

Installation

This page sets up Staaash with Docker. It takes a few minutes.

  • A Linux computer or server (Intel/AMD or ARM), or a Windows computer with Docker Desktop. To run it on Windows without Docker, see Windows Server.
  • Docker with the Compose plugin. Run docker compose version. If you see a version number, you are ready.

Open the releases page, pick the newest release, and download docker-compose.yml and example.env from Assets. Put both in a new, empty folder.

  1. Rename example.env to .env.
  2. Open .env and set DB_PASSWORD to a long password. Use letters and numbers only. A symbol or a space breaks the database connection. openssl rand -hex 24 makes a good one.

Leave the rest as it is. Every setting is explained in Configuration.

docker compose up -d
docker compose ps

On a server the internet can reach, such as a VPS, set STAAASH_PORT=127.0.0.1:2113 before the first start and keep it. Open the setup page through an SSH tunnel: run ssh -L 2113:localhost:2113 you@your-server on your own computer, then open http://localhost:2113 there. Put a reverse proxy in front for everyday use.

The first start downloads the images, which can take a few minutes. docker compose ps should list staaash_server, staaash_worker and staaash_postgres, all running.

Open http://localhost:2113 in a browser. From another computer, use the server’s address, for example http://192.168.1.20:2113. If you changed STAAASH_PORT, use that port.

The first account becomes the owner. Pick a strong password and keep it somewhere safe.

Your files are now in the library folder and your database is in the postgres folder, next to docker-compose.yml.