Go to file
RomanNum3ral a769e2c2b4 Update README.md 2025-10-17 23:48:20 +00:00
stoatchat-deploy commit 2025-10-17 19:44:09 -04:00
stoatchat-main commit 2025-10-17 19:44:09 -04:00
README.md Update README.md 2025-10-17 23:48:20 +00:00

README.md

StoatChat (Revolt backend fork) — Ubuntu Server Quickstart

This stack builds the Rust services from your repo and launches all required infra in Docker.

Prereqs (Ubuntu 22.04/24.04)

sudo apt update
sudo apt install -y ca-certificates curl gnupg lsb-release
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/docker.gpg
echo "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/ubuntu $(. /etc/os-release; echo $VERSION_CODENAME) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo usermod -aG docker $USER
newgrp docker

Layout

Place the extracted source next to this folder:

/home/ubuntu/
  stoatchat-main/          # the source you uploaded
  stoatchat-deploy/        # this folder (compose + overrides)

Build the backend image

cd ~/stoatchat-deploy
docker compose build backend-build

Bring everything up

docker compose up -d

Services:

Logs

docker compose logs -f autumn january gifbox pushd crond

Health checks

  • Open MailDev to see verification emails.
  • Uploads should land in MinIO bucket revolt-uploads (the compose auto-creates it).
  • If APIs fail to bind, ensure ports 1470414706 are free.

Optional: reverse proxy + TLS

Put Caddy or Nginx in front and point domains at the internal services. Then set the URLs in Revolt.overrides.toml[hosts] to your https:// domains.

Rebuild after code changes

docker compose build backend-build && docker compose up -d --no-deps autumn january gifbox pushd crond