Cyrus Panel

A modern, open-source hosting and store panel for managing clients, servers, nodes, containers, resources, and your entire infrastructure.

Setting up the environment

Cyrus Panel requires Node.js v21 or newer.

Node.js v24.19.0 is the currently tested version, but it is not required.

Install with NVM

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
source ~/.bashrc
nvm install 24.19.0
nvm use 24.19.0

Or install using your Linux distribution

Debian / Ubuntu

sudo apt update
sudo apt install -y nodejs npm

Fedora / RHEL / Rocky / AlmaLinux

sudo dnf install -y nodejs npm

Arch Linux

sudo pacman -S nodejs npm

Make sure your installed Node.js version is v21 or newer.

Installation

Clone the repository and install the dependencies:

git clone https://github.com/HasenDev/cyrus-panel.git
cd cyrus-panel
npm install

Initialize the frontend

Cyrus Panel uses the Cyrus Frontend as a Git submodule. After cloning the repository, initialize and download the frontend submodule:

git submodule update --init --recursive

Important: The frontend is required to build Cyrus Panel. Make sure you run the command above before running npm run build.

Build Cyrus Panel

Build the frontend and prepare it for the API server:

npm run build

This builds the Next.js frontend from the frontend submodule and copies the generated static files from:

./frontend/out

to:

./src/frontend

Updating the frontend

If you already have Cyrus Panel installed and want to update the frontend submodule to the version referenced by the panel repository, run:

git pull
git submodule update --init --recursive

Then rebuild Cyrus Panel:

npm run build

Note: git submodule update --init --recursive checks out the exact frontend commit referenced by the Cyrus Panel repository. This ensures that the frontend version matches the panel version.

Once the build is complete, start Cyrus Panel:

npm run start

For development:

npm run dev

Links

• Website: https://cyrus.admibot.xyz
• Documentation: https://cyrus.admibot.xyz/docs
• Bug Reports: https://cyrus.admibot.xyz/bugs
• Support Server: https://discord.gg/3yuMkSnrFd

License

See the LICENSE file.