Installation Guide

# Download latest release from GitHub
curl -L --tlsv1.2 -sSf https://raw.githubusercontent.com/obeli-sk/obelisk/main/download.sh | bash
# Optionally place the binary on PATH

# Generate a sample configuration
obelisk server generate-config

# Start the server
obelisk server run

# Use host's network. Ports 8080 (web) and 5005 (grpc) will be bound to 127.0.0.1
docker run --net=host getobelisk/obelisk

# Forward ports explicitly
docker run \
  -p 8080:8080 -e 'OBELISK__webui__listening_addr=0.0.0.0:8080' \
  -p 5005:5005 -e 'OBELISK__api__listening_addr=0.0.0.0:5005' \
  getobelisk/obelisk

# Share the config and cache directory from host
docker run --net=host \
  -u $(id -u):$(id -g) \
  -v $(pwd):/config \
  -e 'OBELISK__WASM__CACHE_DIRECTORY=/cache/obelisk/wasm' \
  -v ~/.cache/obelisk/wasm:/cache/obelisk/wasm \
  getobelisk/obelisk \
  server run --config /config/obelisk.toml

# Download and install binary from GitHub:
cargo binstall obelisk
# or, if cargo-binstall is not available, build the latest release from crates.io
cargo install --locked obelisk

git clone https://github.com/obeli-sk/obelisk && cd obelisk
cargo build --release

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