تخطَّ إلى المحتوى
CoveCove

Quick start

هذا المحتوى غير متوفر بلغتك بعد.

This gets you a working server and web client on one machine. You need Docker with Compose.

1. Create a folder and fetch the files

Section titled “1. Create a folder and fetch the files”
Terminal window
mkdir cove && cd cove
curl -O https://raw.githubusercontent.com/mjn81/cove-chat/main/examples/docker-compose/production/docker-compose.yml
curl -o config.toml https://raw.githubusercontent.com/mjn81/cove-chat/main/backend/config.toml.example
mkdir data

2. Point the web client at your server

Section titled “2. Point the web client at your server”

Open docker-compose.yml and set VITE_API_URL on the frontend service to the address people will use to reach the API, for example https://chat.example.com:4000. For a local trial the default http://localhost:4000 works.

Then set frontend_origin in config.toml to the address of the web client (for example http://localhost:3000). The server only accepts browser requests from that origin.

3. Start it

Section titled “3. Start it”
Terminal window
docker compose up -d
Port Used for
3000/tcp Web client
4000/tcp API and WebSocket
3478/udp Embedded STUN/TURN for calls
50000-50100/udp WebRTC media
9090/udp Raw UDP voice (only for voice.mode = "raw_udp")

4. Create the owner account

Section titled “4. Create the owner account”

Open http://localhost:3000 and register. The first account on a fresh server becomes the owner. Owners and admins get a Server admin tab in Settings.

Next steps

Section titled “Next steps”