mirror of https://github.com/J3vb/OwnCord.git synced 2026-09-03 03:50:00 +03:00

Files

T

J3vb 344d39892f docs: update contributing and quick-start for Linux/ARM64/Docker

contributing.md:
- Prerequisites now show Windows/Linux/ARM64 support matrix
- Client commands split into Build, Tests, Typecheck/Lint/Format sections
- Add 7 missing commands: lint:ox, format, format:check, knip,
  test:mutate, test:mutate:dry, test:browser

quick-start.md:
- Prerequisites table covers Windows + Linux x64 + ARM64
- Step 1 split into 3 options: pre-built binaries, Docker, build from source
- Release table lists all platform artifacts (exe, AppImage, deb)
- Docker quick-start references deployment.md Docker section

2026-04-03 14:37:46 +02:00

3.3 KiB

Raw Blame History

Quick Start Guide

Get OwnCord up and running in minutes.

Prerequisites

	Windows x64	Linux x64	Linux ARM64
Server	✅	✅	✅
Client	✅	✅	✅

Go 1.25+ (only if building the server from source)
Node.js 20+ + Rust / Cargo (only if building the client from source)
Docker + Compose v2 (alternative to building the server — Linux only)
LiveKit Server (optional, for voice/video) -- see LiveKit Setup

Step 1: Download

Option A — Pre-built binaries (recommended)

Download from GitHub Releases:

Platform	Server	Client
Windows x64	`chatserver.exe`	`OwnCord_x.x.x_x64-setup.exe`
Linux x64	`chatserver-linux-amd64.tar.gz`	`OwnCord_x.x.x_x86_64.AppImage` or `_amd64.deb`
Linux ARM64	(included in server tar)	`OwnCord_x.x.x_aarch64.AppImage` or `_arm64.deb`

Option B — Docker (Linux server only)

cd Server
cp .env.example .env          # set LIVEKIT_API_KEY + LIVEKIT_API_SECRET
cp livekit.yaml.example livekit.yaml  # set node_ip + matching keys
docker compose up -d

See Deployment Guide — Docker for full details.

Option C — Build from source

# 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

Step 2: Run the Server

Windows/Linux binary: Run chatserver.exe (Windows) or ./chatserver (Linux). On first run:

config.yaml is created in the working directory with default settings
data/ directory is created for the database, TLS certs, uploads, and backups
A self-signed TLS certificate is generated automatically
SQLite database is created and all migrations are applied
All user statuses are reset to offline (clean slate)

The server starts on https://0.0.0.0:8443.

See Server Configuration for the full config key reference and environment variable overrides.

Step 3: Admin Setup

Open https://localhost:8443/admin in a browser. The first-run setup page will prompt you to create the Owner account (username + password). This user gets the Owner role with full server control.

Step 4: Create Invites

In the admin panel, go to invite management and generate invite codes for your friends.

Step 5: Connect Clients

Friends install OwnCord, enter your server address (IP or domain + port 8443), and redeem their invite code to register.

The client uses TOFU (Trust On First Use) for self-signed certificates -- it will prompt to trust the server's certificate on first connection, then pin it for future sessions.

Networking

If friends are outside your local network, see the Port Forwarding Guide or use Tailscale for zero-config networking.

Next Steps

Server Configuration -- customize ports, TLS, uploads, voice
Deployment Guide -- production hardening, backups, monitoring, Windows service setup
LiveKit Setup -- enable voice and video chat

3.3 KiB Raw Blame History