# zds

an [AT Protocol](https://atproto.com) personal data server in Zig, built on
[zat](https://tangled.org/zat.dev/zat) for protocol primitives and
[webauthn](https://tangled.org/zzstoatzz.io/webauthn) for passkeys.

**live:** [pds.zat.dev](https://pds.zat.dev)

[Spaces support](docs/permissioned-data.md) is experimental; protocol updates can
require coordinated client migrations.

> featured in the [atproto spaces alpha](https://atproto.com/blog/atproto-spaces-alpha).
> name credit: jim (`calabro.io`) suggested `zds`.

## develop

requires [Zig 0.17.0](https://ziglang.org/download/). smoke tests also use
[Just](https://just.systems), Python 3, curl, jq, and SQLite.

```sh
zig build                                       # build binaries
zig build run -- --port 2583 --db dev/zds.sqlite3  # local server
just test                                       # unit tests
just smoke-all                                  # public and permissioned HTTP tests
```

## run

container images are published to [ATCR](https://atcr.io):

```sh
docker pull atcr.io/zat.dev/zds:latest
```

see the [operator guide](docs/operations.md) for configuration, persistent
storage, and deployment behind a public HTTPS origin.

## docs

[docs/](docs/) contains architecture, development, operations, and protocol notes.

## license

[MIT](LICENSE) · [changelog](CHANGELOG.md)