diff --git a/README.md b/README.md index 48cceb6..8f3fcf6 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Head over to the [AT Protocol PDS Admins Discord](https://discord.gg/e7hpHxRfBP) * [Using the Bluesky app with your PDS](#using-the-bluesky-app-with-your-pds) * [Setting up SMTP](#setting-up-smtp) * [Updating your PDS](#updating-your-pds) + * [Environment Variables](#environment-variables) @@ -224,6 +225,27 @@ It is recommended that you keep your PDS up to date with new versions, otherwise sudo pdsadmin update ``` +### Environment Variables + +| Environment Variable | Value | Default | +|---------------------|-------|---------| +| `PDS_HOSTNAME` | Empty | None | +| `PDS_JWT_SECRET` | Empty | None | +| `PDS_ADMIN_PASSWORD` | Empty | None | +| `PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX` | Empty | None | +| `PDS_DATA_DIRECTORY` | `/pds` | `/pds` | +| `PDS_BLOBSTORE_DISK_LOCATION` | `/pds/blocks` | `/pds/blocks` | +| `PDS_BLOB_UPLOAD_LIMIT` | `52428800` | `52428800` (50MB) | +| `PDS_DID_PLC_URL` | `https://plc.directory` | `https://plc.directory` | +| `PDS_BSKY_APP_VIEW_URL` | `https://api.bsky.app` | `https://api.bsky.app` | +| `PDS_BSKY_APP_VIEW_DID` | `did:web:api.bsky.app` | `did:web:api.bsky.app` | +| `PDS_REPORT_SERVICE_URL` | `https://mod.bsky.app` | `https://mod.bsky.app` | +| `PDS_REPORT_SERVICE_DID` | `did:plc:ar7c4by46qjdydhdevvrndac` | `did:plc:ar7c4by46qjdydhdevvrndac` | +| `PDS_CRAWLERS` | `https://bsky.network` | `https://bsky.network` | +| `LOG_ENABLED` | `true` | `true` | +| `PDS_EMAIL_SMTP_URL` | Empty | None | +| `PDS_EMAIL_FROM_ADDRESS` | Empty | None | + ## License This project is dual-licensed under MIT and Apache 2.0 terms: diff --git a/sample.env b/sample.env new file mode 100644 index 0000000..ecc4d2f --- /dev/null +++ b/sample.env @@ -0,0 +1,16 @@ +PDS_HOSTNAME= +PDS_JWT_SECRET= +PDS_ADMIN_PASSWORD= +PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX= +PDS_DATA_DIRECTORY=/pds +PDS_BLOBSTORE_DISK_LOCATION=/pds/blocks +PDS_BLOB_UPLOAD_LIMIT=52428800 +PDS_DID_PLC_URL=https://plc.directory +PDS_BSKY_APP_VIEW_URL=https://api.bsky.app +PDS_BSKY_APP_VIEW_DID=did:web:api.bsky.app +PDS_REPORT_SERVICE_URL=https://mod.bsky.app +PDS_REPORT_SERVICE_DID=did:plc:ar7c4by46qjdydhdevvrndac +PDS_CRAWLERS=https://bsky.network +LOG_ENABLED=true +PDS_EMAIL_SMTP_URL= +PDS_EMAIL_FROM_ADDRESS=