ngerakines.me
forked from
chadtmiller.com/pds.js
A minimal AT Protocol Personal Data Server written in JavaScript.
docs: fix Quick Start to use local PLC/relay for development
The previous Quick Start used localhost:3000 as the PDS URL, which would
register a DID with the production PLC directory pointing to localhost.
Now uses docker compose to run local PLC and relay for safe local dev.
Also clarifies that setup should only be run for Node.js deployments
once the PDS is accessible at a public URL.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
chadtmiller.com
+12
-3
README.md
+12
-3
README.md
···
23
- **Deno** - Modern runtime with built-in TypeScript, uses node:sqlite
24
- **Cloudflare Workers** - Edge deployment with Durable Objects and R2
25
26
-
## Quick Start (Node.js)
27
28
```bash
29
git clone https://tangled.org/chadtmiller.com/pds.js
30
cd pds.js && npm install
31
npm run dev:node
32
-
npm run setup -- --pds http://localhost:3000
33
```
34
35
## Configuration
···
68
cd examples/node && npm start
69
```
70
71
-
4. **Initialize PDS**
72
```bash
73
npm run setup -- --pds https://your-hostname.com
74
```
75
76
**Production notes:**
77
- Use a reverse proxy (nginx, Caddy) for TLS termination
···
23
- **Deno** - Modern runtime with built-in TypeScript, uses node:sqlite
24
- **Cloudflare Workers** - Edge deployment with Durable Objects and R2
25
26
+
## Quick Start (Local Development)
27
28
```bash
29
git clone https://tangled.org/chadtmiller.com/pds.js
30
cd pds.js && npm install
31
+
32
+
# Start local PLC + relay (requires Docker)
33
+
docker compose up -d
34
+
35
+
# Start PDS
36
npm run dev:node
37
+
38
+
# Register with local PLC (in another terminal)
39
+
npm run setup -- --pds https://localhost:3443 --plc-url http://localhost:2582 --relay-url http://localhost:2470
40
```
41
42
## Configuration
···
75
cd examples/node && npm start
76
```
77
78
+
4. **Initialize PDS** (only after deploying to a public domain)
79
```bash
80
npm run setup -- --pds https://your-hostname.com
81
```
82
+
83
+
> **Note:** This registers your DID with the production PLC directory. Only run this once your PDS is accessible at a public URL.
84
85
**Production notes:**
86
- Use a reverse proxy (nginx, Caddy) for TLS termination