improved instructions
This commit is contained in:
parent
7bd94fcc86
commit
976e508ee5
2 changed files with 42 additions and 34 deletions
74
README.md
74
README.md
|
@ -1,5 +1,6 @@
|
|||
# bluesky-pds-docker
|
||||
A self-contained Docker image for the [Bluesky PDS (Personal Data Server) ](https://github.com/bluesky-social/pds). This image is pinned to v0.4.74.
|
||||
|
||||
A self-contained Docker image for the [Bluesky PDS (Personal Data Server) ](https://github.com/bluesky-social/pds) for use with Traefik. This image is pinned to v0.4.74.
|
||||
|
||||
It is required to run the instance behind a proxy (like traefik) to generate SSL certificates. This will not work otherwise. The standard pds install includes caddy to handle this.
|
||||
|
||||
|
@ -7,41 +8,43 @@ I can confirm it works behind Cloudflare's DNS Proxy with Full (strict).
|
|||
|
||||
## Deployment
|
||||
|
||||
### Reqirements (to)
|
||||
|
||||
#### Manjaro/Arch
|
||||
|
||||
```bash
|
||||
sudo pacman -Syu install jq
|
||||
```
|
||||
|
||||
#### Debian/Ubunut
|
||||
|
||||
```bash
|
||||
sudo apt install make xxd
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
Generate secrets and add them to `.env` file. See [example.env](example.env) as an example.
|
||||
|
||||
```bash
|
||||
# Generate secret environment variables
|
||||
echo PDS_ADMIN_PASSWORD: $(openssl rand --hex 16)
|
||||
echo PDS_JWT_SECRET: $(openssl rand --hex 16)
|
||||
echo PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX: $(openssl ecparam --name secp256k1 --genkey --noout --outform DER | tail --bytes=+8 | head --bytes=32 | xxd --plain --cols 32)
|
||||
|
||||
# pull and run the container
|
||||
docker pull forgejo.gravityfargo.dev/gravityfargo/bluesky-pds
|
||||
docker-compose up -d
|
||||
|
||||
# Create an account
|
||||
docker exec -it bluesky-pds bash
|
||||
pdsadmin account create
|
||||
pdsadmin account list
|
||||
pdsadmin request-crawl bsky.network # useful if you re-deploy the same instance multiple times
|
||||
```
|
||||
|
||||
In your browser:
|
||||
|
||||
- Go to https://bsky-debug.app/handle and enter your new user, "HTTP Verification Method" needs to pass.
|
||||
- [websocket-tester](https://piehost.com/websocket-tester) "wss://example.com/xrpc/com.atproto.sync.subscribeRepos?cursor=0" needs to display "Connection Established"
|
||||
- https://boat.kelinci.net/ has a helpful tool to export your data.
|
||||
- Log in with your new user and go to https://bsky.app/
|
||||
|
||||
|
||||
### Example Docker Compose
|
||||
### Standalone
|
||||
|
||||
Full list of additional Environment Variables can be found in the [packages/pds/src/config/env.ts](https://github.com/bluesky-social/atproto/blob/main/packages/pds/src/config/env.ts)
|
||||
|
||||
```yaml
|
||||
# Standalone, you'll need to add a proxy in front of this with SSL.
|
||||
services:
|
||||
bluesky-pds:
|
||||
container_name: bluesky-pds
|
||||
image: forgejo.gravityfargo.dev/gravityfargo/bluesky-pds
|
||||
environment:
|
||||
# Define variables here or in a .env file
|
||||
PDS_JWT_SECRET: ...
|
||||
PDS_ADMIN_PASSWORD: ...
|
||||
PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX: ...
|
||||
|
@ -52,30 +55,24 @@ services:
|
|||
- ./bluesky-pds:/pds
|
||||
```
|
||||
|
||||
### Example Docker Compose with Traefik
|
||||
### Traefik
|
||||
|
||||
```yaml
|
||||
# Traefik Proxy
|
||||
services:
|
||||
bluesky-pds:
|
||||
container_name: bluesky-pds
|
||||
image: forgejo.gravityfargo.dev/gravityfargo/bluesky-pds:latest
|
||||
networks:
|
||||
- proxy
|
||||
env_file:
|
||||
PDS_ADMIN_PASSWORD: ""
|
||||
PDS_JWT_SECRET: ""
|
||||
PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX: ""
|
||||
PDS_HOSTNAME: example.com
|
||||
PDS_EMAIL_SMTP_URL: ""
|
||||
PDS_EMAIL_FROM_ADDRESS: ""
|
||||
- .env
|
||||
volumes:
|
||||
- ./bluesky-pds:/pds
|
||||
labels:
|
||||
traefik.enable: "true"
|
||||
traefik.http.routers.bluesky-pds-insecure.entrypoints: http
|
||||
traefik.http.routers.bluesky-pds-insecure.rule: HostRegexp(`^.+\.example\.com$`) || Host(`example.social`)
|
||||
traefik.http.routers.bluesky-pds-insecure.rule: HostRegexp(`^.+\.example\.com$`)
|
||||
traefik.http.routers.bluesky-pds-secure.entrypoints: https
|
||||
traefik.http.routers.bluesky-pds-secure.rule: HostRegexp(`^.+\.example\.com$`) || Host(`example.social`)
|
||||
traefik.http.routers.bluesky-pds-secure.rule: HostRegexp(`^.+\.example\.com$`)
|
||||
traefik.http.routers.bluesky-pds-secure.tls: "true"
|
||||
traefik.http.services.bluesky-pds.loadbalancer.server.scheme: http
|
||||
traefik.http.services.bluesky-pds.loadbalancer.server.port: 3000
|
||||
|
@ -88,6 +85,7 @@ services:
|
|||
I think file configs are cleaner than having a billion labels.
|
||||
|
||||
```yaml
|
||||
# middleware.yaml
|
||||
http:
|
||||
middlewares:
|
||||
BlueskyHeaders:
|
||||
|
@ -104,8 +102,18 @@ http:
|
|||
stsSeconds: 63072000
|
||||
```
|
||||
|
||||
## Development Notes
|
||||
#### Optional Proxy Network
|
||||
|
||||
```bash
|
||||
pamac install jq
|
||||
docker network create --subnet=192.168.1.0/24 --ipv6 --attachable proxy
|
||||
# /etc/docker/daemon.json
|
||||
# {
|
||||
# "ipv6": true,
|
||||
# "fixed-cidr-v6": "2001:db8:1::/64"
|
||||
# }
|
||||
|
||||
```
|
||||
|
||||
#### Cloudflare DNS
|
||||
|
||||
![alt text](assets/image.png)
|
||||
|
|
BIN
assets/image.png
Normal file
BIN
assets/image.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
Loading…
Reference in a new issue