vicwalker.dev.br
Mirror from bluesky-social/pds
update readme
+18
-14
+18
-14
README.md
+18
-14
README.md
···
144
144
CADDYFILE
145
145
```
146
146
147
+
### Generating K256 private keys
148
+
149
+
Your PDS will need two secp256k1 private keys provided as hex strings. You can securely generate these keys using `openssl` with the following command:
150
+
```bash
151
+
openssl ecparam -name secp256k1 -genkey -noout -outform DER | tail -c +8 | head -c 32 | xxd -p -c 32
152
+
```
153
+
154
+
This will output a 64-char hex string. Please generate two keys in preperation for the next step.
155
+
147
156
### Create the PDS env configuration file
157
+
158
+
You should fill in the first 5 values, but leave the rest untouched unless you have good reason to change it.
159
+
160
+
See the PDS environment variables section at the end of this README for explanations of each value
148
161
149
162
```bash
150
163
cat <<PDS_CONFIG | sudo tee /data/pds.env
151
-
PDS_HOSTNAME=example.com
152
-
PDS_DB_SQLITE_LOCATION=/data/pds.sqlite
164
+
PDS_HOSTNAME=<YOUR_HOSTNAME>
153
165
PDS_JWT_SECRET=<VALUE>
154
166
PDS_ADMIN_PASSWORD=<VALUE>
155
167
PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX=<VALUE>
156
168
PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX=<VALUE>
169
+
PDS_DB_SQLITE_LOCATION=/data/pds.sqlite
157
170
PDS_BLOBSTORE_DISK_LOCATION=/data/blocks
158
171
PDS_DID_PLC_URL=https://plc.bsky-sandbox.dev
159
172
PDS_BSKY_APP_VIEW_ENDPOINT=https://api.bsky-sandbox.dev
···
161
174
PDS_CRAWLERS=https://bgs.bsky-sandbox.dev
162
175
PDS_CONFIG
163
176
```
164
-
165
-
## Generating K256 private keys
166
-
167
-
Your PDS will need two secp256k1 private keys provided as hex strings. You can securely generate these keys using `openssl` with the following command:
168
-
```bash
169
-
openssl ecparam -name secp256k1 -genkey -noout -outform DER | tail -c +8 | head -c 32 | xxd -p -c 32
170
-
```
171
-
172
-
This will output a 64-char hex string. Please generate two keys in preperation for the next step.
173
177
174
178
### Start the PDS containers
175
179
···
223
227
| Environment Variable | Value | Should update? | Notes |
224
228
| ----------------------------------------- | --------------------------------------------- | -------------- |------ |
225
229
| PDS_HOSTNAME | example.com | ✅ | Public domain you intend to deploy your service at |
226
-
| PDS_DB_SQLITE_LOCATION | pds.sqlite | ✅ | Or use `PDS_DB_POSTGRES_URL` depending on which database you intend to use |
227
230
| PDS_JWT_SECRET | jwt-secret | ✅ | Use a secure high-entropy string that is 32 characters in length |
228
231
| PDS_ADMIN_PASSWORD | admin-pass | ✅ | Use a secure high-entropy string that is 32 characters in length |
229
232
| PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX | 3ee68... | ✅ | See above Generate Keys section - once set, do not change |
230
233
| PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX | e049f... | ✅ | See above Generate Keys section - once set, do not change |
231
-
| PDS_BLOBSTORE_DISK_LOCATION | blobs | ❌ | Only update if you update the mounted volume for your docker image as well |
234
+
| PDS_DB_SQLITE_LOCATION | /data/pds.sqlite | ❌ | Or use `PDS_DB_POSTGRES_URL` depending on which database you intend to use |
235
+
| PDS_BLOBSTORE_DISK_LOCATION | /data/blocks | ❌ | Only update if you update the mounted volume for your docker image as well |
232
236
| PDS_DID_PLC_URL | https://plc.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
233
237
| PDS_BSKY_APP_VIEW_URL | https://api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
234
238
| PDS_BSKY_APP_VIEW_DID | did:web:api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
···
236
240
237
241
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.
238
242
239
-
Feel free to explore those [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.
243
+
Feel free to explore those [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.