Skip to main content

Installation

There are several approaches to install Guardian.

  1. Using a pre-compiled binary
  2. Installing with package manager
  3. Installing from source
  4. Using the Docker image

Binary (Cross-platform)​

Download the appropriate version for your platform from releases page. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

macOS​

guardian is available via a Homebrew Tap, and as downloadable binary from the releases page:

brew install raystack/tap/guardian

To upgrade to the latest version:

brew upgrade guardian

Check for installed guardian version

guardian version

Linux​

guardian is available as downloadable binaries from the releases page. Download the .deb or .rpm from the releases page and install with sudo dpkg -i and sudo rpm -i respectively.

Windows​

guardian is available via scoop, and as a downloadable binary from the releases page:

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

To upgrade to the latest version:

scoop update guardian

Building from source​

Prerequisites​

Guardian requires the following dependencies:

  • Golang (version 1.18 or above)
  • Git

Build​

Run either of the following commands to clone and compile Guardian from source

$ git clone git@github.com:raystack/guardian.git  (Using SSH Protocol) Or
$ git clone https://github.com/raystack/guardian.git (Using HTTPS Protocol)

Install all the golang dependencies

make setup

Build guardian binary file

make build

Init server config. Customise with your local configurations.

make config

Run database migrations

./guardian server migrate -c config.yaml

Start guardian server

./guardian server start -c config.yaml

Initialise client configurations

./guardian config init

Use the Docker image​

We provide ready to use Docker container images. To pull the latest image:

docker pull raystack/guardian:latest

To pull a specific version:

docker pull raystack/guardian:v0.3.2

Verifying the installation​​

To verify if Guardian is properly installed, run guardian --help on your system. You should see help output. If you are executing it from the command line, make sure it is on your PATH or you may get an error about Guardian not being found.

$ guardian --help

What's next​