31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# Rybbit
|
|
|
|
Rybbit is a self-hosted web and product analytics platform backed by ClickHouse
|
|
and PostgreSQL.
|
|
|
|
## Deployment layout
|
|
|
|
- **Compose:** `/srv/docker/rybbit/docker-compose.yml`
|
|
- **Static configuration/source:** `/srv/docker/rybbit/clickhouse_config`
|
|
- **Non-secret environment:** the public base URL, signup policy, service endpoints, and runtime mode are declared in
|
|
Compose; there is no project-local `.env`
|
|
- **Secrets:** `/srv/docker/secrets/rybbit/.env`
|
|
- **NVMe application state:** `/srv/appdata/rybbit/clickhouse` and `/srv/appdata/rybbit/postgres`
|
|
- **Bulk HDD data:** none
|
|
- **Other mounts:** none
|
|
|
|
Secrets are never committed to this repository. The central secret environment
|
|
is supplied to the ClickHouse, PostgreSQL, and backend services and defines
|
|
`CLICKHOUSE_DB`, `CLICKHOUSE_USER`, `CLICKHOUSE_PASSWORD`, `POSTGRES_DB`,
|
|
`POSTGRES_USER`, `POSTGRES_PASSWORD`, and `BETTER_AUTH_SECRET`.
|
|
|
|
## Dependencies and recovery
|
|
|
|
- **Networks/dependencies:** the backend depends on healthy ClickHouse and PostgreSQL services, uses the external
|
|
`npm_proxy` network at `192.168.98.20`, and shares the private `internal` network with both databases; the client
|
|
depends on the backend, uses `npm_proxy` at `192.168.98.21`, and also joins `internal`
|
|
- **Back up:** `/srv/appdata/rybbit/clickhouse`, `/srv/appdata/rybbit/postgres`, and the separately protected Rybbit
|
|
secret environment
|
|
- **Re-creatable:** the four service containers and the project-scoped `internal` network; no persistent cache is
|
|
declared
|