Skip to content
Hex CitadelHex Citadel
Download

Get Citadel

Both the server and client are open source and available on GitHub. Deploy on your own infrastructure in minutes.

Server Core

The open-source Citadel server. Handles file storage, user management, sync coordination, and encryption key management.

FastifyPostgreSQLS3-compatibleDocker

Requirements

  • Node.js 22+ LTS
  • PostgreSQL 16+
  • S3-compatible storage
  • Docker (recommended)
View on GitHub

Client Core

The sync library powering all Citadel clients. Handles file watching, chunking, encryption, and sync orchestration with Rust acceleration.

TypeScriptRustWASMN-API

Requirements

  • Node.js 22+ LTS
  • Rust 1.87+ (optional, for acceleration)
  • pnpm 10+
View on GitHub
Quick Start

Up and running in 3 steps

Get a local Citadel server running for development.

01

Clone the server

git clone https://github.com/hexpro-dev/citadel-server-core
02

Start with Docker

docker compose -f docker/compose.yml up
03

Run the server

pnpm install && pnpm dev

For detailed setup instructions, see the documentation on GitHub.