diff --git a/README.md b/README.md index 7dd31592..a71a32db 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,25 @@ dependencies, works fully on LAN. Admin Panel

+## Quick Start + +1. Download `chatserver.exe` and the OwnCord installer from + [GitHub Releases](https://github.com/J3vb/OwnCord/releases) +2. Run `chatserver.exe` — generates `config.yaml` and a `data/` + directory (database, TLS certs, uploads, backups) on first run +3. Open `https://localhost:8443/admin` to create the Owner account +4. Generate an invite code in the admin panel and share it +5. Friends install the client, enter your server address + (`ip:8443`), and register with the invite code +> Note: You should locate your active IPv4 via `ipconfig` for Win or `ip a` for Linux, since OwnCord server runs on `0.0.0.0`. +> +> Example: 192.168.1.2:8443 + +The client uses TOFU (Trust On First Use) for self-signed +certificates — it prompts to trust the server on first +connection, then pins it for future sessions. + + ## Features ### Chat @@ -119,21 +138,6 @@ dependencies, works fully on LAN. - Quick-switch server overlay for multi-server users - Structured logging with JSONL persistence (5-day rotation) -## Quick Start - -1. Download `chatserver.exe` and the OwnCord installer from - [GitHub Releases](https://github.com/J3vb/OwnCord/releases) -2. Run `chatserver.exe` — generates `config.yaml` and a `data/` - directory (database, TLS certs, uploads, backups) on first run -3. Open `https://localhost:8443/admin` to create the Owner account -4. Generate an invite code in the admin panel and share it -5. Friends install the client, enter your server address - (`ip:8443`), and register with the invite code - -The client uses TOFU (Trust On First Use) for self-signed -certificates — it prompts to trust the server on first -connection, then pins it for future sessions. - ### Voice & Video Setup (Optional) Voice and video require [LiveKit Server](https://github.com/livekit/livekit/releases):