vicwalker.dev.br
Mirror from bluesky-social/pds
better env docs
+30
-4
+30
-4
README.md
+30
-4
README.md
···
12
12
13
13
### What is AT Protocol?
14
14
15
-
The Authenticated Transfer Protocol, aka ATP, is a protocol for large-scale distributed social applications.
15
+
The Authenticated Transfer Protocol, aka atproto, is a protocol for large-scale distributed social applications.
16
16
17
17
Please visit the [AT Protocol docs](https://atproto.com/guides/overview) for additional information.
18
18
···
154
154
155
155
| Environment Variable | Value |
156
156
| --------------------- | --------------------------------------------- |
157
-
| PDS_DOMAIN | example.com |
158
-
| PDS_DATABASE_URL | postgresql://user:password@host:port/database |
159
-
| PDS_ADMIN_EMAIL | you@example.com |
157
+
| PDS_HOSTNAME | example.com |
158
+
| PDS_DB_POSTGRES_URL | postgresql://user:password@host:port/database |
159
+
| PDS_JWT_SECRET | jwt-secret |
160
+
| PDS_ADMIN_PASSWORD | admin-pass |
160
161
| ... | ... |
162
+
163
+
You _should_ provide values to the following variables:
164
+
- `PDS_HOSTNAME`
165
+
- `PDS_DB_POSTGRES_URL` or `PDS_DB_SQLITE_LOCATION` depending on which database you intend to use
166
+
- `PDS_JWT_SECRET`
167
+
- `PDS_ADMIN_PASSWORD`
168
+
- `LOG_ENBALED` - defaults to `true` and outputs structured logs to stdout
169
+
170
+
You _should not_ update the following value unless you also update the mounted volumes for your docker image:
171
+
- `PDS_BLOBSTORE_DISK_LOCATION`
172
+
173
+
You will need to provide key material to the following variables. We've included a utility to generate keys for you with openssl
174
+
Once these are set, you _should not_ adjust them - as you will break any repositories that you are currently hosting.
175
+
- `PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX`
176
+
- `PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX`
177
+
178
+
You _should not_ adjust the following variables if you intend to federate with the Bluesky federation sandbox:
179
+
- `PDS_DID_PLC_URL="plc.bsky-sandbox.dev"`
180
+
- `PDS_BSKY_APP_VIEW_ENDPOINT="api.bsky-sandbox.dev"`
181
+
- `PDS_BSKY_APP_VIEW_DID="did:web:api.bsky-sandbox.dev"`
182
+
- `PDS_CRAWLERS="bgs.bsky-sandbox.dev"`
183
+
184
+
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.
185
+
186
+
Feel free to explore these [Here](https://github.com/bluesky-social/atproto/blob/simplify-pds/packages/pds/src/config/env.ts). However, we will not be providing support for more advanced configurations.
161
187
162
188
#### Run docker compose
163
189