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

IPv4 + Quick start update

Browse Source 
1. Clarified where and how servers IPv4 is obtained
2. Moved "Quick start" to the top (why would you place it so far?)
This commit is contained in:
Arcadia
2026-04-02 16:34:54 +03:00
committed by GitHub
parent f40e6787a9
commit a3cee4f0cc
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
@@ -19,6 +19,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
@@ -117,21 +136,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):