hcikn/colibri repository overview

⁠Colibri - Server

⁠Setup

⁠Docker⁠ (recommended)

Use the following docker-compose.yml and run docker-compose up -d:

services:
  colibri:
    build: .
    restart: unless-stopped
    container_name: colibri
    tty: true
    volumes:
        - ./data/:/srv/colibri/data
    ports:
      - 9011:9011 # web interface / web sockets
      - 9012:9012 # tcp (unity)
      - "9013:9013/udp" # voice

⁠Node

Requirements: NodeJS 20+

Clone this repository, build with npm run build, then start with npm start.

⁠Configuration

The web interface, socketIO server, and voice server are customizable. The main aspect here lies in changing default ports or hostnames to facilitate running the application behind a proxy. Additionally, voice server settings such as the sampling rate and recording options can be adjusted.

For reference, see the .env.example file:

TCP_HOST='0.0.0.0'
TCP_PORT=9012

VOICE_HOST='0.0.0.0'
VOICE_PORT=9013
VOICE_SAMPLING_RATE=48000
VOICE_RECORDING=false

WEBSERVER_HOST='0.0.0.0'
WEBSERVER_PORT=9011
WEBSERVER_ROOT='../ui/'
BASE_URL=''

DATA_ROOT='../../data'

⁠Features

A web interface is available on http://<your-server-ip>:9011 to view the log output of connected clients.

⁠Development

• npm run watch: Run development server with auto-compile and reload on file changes
• npm run build: Compilation
• npm start: Start server -- make sure to compile first.