mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
jevb
a40b42bbed
CRITICAL (5): - Hub panic recovery now calls h.Stop() after 3 panics (ws/hub.go) - Ring buffer EventsSince returns non-nil empty slice for current seq (ws/ringbuffer.go) - PTT event listener stores unsubscribe handle to prevent leak (ptt.ts) - verifyTotp respects config.allowSelfSigned instead of hardcoding (api.ts) - ptt_listen_for_key uses spawn_blocking to avoid thread pool starvation (ptt.rs) HIGH - Server (13): - TOTP rate-limit checked after body decode; counters reset on success - TOTP enable returns 409 if already enabled (must disable first) - Global search pre-computes accessible channel IDs for FTS WHERE clause - DeleteAccount queries roles by name instead of hard-coded IDs - BackupToSafe uses absClean in VACUUM INTO - Voice camera slot uses atomic EnableCameraIfUnderLimit DB method - readPump snapshots voiceChID before unregister for TOCTOU safety - Voice join sets state after token send; rollback takes broadcast flag - Updater download uses probe pattern instead of overflow write - Webhook checks Authorization header before reading body - Storage.Save adds fsync and fixes double-close - Default WS origin denies cross-origin (was: accept all) HIGH - Client (6): - WS reconnect uses generation counter to discard stale events - AudioPipeline uses generation counter against stale worklet callbacks - Screenshare mute state preserved across reconnect (not full leave) - handleVoiceToken uses iterative loop instead of unbounded recursion - store.ts re-entrancy guard with pending update queue - Notification AudioContext cleaned up on logout Reviewed by 4 parallel agents across Server Core, Server Realtime, Client & Tauri, and Security. 55 total findings; 24 CRITICAL+HIGH fixed here, 31 MEDIUM+LOW tracked in vault backlog (T-265–T-295).
5.9 KiB
5.9 KiB
Server Configuration Reference
Complete reference for all OwnCord server configuration options.
Overview
OwnCord server reads configuration from config.yaml in the working directory. On first run, if the file does not exist, a default config.yaml is created automatically.
Configuration is loaded in three layers (later layers override earlier ones):
- Built-in defaults (compiled into the binary)
- YAML file (
config.yaml) - Environment variables (prefix:
OWNCORD_)
Config Key Reference
Server (server)
| Key | Type | Default | Description |
|---|---|---|---|
server.port |
int | 8443 |
HTTP(S) listen port |
server.name |
string | "OwnCord Server" |
Server display name (shown in /api/v1/info and admin panel) |
server.data_dir |
string | "data" |
Directory for database, certs, uploads, backups |
server.allowed_origins |
string[] | [] |
WebSocket CORS allowed origins; empty list DENIES all cross-origin (set to ["*"] to allow any origin) |
server.trusted_proxies |
string[] | [] |
CIDRs of trusted reverse proxies (for X-Forwarded-For) |
server.admin_allowed_cidrs |
string[] | private networks | CIDRs allowed to access /admin routes. Default: 127.0.0.0/8, ::1/128, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7 |
TLS (tls)
| Key | Type | Default | Description |
|---|---|---|---|
tls.mode |
string | "self_signed" |
TLS mode: self_signed, acme, manual, off |
tls.cert_file |
string | "data/cert.pem" |
Path to TLS certificate (used by manual and self_signed) |
tls.key_file |
string | "data/key.pem" |
Path to TLS private key |
tls.domain |
string | "" |
Domain for ACME/Let's Encrypt (required when mode: acme) |
tls.acme_cache_dir |
string | "data/acme_certs" |
Directory for cached Let's Encrypt certificates |
Database (database)
| Key | Type | Default | Description |
|---|---|---|---|
database.path |
string | "data/chatserver.db" |
Path to SQLite database file |
Uploads (upload)
| Key | Type | Default | Description |
|---|---|---|---|
upload.max_size_mb |
int | 100 |
Maximum file upload size in megabytes |
upload.storage_dir |
string | "data/uploads" |
Directory where uploaded files are stored |
Voice / LiveKit (voice)
| Key | Type | Default | Description |
|---|---|---|---|
voice.livekit_api_key |
string | (random per run) | LiveKit API key. Set a stable value for persistent voice tokens. |
voice.livekit_api_secret |
string | (random per run) | LiveKit API secret (min 32 chars). Set a stable value for persistent tokens. |
voice.livekit_url |
string | "ws://localhost:7880" |
LiveKit server WebSocket URL |
voice.livekit_binary |
string | "" |
Path to livekit-server binary; empty = don't auto-start |
voice.node_ip |
string | "" |
Public IP for WebRTC ICE candidates; empty = auto-detect. Required for remote users behind NAT. |
voice.quality |
string | "medium" |
Voice quality preset: low, medium, high |
Warning: If
livekit_api_keyorlivekit_api_secretare left empty, random credentials are generated on each startup. This means voice tokens break on restart. Always set stable credentials in production. See LiveKit Setup for details.
GitHub / Updates (github)
| Key | Type | Default | Description |
|---|---|---|---|
github.token |
string | "" |
Optional GitHub API token for higher rate limits on update checks (5000 req/hr vs 60) |
Environment Variable Overrides
Every config key can be overridden via environment variables using the prefix OWNCORD_.
Format: OWNCORD_<SECTION>_<KEY>
| Environment Variable | Config Path |
|---|---|
OWNCORD_SERVER_PORT |
server.port |
OWNCORD_SERVER_NAME |
server.name |
OWNCORD_SERVER_DATA_DIR |
server.data_dir |
OWNCORD_DATABASE_PATH |
database.path |
OWNCORD_TLS_MODE |
tls.mode |
OWNCORD_TLS_CERT_FILE |
tls.cert_file |
OWNCORD_TLS_DOMAIN |
tls.domain |
OWNCORD_UPLOAD_MAX_SIZE_MB |
upload.max_size_mb |
OWNCORD_UPLOAD_STORAGE_DIR |
upload.storage_dir |
OWNCORD_VOICE_LIVEKIT_API_KEY |
voice.livekit_api_key |
OWNCORD_VOICE_LIVEKIT_API_SECRET |
voice.livekit_api_secret |
OWNCORD_VOICE_LIVEKIT_URL |
voice.livekit_url |
OWNCORD_VOICE_NODE_IP |
voice.node_ip |
OWNCORD_VOICE_QUALITY |
voice.quality |
OWNCORD_GITHUB_TOKEN |
github.token |
Example config.yaml
# OwnCord Server Configuration
server:
port: 8443
name: "OwnCord Server"
data_dir: "data"
allowed_origins: [] # empty = deny all cross-origin; set to ["*"] to allow any
trusted_proxies: [] # e.g. ["10.0.0.0/8"] if behind a reverse proxy
admin_allowed_cidrs:
- "127.0.0.0/8"
- "::1/128"
- "10.0.0.0/8"
- "172.16.0.0/12"
- "192.168.0.0/16"
database:
path: "data/chatserver.db"
tls:
mode: "self_signed" # self_signed | acme | manual | off
cert_file: "data/cert.pem"
key_file: "data/key.pem"
domain: "" # required for acme mode
acme_cache_dir: "data/acme_certs"
upload:
max_size_mb: 100
storage_dir: "data/uploads"
voice:
livekit_api_key: "your-api-key"
livekit_api_secret: "your-secret-at-least-32-characters-long"
livekit_url: "ws://localhost:7880"
livekit_binary: "" # path to livekit-server binary
node_ip: "" # public IP for remote users behind NAT
quality: "medium" # low | medium | high
github:
token: "" # optional GitHub PAT for update check rate limits
See Also
- Deployment Guide -- production deployment guide
- LiveKit Setup -- voice/video setup
- Quick Start -- getting started