From adfde3bc1ebd69a54c1719b20961dc7f6190a84f Mon Sep 17 00:00:00 2001 From: lewis Date: Sat, 20 Dec 2025 13:38:49 +0200 Subject: [PATCH] A little more text in the README.md --- README.md | 27 +++++++++++++++++++-------- docs/install-debian.md | 6 ++---- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c6c6367..347cd98 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ # Tranquil PDS -A production-grade Personal Data Server (PDS) for the AT Protocol. Drop-in replacement for Bluesky's reference PDS, written in rust with postgres and s3-compatible blob storage. +A Personal Data Server for the AT Protocol. -## Features +Bluesky runs on a federated protocol called AT Protocol. Your account lives on a PDS, a server that stores your posts, profile, follows, and cryptographic keys. Bluesky hosts one for you at bsky.social, but you can run your own. Self-hosting means you control your data; you're not dependent on any company's servers, and your account + data is actually yours. -- Full AT Protocol support (`com.atproto.*` endpoints) -- OAuth 2.1 provider (PKCE, DPoP, PAR) -- WebSocket firehose (`subscribeRepos`) -- Multi-channel notifications (email, discord, telegram, signal) -- Built-in web UI for account management -- Per-IP rate limiting +This particular PDS thrives under harsh conditions. It is a dandelion growing through the cracks in the sidewalk concrete. + +It has full compatibility with Bluesky's reference PDS: same endpoints, same behavior, same client compatibility. Everything works: repo operations, blob storage, firehose, OAuth, handle resolution, account migration, the lot. + +Another excellent PDS is [Cocoon](https://github.com/haileyok/cocoon), written in go. + +## What's different about Tranquil PDS + +This software isn't an afterthought by a company with limited resources. + +It is a superset of the reference PDS, including: multi-channel communication (email, discord, telegram, signal) for verification and alerts. Built-in web UI for account management, OAuth consent, repo browsing, and admin. Granular OAuth scopes with UI support such that users choose exactly what apps can access. + +The PDS itself is a single small binary with no node/npm runtime. It does require postgres, valkey, and s3-compatible storage, which makes setup heavier than the reference PDS's sqlite. The tradeoff is that these are battle-tested pieces of infra that we already know how to scale, back up, and monitor. ## Quick Start @@ -53,6 +60,10 @@ podman-compose -f docker-compose.prod.yml up -d | [Containers](docs/install-containers.md) | Podman with quadlets or OpenRC | | [Kubernetes](docs/install-kubernetes.md) | You know what you're doing | +## Thanks + +This project is very grateful to [@nel.pet](https://bsky.app/profile/did:plc:h5wsnqetncv6lu2weom35lg2), [@nonbinary.computer](https://bsky.app/profile/did:plc:yfvwmnlztr4dwkb7hwz55r2g), [@juli.ee](https://bsky.app/profile/did:plc:7vimlesenouvuaqvle42yhvo), [@mary.my.id](https://bsky.app/profile/did:plc:ia76kvnndjutgedggx2ibrem), and [@baileytownsend.dev](https://bsky.app/profile/did:plc:rnpkyqnmsw4ipey6eotbdnnf) for their help and their code to lean on. + ## License TBD diff --git a/docs/install-debian.md b/docs/install-debian.md index 919963b..7744c08 100644 --- a/docs/install-debian.md +++ b/docs/install-debian.md @@ -1,12 +1,10 @@ # Tranquil PDS Production Installation on Debian -> **Warning**: These instructions are untested and theoretical, written from the top of Lewis' head. They may contain errors or omissions. This warning will be removed once the guide has been verified. - -This guide covers installing Tranquil PDS on Debian 13 "Trixie". +This guide covers installing Tranquil PDS on Debian 13. ## Prerequisites - A VPS with at least 2GB RAM and 20GB disk - A domain name pointing to your server's IP -- A **wildcard TLS certificate** for `*.pds.example.com` (user handles are served as subdomains) +- A wildcard TLS certificate for `*.pds.example.com` (user handles are served as subdomains) - Root or sudo access ## 1. System Setup ```bash