Installation Guide

Quick Start

# Download Obelisk
curl -L --tlsv1.2 -sSf https://raw.githubusercontent.com/obeli-sk/obelisk/main/download.sh | bash
# Place the binary on PATH, e.g. `export PATH=$(pwd):$PATH` or `sudo mv ./obelisk /usr/bin/`

# Generate a sample configuration
obelisk server generate-config

# Start the server
obelisk server run

# After "Server is ready" is printed navigate to http://localhost:8080

Docker

Pull and run the official Docker image:

# Pull the image
docker pull getobelisk/obelisk:latest

# Run with default configuration
docker run --net=host getobelisk/obelisk:latest

# Run with custom config
docker run -v $(pwd)/obelisk.toml:/etc/obelisk/obelisk.toml --net=host getobelisk/obelisk:latest

Manual Installation

  1. Download the binary

    Choose your platform:

    Linux (x86_64)

    obelisk-x86_64-unknown-linux-gnu.tar.gz

    Linux (ARM64)

    obelisk-aarch64-unknown-linux-gnu.tar.gz

    Linux Musl (x86_64)

    obelisk-x86_64-unknown-linux-musl.tar.gz

    Linux Musl (ARM64)

    obelisk-aarch64-unknown-linux-musl.tar.gz

    macOS (x86_64)

    obelisk-x86_64-apple-darwin.tar.gz

    macOS (ARM64)

    obelisk-aarch64-apple-darwin.tar.gz

  2. Extract and install

    # Extract the archive
tar xf obelisk-*.tar.gz

# Move to a directory in your PATH (Linux/macOS)
sudo mv obelisk /usr/local/bin/

  3. Verify installation

    obelisk --version

Build from Source

Requirements: 

cargo install obelisk

Nix Flake

Built artifacts are stored in Garnix Cache.
Make sure experimental features flakes and nix-command are enabled. 

# Run the server
nix run github:obeli-sk/obelisk/latest
# Install into user's profile
nix profile install github:obeli-sk/obelisk/latest