From d677716f935bf192111f8f81fd49e504c9295a62 Mon Sep 17 00:00:00 2001 From: Paul Makles Date: Tue, 11 Jun 2024 14:16:44 +0100 Subject: [PATCH] docs: update development guide --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 4be1b150..65069e67 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,29 @@ cp .env.example .env # (optionally) copy the default configuration file cp crates/core/config/Revolt.toml Revolt.toml # configure as necessary... +``` +You may want to copy the following configuration: + +```toml +# Revolt.toml +[database] +mongodb = "mongodb://localhost" +redis = "redis://localhost" + +[hosts] +app = "http://local.revolt.chat" +api = "http://local.revolt.chat:8000" +events = "ws://local.revolt.chat:9000" +autumn = "http://local.revolt.chat:3000" +january = "http://local.revolt.chat:7000" +voso_legacy = "" +voso_legacy_ws = "" +``` + +Then continue: + +```bash # start other necessary services docker compose up -d