Skip to content

Latest commit

 

History

History
142 lines (95 loc) · 3.39 KB

installing-spicedb.mdx

File metadata and controls

142 lines (95 loc) · 3.39 KB
Raw

import { Callout } from 'nextra/components'

Installing SpiceDB

SpiceDB is built as a standalone executable file which simplifies installation.

However, one should prefer one of the recommended installation methods detailed below.

Looking to deploy SpiceDB to a staging or production environment?

Authzed Serverless is the fastest and most production-ready way to deploy SpiceDB.

Self-hosted installations should deploy the SpiceDB Operator.

There are also community-maintained examples for demo environments.

Recommended methods

Docker

Container images are available for AMD64 and ARM64 architectures on the following registries:

You can pull down the latest stable release:

docker pull authzed/spicedb

Afterwards, you can run it with docker run:

docker run \
    --name spicedb \
    -p 50051:50051 \
    authzed/spicedb \
    serve \
    --grpc-preshared-key "somerandomkeyhere"

The entrypoint of the container image is set to the SpiceDB binary to allow for easily running different commands and providing flags:

docker run \
    --name spicedb-testing \
    -p 50051:50051 \
    authzed/spicedb \
    serve-testing

Debian packages

Debian-based Linux users can install SpiceDB packages by adding an additional apt source.

First ensure the following dependencies are installed:

sudo apt update && sudo apt install -y curl ca-certificates gpg

Next, we can add, trust, and update the official SpiceDB apt source:

curl https://pkg.authzed.com/apt/gpg.key | sudo apt-key add -
sudo sh -c 'echo "deb https://pkg.authzed.com/apt/ * *" > /etc/apt/sources.list.d/authzed.list'
sudo apt update

Install as usual:

sudo apt install -y spicedb

RPM packages

RPM-based Linux users can install SpiceDB packages by adding a new yum repository:

sudo cat << EOF >> /etc/yum.repos.d/Authzed-Fury.repo
[authzed-fury]
name=AuthZed Fury Repository
baseurl=https://pkg.authzed.com/yum/
enabled=1
gpgcheck=0
EOF

Install as usual:

sudo dnf install -y spicedb

Homebrew (macOS)

macOS users can install SpiceDB packages by adding a Homebrew tap:

brew install authzed/tap/spicedb

Other methods

Downloading the binary

Visit the GitHub release page for the latest release. Scroll down to the Assets section and download the appropriate artifact.

Source

Clone the GitHub repository:

git clone git@github.com:authzed/spicedb.git

Enter the directory and build the binary using mage:

cd spicedb
go run mage.go build

You can find more commands for tasks such as testing, linting in the repository's CONTRIBUTING.md.