mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
J3vb
c3a8aa477c
Critical/High Rust (Tauri client): - BUG-140: replace .run() with .build() + RunEvent::Exit handler; native error dialog on startup failure - BUG-141: eliminate PTT thread TOCTOU race with Mutex critical section; add AtomicBool shutdown and catch_unwind - BUG-144: fix TOFU cert store corruption — read-before-write rollback restores previous fingerprint on save failure (all 3 write sites) - BUG-145: add VK code range guard (1..=254) in is_key_down; fix cast to (state as i16) < 0 - BUG-147: replace bare spawns with JoinSet; abort_all + drain on exit; unconditional closed event - BUG-150: add CRLF guard in handle_connection before header rewriting - BUG-151: wrap header read loop in tokio::time::timeout(10s) - BUG-158: extract CERTS_STORE/SETTINGS_STORE to constants.rs (eliminate 3 duplicates) - HIGH-2: PTT thread self-cleanup uses unwrap_or_else defensive pattern - HIGH-4: ws_send distinguishes Full vs Closed errors; warn log on backpressure Critical/High TypeScript (Tauri client): - BUG-142: join-generation counter prevents stale connectAndSetup completions - BUG-143: replace 8 mutable LiveKit session fields with discriminated union SessionState - BUG-146: 60s token refresh deadline; cleared on reply or voice leave - BUG-148: ResizeObserver hoisted to outer scope; disconnect() in destroy() before ac.abort() - BUG-152: dismissSignal.aborted guard already present (no change needed) - BUG-153: measureRendered split into two-pass read-then-write; eliminates per-message reflow - BUG-154: WS dedup cache batch-evicts to 80% on overflow (amortised O(1)) - BUG-157: pendingUpdates replaced with coalesced function-composition slot (O(1) queue depth) Go server: - BUG-149: safe two-value type assertion in getOutboundIP with localhost fallback - BUG-155: broadcast buffer 256→1024; broadcastDrops atomic counter exposed in /api/v1/metrics - BUG-156: LiveKitHealthCheck and implementations accept ctx context.Context; all call sites pass r.Context() (12 files) - BUG-159: MaxMessageBytes constant in config/constants.go; replaces 1<<20 literals in serve.go and updater.go - HIGH-1: cert store rollback reads old value before write; restores previous cert on save failure All validation passes: go build, go vet, cargo check, npm typecheck
92 lines
2.4 KiB
Markdown
92 lines
2.4 KiB
Markdown
# Quick Start Guide
|
|
|
|
Get OwnCord running with the fewest possible steps.
|
|
|
|
## Choose Your Setup Path
|
|
|
|
| Goal | Best path |
|
|
| ---- | --------- |
|
|
| Fastest local/LAN setup | Prebuilt binaries |
|
|
| Linux server with easiest operations | Docker |
|
|
| Custom dev build | Build from source |
|
|
|
|
## Platform Support (Current Releases)
|
|
|
|
| Component | Windows x64 | Linux x64 | Linux ARM64 |
|
|
| --------- | ----------- | --------- | ----------- |
|
|
| Server binary | Yes | Yes | Not published yet |
|
|
| Desktop client | Yes | Yes | Yes |
|
|
|
|
## Prerequisites
|
|
|
|
- Go 1.25+ (only if building server from source)
|
|
- Node.js 20+ and Rust (only if building client from source)
|
|
- Docker + Compose v2 (Docker path only)
|
|
- LiveKit (optional, required for voice/video)
|
|
|
|
## Option A: Prebuilt binaries (recommended)
|
|
|
|
1. Download from [GitHub Releases](https://github.com/J3vb/OwnCord/releases).
|
|
2. Start the server:
|
|
- Windows: `chatserver.exe`
|
|
- Linux: `./chatserver`
|
|
3. Open `https://localhost:8443/admin`.
|
|
4. Create the Owner account.
|
|
5. Create invite codes and share them.
|
|
|
|
## Option B: Docker (Linux server)
|
|
|
|
```bash
|
|
cd Server
|
|
cp .env.example .env
|
|
cp livekit.yaml.example livekit.yaml
|
|
# Edit both files before start
|
|
docker compose up -d
|
|
```
|
|
|
|
Then open `https://localhost:8443/admin` and create the Owner account.
|
|
|
|
Full Docker details: [Deployment Guide](deployment.md#docker-linux).
|
|
|
|
## Option C: Build from source
|
|
|
|
```bash
|
|
# Server (Windows)
|
|
cd Server
|
|
go build -o chatserver.exe -ldflags "-s -w -X main.version=1.0.0" .
|
|
|
|
# Server (Linux)
|
|
cd Server
|
|
CGO_ENABLED=0 go build -o chatserver -ldflags "-s -w -X main.version=1.0.0" .
|
|
|
|
# Client
|
|
cd Client/tauri-client
|
|
npm install
|
|
npm run tauri build
|
|
```
|
|
|
|
## What Happens on First Server Start
|
|
|
|
- `config.yaml` is created with defaults.
|
|
- `data/` is created for DB, certs, uploads, and backups.
|
|
- A self-signed TLS certificate is generated.
|
|
- SQLite schema and migrations are applied.
|
|
|
|
## Client Connection Notes
|
|
|
|
- The default server address is `https://<server-ip>:8443`.
|
|
- The desktop client uses TOFU certificate pinning:
|
|
- First connection prompts for trust.
|
|
- Future connections require the same cert fingerprint.
|
|
|
|
## If Remote Users Cannot Connect
|
|
|
|
1. Use [Tailscale](tailscale.md) for the simplest remote setup.
|
|
2. Or configure [Port Forwarding](port-forwarding.md).
|
|
|
|
## Next Steps
|
|
|
|
- [Server Configuration](server-configuration.md)
|
|
- [Deployment Guide](deployment.md)
|
|
- [LiveKit Setup](livekit-setup.md)
|