Skip to content
rigelchatPublic

About

The core backend and API for Rigel. A high-performance, self-hostable server designed with Discord-compatible endpoints for easy ecosystem migration.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Rigel Server

Rigel Server

A lightweight, self-hostable chat server written in Rust, compatible with Fluxer, Spacebar, and Discord clients.

Release License Rust

Introduction

Rigel is an independent, minimalist chat backend built with Rust, Axum, and MySQL. Designed to stay fast and easy to self-host, it avoids unnecessary platform bloat while remaining compatible across multiple client ecosystems through a shared core and a lightweight protocol adapter.

Prerequisites

  • MySQL (>= 8.0) or MariaDB (>= 10.5)
  • (From source only) Rust (latest stable, edition 2024)

Installation & Setup

1. Create the Database

CREATE DATABASE rigel CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

2. Configure Environment

cp .env.example .env

Edit .env with your DATABASE_URL, a strong AUTH_SECRET, and your public URLs (PUBLIC_HTTP_URL, PUBLIC_WS_URL).

Note: On a fresh instance, the first registered non-bot account automatically receives staff privileges to bootstrap initial communities.

3. Run the Server

Option A: Pre-built Binary (Recommended)

  1. Download the archive matching your OS and architecture from the Latest Releases.
  2. Extract the archive next to your .env.
  3. Start the server:
# Linux / macOS
chmod +x rigel-server
./rigel-server

# Windows
.\rigel-server.exe

Option B: Building from Source

git clone https://github.com/rigelchat/server.git
cd server
cp .env.example .env
# Edit .env with your DATABASE_URL, AUTH_SECRET, and public URLs
cargo run --release

Endpoints

By default, Rigel listens on 127.0.0.1:3000:

Service Endpoint
REST API http://localhost:3000/api (/api/v9)
WebSocket Gateway ws://localhost:3000/gateway
Discovery /api/.well-known/fluxer · /.well-known/spacebar/client
Static Assets http://localhost:3000/static

Built with 💙 by the Rigel Team.

About

The core backend and API for Rigel. A high-performance, self-hostable server designed with Discord-compatible endpoints for easy ecosystem migration.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages