Mirror from bluesky-social/pds

add TOC to SANDBOX, fix merge conflicts

Changed files
+59 -3
+30
README.md
··· 199 199 ```bash 200 200 sudo pdsadmin update 201 201 ``` 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
+29 -3
SANDBOX.md
··· 10 10 11 11 Given that this is a testing environment, we will be defederating from any instances that do not abide by these guidelines, or that cause unnecessary trouble, and will not be providing specific justifications for these decisions. 12 12 13 + <!-- markdown-toc -i SANDBOX.md --> 14 + 15 + <!-- toc --> 16 + 17 + - [Guidelines that must be followed](#guidelines-that-must-be-followed) 18 + * [Post responsibly](#post-responsibly) 19 + * [Keep the emphasis on testing](#keep-the-emphasis-on-testing) 20 + * [Do limit account creation](#do-limit-account-creation) 21 + * [Don’t expect persistence or uptime](#dont-expect-persistence-or-uptime) 22 + * [Don't advertise your service as being "Bluesky"](#dont-advertise-your-service-as-being-bluesky) 23 + * [Do not mirror sandbox did:plcs to production](#do-not-mirror-sandbox-didplcs-to-production) 24 + * [Status and Wipes](#status-and-wipes) 25 + + [🐉 Beware of dragons!](#%F0%9F%90%89-beware-of-dragons) 26 + + [Routine wipes](#routine-wipes) 27 + - [Getting started](#getting-started) 28 + * [Auto-updates](#auto-updates) 29 + * [Odds & Ends & Warnings & Reminders](#odds--ends--warnings--reminders) 30 + - [Learn more about atproto federation](#learn-more-about-atproto-federation) 31 + * [Network Services](#network-services) 32 + + [PLC](#plc) 33 + + [BGS](#bgs) 34 + + [Bluesky App View](#bluesky-app-view) 35 + - [The PDS](#the-pds) 36 + 37 + <!-- tocstop --> 38 + 13 39 # Guidelines that must be followed 14 40 15 41 Using the sandbox environment means you agree to adhere to our Guidelines. Please read the following carefully: ··· 18 44 19 45 The sandbox environment is intended to test infrastructure, but user content may be created as part of this testing process. Content generation can be automated or manual. 20 46 21 - Do not post content that requires active moderation or violates the [Bluesky Community Guidelines](https://blueskyweb.xyz/support/community-guidelines). 47 + Do not post content that requires active moderation or violates the [Bluesky Community Guidelines](https://bsky.social/about/support/community-guidelines). 22 48 23 49 ## Keep the emphasis on testing 24 50 ··· 93 119 94 120 # Learn more about atproto federation 95 121 96 - Check out the [high-level view of federation](https://blueskyweb.xyz/blog/5-5-2023-federation-architecture). 122 + Check out the [high-level view of federation](https://bsky.social/about/blog/5-5-2023-federation-architecture). 97 123 98 124 Dive deeper with the [atproto docs](https://atproto.com/docs). 99 125 ··· 139 165 140 166 We’re not actually running a Bluesky PDS in sandbox. You might see Bluesky team members' accounts in the sandbox environment, but those are self-hosted too. 141 167 142 - The PDS that you’ll be running is much of the same code that is running on the Bluesky production PDS. Notably, all of the in-pds-appview code has been torn out. You can see the actual PDS code that you’re running on the [atproto/simplify-pds](https://github.com/bluesky-social/atproto/pull/1198) branch. 168 + The PDS that you’ll be running is much of the same code that is running on the Bluesky production PDS. Notably, all of the in-pds-appview code has been torn out. You can see the actual PDS code that you’re running on the [atproto/simplify-pds](https://github.com/bluesky-social/atproto/pull/1198) branch.