4 Commits

Author SHA1 Message Date
notplants 268ee6d1a8 bump to 0.1.1+v0.4 2026-02-22 04:58:07 +00:00
notplants b2049859dc working on caddy sidecar 2026-02-22 04:58:07 +00:00
notplants 78a3863769 starting on recipe 2026-02-22 04:58:07 +00:00
notplants db7911b664 first commit 2026-02-22 04:58:07 +00:00
3 changed files with 54 additions and 70 deletions
+1 -3
View File
@@ -6,9 +6,7 @@ LETS_ENCRYPT_ENV=production
# Blob upload limit in bytes (default: 100MB)
#PDS_BLOB_UPLOAD_LIMIT=104857600
# Network settings
# These are managed by the upstream PDS image with sensible defaults.
# Only set these if you need to override the upstream defaults.
# Federation settings (defaults connect to the main Bluesky network)
#PDS_DID_PLC_URL=https://plc.directory
#PDS_BSKY_APP_VIEW_URL=https://api.bsky.app
#PDS_BSKY_APP_VIEW_DID=did:web:api.bsky.app
+45 -65
View File
@@ -13,47 +13,53 @@
<!-- endmetadata -->
## Quickstart
## About
0. setup a server with [abra](https://git.coopcloud.tech/toolshed/abra) and deploy [coop-cloud/traefik](https://git.coopcloud.tech/coop-cloud/traefik)
A [Bluesky PDS](https://github.com/bluesky-social/pds) (Personal Data Server)
is a self-hosted server for the AT Protocol, allowing you to own your social
data and federate with the Bluesky network.
1. `abra app new bluesky-pds` (do **not** use `--secrets` yet, see below)
2. Generate secrets:
## Basic usage
The JWT secret and admin password can be generated automatically:
1. Set up Docker Swarm and [`abra`]
2. Deploy [`coop-cloud/traefik`]
3. `abra app new bluesky-pds` (do **not** use `--secrets` yet, see below)
4. `abra app config YOURAPPDOMAIN` - set `DOMAIN` to something that resolves to
your Docker swarm box
5. Generate the PLC rotation key and create secrets (see below)
6. `abra app deploy YOURAPPDOMAIN`
7. Verify the PDS is running: `curl https://YOURAPPDOMAIN/xrpc/_health`
```bash
abra app secret generate YOURAPPDOMAIN pds_jwt_secret v1
abra app secret generate YOURAPPDOMAIN pds_admin_password v1
```
## Generating secrets
The PLC rotation key is a secp256k1 private key and must be generated
manually:
The JWT secret and admin password can be generated automatically:
```bash
openssl ecparam --name secp256k1 --genkey --noout --outform DER | \
tail --bytes=+8 | head --bytes=32 | xxd --plain --cols 32
```
```bash
abra app secret generate YOURAPPDOMAIN pds_jwt_secret v1
abra app secret generate YOURAPPDOMAIN pds_admin_password v1
```
Then store it as a secret:
The PLC rotation key is a secp256k1 private key and must be generated manually:
```bash
abra app secret insert YOURAPPDOMAIN pds_plc_rotation_key v1 <THE_KEY_HEX>
```
```bash
openssl ecparam --name secp256k1 --genkey --noout --outform DER | \
tail --bytes=+8 | head --bytes=32 | xxd --plain --cols 32
```
3. `abra app deploy YOURAPPDOMAIN`
Then store it as a secret:
Verify the PDS is running: `curl https://YOURAPPDOMAIN/xrpc/_health`
```bash
abra app secret insert YOURAPPDOMAIN pds_plc_rotation_key v1 <THE_KEY_HEX>
```
## Account management
Create an account on your PDS (use the admin password you stored during secret
generation):
Create an account on your PDS:
```bash
abra app run YOURAPPDOMAIN app -- \
goat pds admin account create \
--admin-password YOUR_ADMIN_PASSWORD \
--admin-password "$(abra app secret get YOURAPPDOMAIN pds_admin_password v1)" \
--handle user.YOURAPPDOMAIN \
--email user@example.com \
--password yourpassword
@@ -63,25 +69,10 @@ Create an invite code:
```bash
abra app run YOURAPPDOMAIN app -- \
goat pds admin create-invites \
--admin-password YOUR_ADMIN_PASSWORD
goat pds admin account create-invite \
--admin-password "$(abra app secret get YOURAPPDOMAIN pds_admin_password v1)"
```
## Usage
Once you've created an account (see above), you can log in with any
ATProto-compatible client:
1. Open [bsky.app](https://bsky.app) (or another client like Graysky, Sky.app,
etc.)
2. On the login screen, tap **Hosting provider** (or **Custom PDS** depending on
the client)
3. Enter your PDS hostname: `YOURAPPDOMAIN`
4. Log in with the handle and password you used when creating the account
Your handle will be `user.YOURAPPDOMAIN` by default (a subdomain handle). You
can switch to a custom domain handle — see **Handle configuration** below.
## Handle configuration
User handles on a PDS can work in two ways:
@@ -95,24 +86,6 @@ User handles on a PDS can work in two ways:
`did=did:plc:<their-did>`. This works without any additional server
configuration.
## DNS setup
At minimum, create an A record pointing your PDS domain to your server:
```
pds.example.com A <server-ip>
```
For subdomain handles, also add a wildcard record:
```
*.pds.example.com A <server-ip>
```
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra
[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
## TLS architecture (Caddy sidecar)
This recipe uses a **Caddy sidecar** for TLS instead of letting Traefik terminate
@@ -141,12 +114,19 @@ Caddy obtains the TLS certificate from Let's Encrypt. Subsequent requests are in
No changes to the Traefik recipe are needed — the TCP passthrough is configured
entirely via deploy labels on the Caddy service in this recipe's `compose.yml`.
## About
## DNS setup
A [Bluesky PDS](https://github.com/bluesky-social/pds) (Personal Data Server)
is a self-hosted server for ATProto. This is a co-op cloud recipe for a PDS
as implemented by bluesky, although other pds implementations exist such as [cocoon](https://tangled.org/hailey.at/cocoon), [tranquil-pds](https://tangled.org/tranquil.farm/tranquil-pds), [pegasus](https://tangled.org/futur.blue/pegasus) and [rsky-pds](https://github.com/blacksky-algorithms/rsky/tree/main/rsky-pds).
At minimum, create an A record pointing your PDS domain to your server:
# ❃
```
pds.example.com A <server-ip>
```
recipe maintained by @notplants
For subdomain handles, also add a wildcard record:
```
*.pds.example.com A <server-ip>
```
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra
[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
+8 -2
View File
@@ -3,7 +3,7 @@ version: "3.8"
services:
app:
image: ghcr.io/bluesky-social/pds:0.4.219
image: ghcr.io/bluesky-social/pds:0.4
networks:
- internal
environment:
@@ -11,6 +11,12 @@ services:
- PDS_DATA_DIRECTORY=/pds
- PDS_BLOBSTORE_DISK_LOCATION=/pds/blocks
- PDS_BLOB_UPLOAD_LIMIT=${PDS_BLOB_UPLOAD_LIMIT:-104857600}
- PDS_DID_PLC_URL=${PDS_DID_PLC_URL:-https://plc.directory}
- PDS_BSKY_APP_VIEW_URL=${PDS_BSKY_APP_VIEW_URL:-https://api.bsky.app}
- PDS_BSKY_APP_VIEW_DID=${PDS_BSKY_APP_VIEW_DID:-did:web:api.bsky.app}
- PDS_REPORT_SERVICE_URL=${PDS_REPORT_SERVICE_URL:-https://mod.bsky.app}
- PDS_REPORT_SERVICE_DID=${PDS_REPORT_SERVICE_DID:-did:plc:ar7c4by46qjdydhdevvrndac}
- PDS_CRAWLERS=${PDS_CRAWLERS:-https://bsky.network}
- PDS_EMAIL_SMTP_URL=${PDS_EMAIL_SMTP_URL:-}
- PDS_EMAIL_FROM_ADDRESS=${PDS_EMAIL_FROM_ADDRESS:-}
- PDS_INVITE_REQUIRED=${PDS_INVITE_REQUIRED:-true}
@@ -36,7 +42,7 @@ services:
max_attempts: 5
labels:
- "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
- "coop-cloud.${STACK_NAME}.version=0.3.0+v0.4.219"
- "coop-cloud.${STACK_NAME}.version=0.1.1+v0.4"
- "backupbot.backup=true"
healthcheck:
test: ["CMD", "wget", "-q", "--spider", "http://localhost:3000/xrpc/_health"]