zzstoatzz.io / zds
zig pds
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

54 1 0

Clone this repository

https://git.vm.fail/zzstoatzz.io/zds https://git.vm.fail/did:plc:fcfm5scqqlsvecmzchau27db
ssh://git@knot1.tangled.sh:2222/zzstoatzz.io/zds ssh://git@knot1.tangled.sh:2222/did:plc:fcfm5scqqlsvecmzchau27db

For self-hosted knots, clone URLs may differ based on your setup.


Download tar.gz Download .zip
README.md

zds#

a zig implementation of an at protocol personal data server.

name credit: jim (calabro.io) suggested zds.

zds stores atproto accounts, repos, records, blobs, sessions, and identity state. it uses zat for atproto primitives such as syntax, did resolution, jwt helpers, dag-cbor, car, mst, repo verification, and key encoding.

references#

the implementation is informed by:

  • tranquil.farm/tranquil-pds
  • futur.blue/pegasus
  • bluesky-social/pds and bluesky-social/atproto/packages/pds
  • alice.mosphere.at/atproto-smoke
  • chadtmiller.com/pds.js
  • zzstoatzz.io/pds-message-poc
  • zzstoatzz.io/pollz
  • haileyok/cocoon

see docs/reference-study.md.

run locally#

zig build test
zig build run -- --port 2583 --db dev/zds.sqlite3
caddy run --config dev/Caddyfile

before committing:

zig build test
zig zen

endpoints#

current server surface includes:

  • GET /
  • GET /.well-known/did.json
  • GET /.well-known/atproto-did
  • GET /xrpc/_health
  • GET /xrpc/com.atproto.server.describeServer
  • POST /xrpc/com.atproto.server.createAccount
  • POST /xrpc/com.atproto.server.createSession
  • POST /xrpc/com.atproto.server.refreshSession
  • GET /xrpc/com.atproto.server.getSession
  • GET /xrpc/com.atproto.server.getServiceAuth
  • repo read/write/import/blob endpoints
  • sync repo/blob/status endpoints
  • identity plc credential/sign/submit endpoints
  • generic XRPC service proxying for requests that include atproto-proxy

blob uploads default to 100000000 bytes. set ZDS_BLOB_UPLOAD_LIMIT or --blob-upload-limit to change it.

see docs/smoke.md for the first atproto-smoke run.

deploy#

run behind a public https origin:

ZDS_RESEND_API_KEY=... \
ZDS_EMAIL_FROM='ZDS <pds@example.com>' \
ZDS_BLOB_UPLOAD_LIMIT=100000000 \
ZDS_HANDLE_DOMAINS='.example.com,example.com' \
ZDS_JWT_SECRET='at-least-32-random-bytes-here' \
zig build run -- \
  --port 2583 \
  --db /var/lib/zds/zds.sqlite3 \
  --public-url https://pds.example.com \
  --server-did did:web:pds.example.com

configuration:

  • --public-url: public pds origin used in did credentials and blob urls
  • --server-did: pds service did, usually did:web:<host>
  • ZDS_HANDLE_DOMAINS: comma-separated handle domains advertised by describeServer
  • ZDS_JWT_SECRET: stable secret for access and refresh jwt signing
  • ZDS_RESEND_API_KEY and ZDS_EMAIL_FROM: email delivery for account and plc tokens
  • ZDS_BLOB_UPLOAD_LIMIT: generic com.atproto.repo.uploadBlob body limit

account migration#

zds implements the pds endpoints used by browser-based migration tools such as pds moover:

  • service-auth-gated createAccount for an existing did
  • repo car import/export
  • missing blob reporting and blob upload
  • recommended did credentials
  • plc operation email token, signing, and submission
  • account activation/deactivation and status checks

see docs/migration.md.

storage#

sqlite stores accounts, records, repo blocks, commits, expected blobs, imported blobs, oauth requests, and auth tokens. uploaded blobs are currently stored in sqlite as blob rows.

next#

  • com.atproto.sync.subscribeRepos
  • password reset and account recovery flows
  • filesystem or object-store blob storage
  • backup/restore docs for the sqlite database and blob store