Mirror from bluesky-social/pds

formatting

+5 -30
+5 -30
README.md
··· 52 52 As of Feb, 2024, the AT Protocol data service (PDS) is now open to federation for self-hosters! 53 53 54 54 ✅ Federated domain handles (e.g. `@fda.gov`) 55 + 55 56 ✅ Federated feed generators (custom algorithms) 57 + 56 58 ✅ Federated relays (event firehose) 59 + 57 60 ✅ Federated app views (API service) 61 + 58 62 ✅ Federated data service (PDS hosting) 63 + 59 64 🟩 Federated moderation (labeling) (coming soon) 60 65 61 66 ### What should I know about running a PDS in the developer sandbox? ··· 199 204 ```bash 200 205 sudo pdsadmin update 201 206 ``` 202 - <<<<<<< HEAD 203 - ======= 204 - 205 - **Restart PDS with the new container image:** 206 - ```bash 207 - sudo systemctl restart pds 208 - ``` 209 - 210 - ## PDS environment variables 211 - 212 - You will need to customize various settings configured through the PDS environment variables. See the below table to find the variables you'll need to set. 213 - 214 - | Environment Variable | Value | Should update? | Notes | 215 - | ----------------------------------------- | ---------------------------- | -------------- | --------------------------------------------------------------------------- | 216 - | PDS_HOSTNAME | example.com | ✅ | Public domain you intend to deploy your service at | 217 - | PDS_JWT_SECRET | jwt-secret | ✅ | Use a secure high-entropy string that is 32 characters in length | 218 - | PDS_ADMIN_PASSWORD | admin-pass | ✅ | Use a secure high-entropy string that is 32 characters in length | 219 - | PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX | 3ee68... | ✅ | See above Generate Keys section - once set, do not change | 220 - | PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX | e049f... | ✅ | See above Generate Keys section - once set, do not change | 221 - | PDS_DB_SQLITE_LOCATION | /pds/pds.sqlite | ❌ | Or use `PDS_DB_POSTGRES_URL` depending on which database you intend to use | 222 - | PDS_BLOBSTORE_DISK_LOCATION | /pds/blocks | ❌ | Only update if you update the mounted volume for your docker image as well | 223 - | PDS_DID_PLC_URL | https://plc.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox | 224 - | PDS_BSKY_APP_VIEW_URL | https://api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox | 225 - | PDS_BSKY_APP_VIEW_DID | did:web:api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox | 226 - | PDS_CRAWLERS | https://bgs.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox | 227 - 228 - There are additional environment variables that can be tweaked depending on how you're running your service. For instance, storing blobs in AWS S3, keys in AWS KMS, or setting up an email service. 229 - 230 - Feel free to explore those [Here](https://github.com/bluesky-social/atproto/blob/main/packages/pds/src/config/env.ts). However, we will not be providing support for more advanced configurations. 231 - >>>>>>> 230720873dba8b6b8ed4d3d1ebf004fd48a4d974