J3vb/OwnCord
1
0
Fork 0
mirror of https://github.com/J3vb/OwnCord.git synced 2026-09-03 03:50:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: sync README from dev — move Quick Start up, add IPv4 note

Browse Source
This commit is contained in:
J3vb
2026-04-02 15:50:50 +02:00
parent 68d3aefad5
commit f7f5059a3a
1 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -15
View File
@@ -21,6 +21,25 @@ dependencies, works fully on LAN.
<img src=".github/images/Admin_Panel.png" alt="Admin Panel" width="340">
</p>
## 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):