nel.pet / tranquil
forked from lewis.moe/bspds-sandbox
I've been saying "PDSes seem easy enough, they're what, some CRUD to a db? I can do that in my sleep". well i'm sleeping rn so let's go
fork atom
tranquil / docs / install-kubernetes.md
at main 1.5 kB view raw view code

Tranquil PDS on Kubernetes#

If you're reaching for kubernetes for this app, you're experienced enough to know how to spin up:

  • cloudnativepg (or your preferred postgres operator)
  • valkey
  • s3-compatible object storage (minio operator, or just use a managed service)
  • the app itself (it's just a container with some env vars)

You'll need a wildcard TLS certificate for *.your-pds-hostname.example.com. User handles are served as subdomains.

The container image expects:

  • DATABASE_URL - postgres connection string
  • S3_ENDPOINT, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, S3_BUCKET
  • BACKUP_S3_BUCKET - bucket for repo backups (optional but recommended)
  • VALKEY_URL - redis:// connection string
  • PDS_HOSTNAME - your PDS hostname (without protocol)
  • JWT_SECRET, DPOP_SECRET, MASTER_KEY - generate with openssl rand -base64 48
  • CRAWLERS - typically https://bsky.network and more, check the .env.example.

Health check: GET /xrpc/_health

Custom Homepage#

Mount a ConfigMap with your homepage.html into the container's frontend directory and it becomes your landing page. Go nuts with it. Account dashboard is at /app/ so you won't break anything.

apiVersion: v1
kind: ConfigMap
metadata:
  name: pds-homepage
data:
  homepage.html: |
    <!DOCTYPE html>
    <html>
    <head><title>Welcome to my PDS</title></head>
    <body>
      <h1>Welcome to my little evil secret lab!!!</h1>
      <p><a href="/app/">Sign in</a></p>
    </body>
    </html>