Installation

Binary

Download the appropriate version for your platform from the releases page.

macOS

brew install raystack/tap/compass

To upgrade:

brew upgrade compass

Linux

Download the .deb or .rpm from the releases page:

sudo dpkg -i compass_*.deb    # Debian/Ubuntu
sudo rpm -i compass_*.rpm     # RHEL/CentOS

Windows

scoop bucket add compass https://github.com/raystack/scoop-bucket.git

Docker

docker pull raystack/compass:latest

Shell alias for running Compass via Docker:

mkdir -p $HOME/.config/raystack
alias compass="docker run -e HOME=/tmp -v $HOME/.config/raystack:/tmp/.config/raystack --user $(id -u):$(id -g) --rm -it -p 8080:8080/tcp raystack/compass:latest"

Build from Source

git clone https://github.com/raystack/compass.git
cd compass
make

This creates the compass binary in the project root.

Verify

compass --help

Next Steps