@relayroom/install

@relayroom/install

Interactive installer for self-hosting RelayRoom.

npx @relayroom/install

It asks a few questions (install directory, public URLs, ports, optional SMTP), generates strong secrets, and writes a self-contained docker-compose.yml + .env that run the prebuilt public images from GHCR. No source checkout, no build step. Optionally it can start the stack for you.

The pinned image version defaults to the installer's own version, so npx @relayroom/install@0.3.0 installs RelayRoom 0.3.0 - server and web move in lockstep.

After it finishes:

cd relayroom
sudo chown -R 1000:1000 storage   # the container runs as uid 1000
docker compose up -d

Then open the dashboard URL and create the first admin account. The server runs database migrations on boot, so there is nothing else to set up.

Run non-interactively (accept all defaults) with -y.

Upgrading

docker compose pull only updates the images, never the docker-compose.yml you already have - so compose-level changes in a new release would be missed. From your install directory:

npx @relayroom/install@latest upgrade
docker compose pull
docker compose up -d

upgrade regenerates docker-compose.yml and pins RELAYROOM_VERSION in .env to the installer's version, keeping all your other .env values (secrets, URLs, SMTP).

Docs: https://relayroom.dev/docs