Skip to content

Commit 2aabe94

Browse files
authored
Merge pull request #547 from authzed/update-docs
Update docs components with latest changes from docs site
2 parents 3288f54 + ebc6b61 commit 2aabe94

2 files changed

Lines changed: 125 additions & 19 deletions

File tree

docs/getting-started.md

Lines changed: 54 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
1-
# zed
1+
<!-- markdownlint-disable-next-line MD041 -->
2+
import { Callout } from 'nextra/components'
23

3-
## Getting Started
4+
# Installing Zed
45

5-
### Installing the binary
6+
[Zed](https://github.com/authzed/zed) is the CLI used to interact with SpiceDB.
67

7-
Binary releases are available for Linux, macOS, and Windows on AMD64 and ARM64 architectures.
8+
It is built as a standalone executable file which simplifies installation, but one should prefer one of the recommended installation methods detailed below.
89

9-
[Homebrew] users for both macOS and Linux can install the latest binary releases of zed using the official tap:
10+
## Debian packages
1011

11-
```sh
12-
brew install authzed/tap/zed
13-
```
14-
15-
[Debian-based Linux] users can install zed packages by adding a new APT source:
12+
[Debian-based Linux] users can install SpiceDB packages by adding an additional apt source.
1613

1714
First, download the public signing key for the repository:
1815

@@ -28,12 +25,11 @@ Then add the list file for the repository:
2825
```sh
2926
echo "deb [signed-by=/etc/apt/keyrings/authzed.gpg] https://pkg.authzed.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/authzed.list
3027
sudo chmod 644 /etc/apt/sources.list.d/authzed.list # helps tools such as command-not-found to work correctly
31-
3228
```
3329

3430
Alternatively, if you want to use the new `deb822`-style `authzed.sources` format, put the following in `/etc/apt/sources.list.d/authzed.sources`:
3531

36-
```yaml
32+
```sh
3733
Types: deb
3834
URIs: https://pkg.authzed.com/apt/
3935
Suites: *
@@ -48,23 +44,40 @@ sudo apt update
4844
sudo apt install -y zed
4945
```
5046

51-
[RPM-based Linux] users can install zed packages by adding a new YUM repository:
47+
[Debian-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
48+
49+
## RPM packages
50+
51+
[RPM-based Linux] users can install packages by adding a new yum repository:
5252

5353
```sh
5454
sudo cat << EOF >> /etc/yum.repos.d/Authzed-Fury.repo
5555
[authzed-fury]
5656
name=AuthZed Fury Repository
57-
baseurl=https://yum.fury.io/authzed/
57+
baseurl=https://pkg.authzed.com/yum/
5858
enabled=1
5959
gpgcheck=0
6060
EOF
61+
```
62+
63+
Install as usual:
64+
65+
```sh
6166
sudo dnf install -y zed
6267
```
6368

64-
[homebrew]: https://docs.authzed.com/spicedb/installing#brew
65-
[Debian-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
6669
[RPM-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#RPM-based
6770

71+
## Homebrew (macOS)
72+
73+
macOS users can install packages by adding a [Homebrew tap]:
74+
75+
```sh
76+
brew install authzed/tap/zed
77+
```
78+
79+
[Homebrew tap]: https://docs.brew.sh/Taps
80+
6881
### Other methods
6982

7083
#### Docker
@@ -81,8 +94,32 @@ You can pull down the latest stable release:
8194
docker pull authzed/zed
8295
```
8396

84-
Afterward, you can run it with `docker run`:
97+
Afterwards, you can run it with `docker run`:
8598

8699
```sh
87100
docker run --rm authzed/zed version
88101
```
102+
103+
#### Downloading the binary
104+
105+
Visit the GitHub release page for the [latest release](https://github.com/authzed/zed/releases/latest).
106+
Scroll down to the `Assets` section and download the appropriate artifact.
107+
108+
#### Source
109+
110+
Clone the GitHub repository:
111+
112+
```sh
113+
git clone git@github.com:authzed/zed.git
114+
```
115+
116+
Enter the directory and build the binary using mage:
117+
118+
```sh
119+
cd zed
120+
go build ./cmd/zed
121+
```
122+
123+
You can find more commands for tasks such as testing, linting in the repository's [CONTRIBUTING.md].
124+
125+
[CONTRIBUTING.md]: https://github.com/authzed/zed/blob/main/CONTRIBUTING.md

docs/zed.md

Lines changed: 71 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)