Installation

Dependencies

Node.js v18 and higher (Nodejs v22 recommended).
Docker (or Docker Desktop on Windows / macOS)

Example Dependency Installation

The commands below are simply an example of how you might install these dependencies on Ubuntu 24.04. Please consult with your operating system's package manager to determine the correct packages to install.

# Ubuntu/Debian
curl -sSL https://get.docker.com/ | CHANNEL=stable bash

sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_16.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list

sudo apt update
sudo apt install -y nodejs git

Installation

The following commands will download the Overvoid Daemon into /etc/overvoid and use npm to install the required packages:

cd /etc
git clone --branch 0.1.0-beta7 https://github.com/OvervoidLabs/overvoid
cd overvoid
npm install

You can then add the node to the Panel and get the configure command by clicking the "Configure" button. Once you have executed this command, you are ready to start the Daemon.

Setup Complete

All you need to do now is start overvoid:

node .