docs: add some notes on overrides; fix defaults

This commit is contained in:
Paul Makles
2025-02-10 17:21:23 +00:00
parent 439bacf067
commit e957af4ca3
4 changed files with 41 additions and 21 deletions

1
.gitignore vendored
View File

@@ -1,5 +1,6 @@
Rocket.toml Rocket.toml
Revolt.*.toml Revolt.*.toml
compose.override.yml
target target
.data .data

View File

@@ -61,7 +61,7 @@ As a heads-up, the development environment uses the following ports:
| MinIO | 14009 | | MinIO | 14009 |
| Maildev | 14025<br>14080 | | Maildev | 14025<br>14080 |
| Revolt Web App | 14701 | | Revolt Web App | 14701 |
| RabbitMQ | 5672<br>15672 | | RabbitMQ | 5672<br>15672 |
| `crates/delta` | 14702 | | `crates/delta` | 14702 |
| `crates/bonfire` | 14703 | | `crates/bonfire` | 14703 |
| `crates/services/autumn` | 14704 | | `crates/services/autumn` | 14704 |
@@ -91,6 +91,38 @@ If you'd like to change anything, create a `Revolt.overrides.toml` file and spec
> proxy = "https://abc@your.sentry/1" > proxy = "https://abc@your.sentry/1"
> ``` > ```
> [!TIP]
> If you have port conflicts on common services, you can try the following:
>
> ```yaml
> # compose.override.yml
> services:
> redis:
> ports: !override
> - "14079:6379"
>
> database:
> ports: !override
> - "14017:27017"
>
> rabbit:
> ports: !override
> - "14072:5672"
> - "14672:15672"
> ```
>
> And corresponding Revolt configuration:
>
> ```toml
> # Revolt.overrides.toml
> [database]
> mongodb = "mongodb://127.0.0.1:14017"
> redis = "redis://127.0.0.1:14079/"
>
> [rabbit]
> port = 14072
> ```
Then continue: Then continue:
```bash ```bash

View File

@@ -4,10 +4,13 @@
[database] [database]
# MongoDB connection URL # MongoDB connection URL
# Defaults to the container name specified in self-hosted # Defaults to the container name specified in self-hosted
mongodb = "mongodb://127.0.0.1:14017" mongodb = "mongodb://127.0.0.1:27017"
# Redis connection URL # Redis connection URL
# Defaults to the container name specified in self-hosted # Defaults to the container name specified in self-hosted
redis = "redis://127.0.0.1:14079/" redis = "redis://127.0.0.1:6379/"
[rabbit]
host = "127.0.0.1"
[hosts] [hosts]
# Web locations of various services # Web locations of various services

View File

@@ -1,26 +1,10 @@
let { pkgs ? import <nixpkgs> {} }:
# Pinned nixpkgs, deterministic. Last updated: 28-07-2024.
pkgs = import (fetchTarball("https://github.com/NixOS/nixpkgs/archive/9b34ca580417e1ebc56c4df57d8b387dad686665.tar.gz")) {};
# Rolling updates, not deterministic.
# pkgs = import (fetchTarball("channel:nixpkgs-unstable")) {};
in pkgs.mkShell {
name = "revoltEnv";
# LD_LIBRARY_PATH = pkgs.lib.makeLibraryPath [
# pkgs.gcc-unwrapped
# pkgs.zlib
# pkgs.glib
# pkgs.libGL
# ];
pkgs.mkShell rec {
buildInputs = [ buildInputs = [
# Tools # Tools
pkgs.git pkgs.git
# Database
# pkgs.mongodb
# Cargo # Cargo
pkgs.cargo pkgs.cargo
pkgs.cargo-nextest pkgs.cargo-nextest