Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add env vars to the docs for easier reference #129

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −0
Open

docs: add env vars to the docs for easier reference #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- tocstop -->

Expand Down Expand Up @@ -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:
Expand Down
16 changes: 16 additions & 0 deletions sample.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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=