vicwalker.dev.br
Mirror from bluesky-social/pds
More tweaks to sandbox guidelines
+34
-36
+34
-36
SANDBOX.md
+34
-36
SANDBOX.md
···
36
36
37
37
This is a developer sandbox and is meant for technical users. Do not promote your service as being a way for non-technical users to use Bluesky.
38
38
39
-
## Other
40
-
41
-
* Do not mirror sandbox did:plcs to production
39
+
## Do not mirror sandbox did:plcs to production
42
40
43
41
44
42
## Status and Wipes
···
57
55
58
56
When we wipe data, we will be wiping it on all services (BGS, App View, PLC). We will also mark any existing DIDs as “invalid” & will refuse to index those accounts in the next epoch of the network to discourage users from attempting to “rollover” their accounts across wipes.
59
57
58
+
# Getting started
59
+
60
+
For complete instructions on getting your PDS set up, check out the [README](./README.md).
61
+
62
+
To access your account, you’ll log in with the client of your choice in the exact same way that you log into production Bluesky, for instance the [Bluesky web client](https://app.bsky-sandbox.dev/). When you do so, please provide the url of *your PDS* as the service that you wish to log in to.
63
+
64
+
## Auto-updates
65
+
66
+
We’ve included Watchtower in the PDS distribution. Every day at midnight PST, this will check our GitHub container registry to see if there is a new version of the PDS container & update it on your service.
67
+
68
+
This will allow us to rapidly iterate on protocol changes, as we’ll be able to push them out to the network on a daily basis.
69
+
70
+
When we do routine network wipes, we will be pushing out a database migration to participating PDS that wipes content and accounts.
71
+
72
+
You are within your rights to disable Watchtower auto-updates, but we strongly encourage their use and will not be providing support if you decide not to run the most up-to-date PDS distribution.
73
+
74
+
## Odds & Ends & Warnings & Reminders
75
+
76
+
🧪 Experiment & have fun!
77
+
78
+
🤖 Run [feed generators](https://github.com/bluesky-social/feed-generator). They should work the exact same way as production - be sure to adjust your env to listen to Sandbox BGS!
79
+
80
+
🌈 Feel free to run your own AppView or BGS - although it’s a bit more involved & we’ll be providing limited support for this.
81
+
82
+
👤 Your PDS will provide your handle by default. Custom domain handles should work exactly the same in sandbox as they do on production Bluesky. Although you will not be able to re-use your handle from production Bluesky as you can only have one DID set per handle.
83
+
84
+
⚠️ If you follow the self-hosted PDS setup instructions, you’ll have private key material in your env file - be careful about sharing that!
85
+
86
+
📣 This is a sandbox version of a **public broadcast protocol** - please do not share sensitive information.
87
+
88
+
🤝 Help each other out! Respond to issues & discussions, chat in [Matrix](https://matrix.to/#/%23bluesky-dev:matrix.org) or the community-run [Discord](https://discord.gg/3srmDsHSZJ), etc.
89
+
60
90
# Learn more about atproto federation
61
91
62
92
Check out the [high-level view of federation](https://blueskyweb.xyz/blog/5-5-2023-federation-architecture).
···
105
135
106
136
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.
107
137
108
-
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.
109
-
110
-
### Getting started
111
-
112
-
For complete instructions on getting your PDS set up, check out the [README](./README.md).
113
-
114
-
To access your account, you’ll log in with the client of your choice in the exact same way that you log into production Bluesky, for instance the [Bluesky web client](https://app.bsky-sandbox.dev/). When you do so, please provide the url of *your PDS* as the service that you wish to log in to.
115
-
116
-
### Auto-updates
117
-
118
-
We’ve included Watchtower in the PDS distribution. Every day at midnight PST, this will check our GitHub container registry to see if there is a new version of the PDS container & update it on your service.
119
-
120
-
This will allow us to rapidly iterate on protocol changes, as we’ll be able to push them out to the network on a daily basis.
121
-
122
-
When we do routine network wipes, we will be pushing out a database migration to participating PDS that wipes content and accounts.
123
-
124
-
You are within your rights to disable Watchtower auto-updates, but we strongly encourage their use and will not be providing support if you decide not to run the most up-to-date PDS distribution.
125
-
126
-
## Odds & Ends & Warnings & Reminders
127
-
128
-
🧪 Experiment & have fun!
129
-
130
-
🤖 Run [feed generators](https://github.com/bluesky-social/feed-generator). They should work the exact same way as production - be sure to adjust your env to listen to Sandbox BGS!
131
-
132
-
🌈 Feel free to run your own AppView or BGS - although it’s a bit more involved & we’ll be providing limited support for this.
133
-
134
-
👤 Your PDS will provide your handle by default. Custom domain handles should work exactly the same in sandbox as they do on production Bluesky. Although you will not be able to re-use your handle from production Bluesky as you can only have one DID set per handle.
135
-
136
-
⚠️ If you follow the self-hosted PDS setup instructions, you’ll have private key material in your env file - be careful about sharing that!
137
-
138
-
📣 This is a sandbox version of a **public broadcast protocol** - please do not share sensitive information.
139
-
140
-
🤝 Help each other out! Respond to issues & discussions, chat in [Matrix](https://matrix.to/#/%23bluesky-dev:matrix.org) or the community-run [Discord](https://discord.gg/3srmDsHSZJ), etc.
138
+
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.