Fork of official Bluesky PDS (Personal Data Server).

Merge pull request #129 from nperez0111/env-vars

docs: add env vars to the docs for easier reference

authored by

Alex Garnett and committed by
GitHub
91dcc3de e2d2d7d0

+38
+22
README.md
··· 31 31 - [Common SMTP issues](#common-smtp-issues) 32 32 - [Logging](#logging) 33 33 - [Updating your PDS](#updating-your-pds) 34 + - [Environment Variables](#environment-variables) 34 35 - [License](#license) 35 36 36 37 <!-- tocstop --> ··· 313 314 ```bash 314 315 sudo pdsadmin update 315 316 ``` 317 + 318 + ### Environment Variables 319 + 320 + | Environment Variable | Value | Default | 321 + |---------------------|-------|---------| 322 + | `PDS_HOSTNAME` | Empty | None | 323 + | `PDS_JWT_SECRET` | Empty | None | 324 + | `PDS_ADMIN_PASSWORD` | Empty | None | 325 + | `PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX` | Empty | None | 326 + | `PDS_DATA_DIRECTORY` | `/pds` | `/pds` | 327 + | `PDS_BLOBSTORE_DISK_LOCATION` | `/pds/blocks` | `/pds/blocks` | 328 + | `PDS_BLOB_UPLOAD_LIMIT` | `52428800` | `52428800` (50MB) | 329 + | `PDS_DID_PLC_URL` | `https://plc.directory` | `https://plc.directory` | 330 + | `PDS_BSKY_APP_VIEW_URL` | `https://api.bsky.app` | `https://api.bsky.app` | 331 + | `PDS_BSKY_APP_VIEW_DID` | `did:web:api.bsky.app` | `did:web:api.bsky.app` | 332 + | `PDS_REPORT_SERVICE_URL` | `https://mod.bsky.app` | `https://mod.bsky.app` | 333 + | `PDS_REPORT_SERVICE_DID` | `did:plc:ar7c4by46qjdydhdevvrndac` | `did:plc:ar7c4by46qjdydhdevvrndac` | 334 + | `PDS_CRAWLERS` | `https://bsky.network` | `https://bsky.network` | 335 + | `LOG_ENABLED` | `true` | `true` | 336 + | `PDS_EMAIL_SMTP_URL` | Empty | None | 337 + | `PDS_EMAIL_FROM_ADDRESS` | Empty | None | 316 338 317 339 ## License 318 340
+16
sample.env
··· 1 + PDS_HOSTNAME= 2 + PDS_JWT_SECRET= 3 + PDS_ADMIN_PASSWORD= 4 + PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX= 5 + PDS_DATA_DIRECTORY=/pds 6 + PDS_BLOBSTORE_DISK_LOCATION=/pds/blocks 7 + PDS_BLOB_UPLOAD_LIMIT=52428800 8 + PDS_DID_PLC_URL=https://plc.directory 9 + PDS_BSKY_APP_VIEW_URL=https://api.bsky.app 10 + PDS_BSKY_APP_VIEW_DID=did:web:api.bsky.app 11 + PDS_REPORT_SERVICE_URL=https://mod.bsky.app 12 + PDS_REPORT_SERVICE_DID=did:plc:ar7c4by46qjdydhdevvrndac 13 + PDS_CRAWLERS=https://bsky.network 14 + LOG_ENABLED=true 15 + PDS_EMAIL_SMTP_URL= 16 + PDS_EMAIL_FROM_ADDRESS=