Process settings
Generated by scripts/docs/settings.ts. Do not edit.
Every environment setting, by process. “not set” means the default applies.
web
| Key | Kind | Allowed | Default | local | staging | Defined in |
|---|---|---|---|---|---|---|
UNSET_ENV | oneOf | dev, test, prod | required | dev | dev | shared/config/schema.ts |
UNSET_SERVICE | oneOf | http, admin, api, indexer, media, review, jobs, audit-verify, chat-auth | required | http | http | shared/config/schema.ts |
UNSET_COMMIT | str | text (pattern in source) | required | 0000000000000000000000000000000000000000 | 0000000000000000000000000000000000000000 | shared/config/schema.ts |
LISTEN_PORT | int | 1024 to 65535 | required | 8080 | 8080 | shared/config/schema.ts |
PUBLIC_ORIGIN | origin | https: or http: | required | from env file: WEB_PUBLIC_ORIGIN | from env file: WEB_PUBLIC_ORIGIN | shared/http/config.ts |
HTTP_ALLOWED_HOSTS | list | comma-separated str | required | from env file: WEB_ALLOWED_HOSTS | from env file: WEB_ALLOWED_HOSTS | shared/http/config.ts |
SHUTDOWN_GRACE_MS | int | 1000 to 30000 | 10000 | not set | not set | shared/http/config.ts |
REQUEST_DEADLINE_MS | int | 5000 to 60000 | 30000 | not set | not set | shared/http/config.ts |
TRUSTED_PROXY_MODE | oneOf | header, socket | required | socket | socket | shared/http/config.ts |
TRUSTED_PROXY_HEADER | str | text (pattern in source) | (empty) | not set | not set | shared/http/config.ts |
TRUSTED_PROXY_CIDRS | list | comma-separated str | (empty list) | not set | not set | shared/http/config.ts |
TRUSTED_PROXY_HOPS | int | 1 to 3 | 1 | not set | not set | shared/http/config.ts |
HTTP_BODY_LIMIT_BYTES | int | 1024 to 1048576 | 65536 | not set | not set | shared/http/config.ts |
RATE_LIMIT_MAX_KEYS | int | 1 to 1000000 | 100000 | not set | not set | shared/http/config.ts |
MEDIA_ORIGIN | origin | https: or http: | required | from env file: WEB_MEDIA_ORIGIN | from env file: WEB_MEDIA_ORIGIN | shared/http/config.ts |
SESSION_IDLE_S | int | 300 to 2592000 | 604800 | not set | not set | interfaces/web/src/lib/server/config.ts |
SESSION_ABSOLUTE_S | int | 300 to 2592000 | 2592000 | not set | not set | interfaces/web/src/lib/server/config.ts |
SESSION_TOUCH_INTERVAL_S | int | 1 to 3600 | 300 | not set | not set | interfaces/web/src/lib/server/config.ts |
PG_HOST | str | text (pattern in source) | required | postgres | postgres | infrastructure/postgres/config.ts |
PG_PORT | int | 1 to 65535 | 5432 | not set | not set | infrastructure/postgres/config.ts |
PG_DATABASE | str | text (pattern in source) | required | unset | unset | infrastructure/postgres/config.ts |
PG_USER | str | text (pattern in source) | required | web | web | infrastructure/postgres/config.ts |
PG_PASSWORD | secretFile | at least 16 bytes | required | secret file | secret file | infrastructure/postgres/config.ts |
PG_SSLMODE | oneOf | disable, verify-full | required | disable | disable | infrastructure/postgres/config.ts |
PG_SSLROOTCERT | str | text (pattern in source) | (empty) | not set | not set | infrastructure/postgres/config.ts |
PG_POOL_MAX | int | 1 to 50 | required | 5 | 5 | infrastructure/postgres/config.ts |
PG_CONNECT_TIMEOUT_MS | int | 100 to 10000 | 2000 | not set | not set | infrastructure/postgres/config.ts |
PG_MAX_REPLICAS | int | 1 to 4 | 3 | not set | not set | infrastructure/postgres/config.ts |
LOCK_POOL_MAX | int | 1 to 20 | 8 | not set | not set | infrastructure/postgres/config.ts |
SEAL_KEYRING | secretFile | see source | required | secret file | secret file | infrastructure/seal/keyring.ts |
NETGUARD_INTERNAL_HOSTS | list | comma-separated str | (empty list) | from env file: PDS_HOSTNAME | not set | shared/config/netGuard.ts |
NETGUARD_ALLOW_LOOPBACK | bool | true or false | false | not set | not set | shared/config/netGuard.ts |
PLC_URL | url | https: | required | https://plc.directory | https://plc.directory | interfaces/web/src/lib/server/config.ts |
IDENTITY_HTTP_TIMEOUT_MS | int | 500 to 10000 | 3000 | not set | not set | interfaces/web/src/lib/server/config.ts |
IDENTITY_DNS_TIMEOUT_MS | int | 500 to 10000 | 2000 | not set | not set | interfaces/web/src/lib/server/config.ts |
DID_DOC_CACHE_TTL_S | int | 1 to 3600 | 300 | not set | not set | interfaces/web/src/lib/server/config.ts |
DID_DOC_CACHE_MAX | int | 1 to 100000 | 10000 | not set | not set | interfaces/web/src/lib/server/config.ts |
HANDLE_VERIFY_TTL_S | int | 1 to 3600 | 600 | not set | not set | interfaces/web/src/lib/server/config.ts |
HANDLE_INVALID_TTL_S | int | 1 to 3600 | 60 | not set | not set | interfaces/web/src/lib/server/config.ts |
HANDLE_CACHE_MAX | int | 1 to 100000 | 10000 | not set | not set | interfaces/web/src/lib/server/config.ts |
OAUTH_CLIENT_KEYS | secretFile | see source | required | secret file | secret file | infrastructure/pds/oauth/oauth-client.ts |
OAUTH_ACTIVE_KID | str | text (pattern in source) | required | from env file: WEB_OAUTH_ACTIVE_KID | from env file: WEB_OAUTH_ACTIVE_KID | infrastructure/pds/oauth/oauth-client.ts |
OAUTH_ALLOW_HTTP | bool | true or false | false | not set | not set | infrastructure/pds/oauth/oauth-client.ts |
PDS_HOSTNAME | str | text (pattern in source) | required | from env file: PDS_HOSTNAME | from env file: PDS_HOSTNAME | interfaces/web/src/lib/server/config.ts |
PDS_WEB_KEY | secretFile | at least 64 bytes | required | secret file | secret file | interfaces/web/src/lib/server/config.ts |
HANDLE_SUFFIX | str | text (pattern in source) | required | from env file: PDS_SERVICE_HANDLE_DOMAINS | from env file: PDS_SERVICE_HANDLE_DOMAINS | interfaces/web/src/lib/server/config.ts |
EMAIL_RECHECK_S | int | 60 to 900 | 900 | not set | not set | interfaces/web/src/lib/server/config.ts |
MIN_AGE | int | 16 to 120 | 16 | not set | not set | interfaces/web/src/lib/server/config.ts |
INVITE_COUNTRY_RULE | oneOf | on, off | on | not set | not set | interfaces/web/src/lib/server/config.ts |
PDS_ADMIN_URL | origin | http: or https: | required | http://pds-admin:8080 | http://pds-admin:8080 | interfaces/web/src/lib/server/config.ts |
PDS_ADMIN_WEB_KEY | secretFile | at least 64 bytes | required | secret file | secret file | interfaces/web/src/lib/server/config.ts |
PDS_ADMIN_WEB_KID | str | text (pattern in source) | required | from env file: WEB_PDS_ADMIN_KID | from env file: WEB_PDS_ADMIN_KID | interfaces/web/src/lib/server/config.ts |
PDS_DID | str | text (pattern in source) | required | from env file: PDS_DID | from env file: PDS_DID | interfaces/web/src/lib/server/config.ts |
INVITE_REQUESTS | oneOf | on, off | off | not set | not set | interfaces/web/src/lib/server/config.ts |
INVITE_REQUEST_SMTP_URL | secretFile | at least 16 bytes | optional | not set | not set | interfaces/web/src/lib/server/config.ts |
INVITE_REQUEST_TO | secretFile | at least 6 bytes | optional | not set | not set | interfaces/web/src/lib/server/config.ts |
INVITE_REQUEST_FROM | str | text (pattern in source) | (empty) | not set | not set | interfaces/web/src/lib/server/config.ts |
OBJECT_STORE_URL | origin | http: or https: | required | http://objects:8333 | http://objects:8333 | interfaces/web/src/lib/server/config.ts |
OBJECT_STORE_BUCKET | str | text (pattern in source) | required | unset-private | unset-private | interfaces/web/src/lib/server/config.ts |
OBJECT_STORE_ACCESS_ID | str | text (pattern in source) | required | unset-web | unset-web | interfaces/web/src/lib/server/config.ts |
OBJECT_STORE_SECRET | secretFile | at least 32 bytes | required | secret file | secret file | interfaces/web/src/lib/server/config.ts |
REVIEW_URL | origin | http: | required | http://review:8082 | http://review:8082 | interfaces/web/src/lib/server/config.ts |
SEARCH_LISTING | oneOf | on, off | off | off | off | interfaces/web/src/lib/server/config.ts |
PRIVACY_OFFICER_TITLE | str | text (pattern in source) | required | [to fill: PRIVACY_OFFICER_TITLE] | Privacy Officer | interfaces/web/src/lib/server/legal.ts |
PRIVACY_OFFICER_CONTACT | str | text (pattern in source) | required | [to fill: PRIVACY_OFFICER_CONTACT] | contact@staging.unset.sh | interfaces/web/src/lib/server/legal.ts |
SUPPORT_EMAIL | str | text (pattern in source) | required | [to fill: SUPPORT_EMAIL] | support@staging.unset.sh | interfaces/web/src/lib/server/legal.ts |
SECURITY_CONTACT | str | text (pattern in source) | required | privacy-page | privacy-page | interfaces/web/src/lib/server/legal.ts |
SECURITY_TXT_EXPIRES | str | text (pattern in source) | required | 2027-10-01T00:00:00Z | 2027-10-01T00:00:00Z | interfaces/web/src/lib/server/legal.ts |
TEST_ROUTES | bool | true or false | false | not set | not set | interfaces/web/src/lib/server/config.ts |
indexer
| Key | Kind | Allowed | Default | local | staging | Defined in |
|---|---|---|---|---|---|---|
UNSET_ENV | oneOf | dev, test, prod | required | dev | dev | shared/config/schema.ts |
UNSET_SERVICE | oneOf | http, admin, api, indexer, media, review, jobs, audit-verify, chat-auth | required | indexer | indexer | shared/config/schema.ts |
UNSET_COMMIT | str | text (pattern in source) | required | 0000000000000000000000000000000000000000 | 0000000000000000000000000000000000000000 | shared/config/schema.ts |
LISTEN_PORT | int | 1024 to 65535 | required | 8081 | 8081 | shared/config/schema.ts |
PG_HOST | str | text (pattern in source) | required | postgres | postgres | infrastructure/postgres/config.ts |
PG_PORT | int | 1 to 65535 | 5432 | not set | not set | infrastructure/postgres/config.ts |
PG_DATABASE | str | text (pattern in source) | required | unset | unset | infrastructure/postgres/config.ts |
PG_USER | str | text (pattern in source) | required | indexer | indexer | infrastructure/postgres/config.ts |
PG_PASSWORD | secretFile | at least 16 bytes | required | secret file | secret file | infrastructure/postgres/config.ts |
PG_SSLMODE | oneOf | disable, verify-full | required | disable | disable | infrastructure/postgres/config.ts |
PG_SSLROOTCERT | str | text (pattern in source) | (empty) | not set | not set | infrastructure/postgres/config.ts |
PG_POOL_MAX | int | 1 to 50 | required | 3 | 3 | infrastructure/postgres/config.ts |
PG_CONNECT_TIMEOUT_MS | int | 100 to 10000 | 2000 | not set | not set | infrastructure/postgres/config.ts |
PG_MAX_REPLICAS | int | 1 to 4 | 3 | not set | not set | infrastructure/postgres/config.ts |
NETGUARD_INTERNAL_HOSTS | list | comma-separated str | (empty list) | not set | not set | shared/config/netGuard.ts |
NETGUARD_ALLOW_LOOPBACK | bool | true or false | false | not set | not set | shared/config/netGuard.ts |
PLC_URL | url | https: | required | https://plc.directory | https://plc.directory | interfaces/indexer/config.ts |
IDENTITY_HTTP_TIMEOUT_MS | int | 500 to 10000 | 3000 | not set | not set | interfaces/indexer/config.ts |
IDENTITY_DNS_TIMEOUT_MS | int | 500 to 10000 | 2000 | not set | not set | interfaces/indexer/config.ts |
DID_DOC_CACHE_TTL_S | int | 1 to 3600 | 300 | not set | not set | interfaces/indexer/config.ts |
DID_DOC_CACHE_MAX | int | 1 to 100000 | 10000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_ENABLED | bool | true or false | false | true | true | interfaces/indexer/config.ts |
INDEXER_PDS_URL | url | http: or https: | required | http://pds:3000 | http://pds:3000 | interfaces/indexer/config.ts |
PDS_PUBLIC_URL | url | https: | required | from env file: PDS_PUBLIC_URL | from env file: PDS_PUBLIC_URL | interfaces/indexer/config.ts |
INDEXER_PASS_INTERVAL_MS | int | 1000 to 300000 | 10000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_PASS_OVERDUE_MS | int | 300000 to 86400000 | 1800000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_TIMEOUT_MS | int | 500 to 30000 | 5000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_REPO_TIMEOUT_MS | int | 1000 to 120000 | 30000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_REPO_MAX_BYTES | int | 1048576 to 67108864 | 33554432 | not set | not set | interfaces/indexer/config.ts |
INDEXER_RESTART_DELAY_MS | int | 100 to 60000 | 1000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_MAX_RESTART_DELAY_MS | int | 1000 to 600000 | 60000 | not set | not set | interfaces/indexer/config.ts |
HEALTH_PORT | int | 1024 to 65535 | 8081 | not set | not set | interfaces/indexer/config.ts |
INDEXER_STREAM_UNHEALTHY_MS | int | 60000 to 3600000 | 300000 | not set | not set | interfaces/indexer/config.ts |
INDEXER_SHUTDOWN_GRACE_MS | int | 1000 to 9000 | 8000 | not set | not set | interfaces/indexer/config.ts |
HOSTED_HANDLE_SUFFIXES | list | comma-separated str | required | from env file: PDS_SERVICE_HANDLE_DOMAINS | from env file: PDS_SERVICE_HANDLE_DOMAINS | interfaces/indexer/config.ts |
HANDLE_RECHECK_S | int | 600 to 604800 | 86400 | not set | not set | interfaces/indexer/config.ts |
migrate
| Key | Kind | Allowed | Default | local | staging | Defined in |
|---|---|---|---|---|---|---|
UNSET_ENV | oneOf | dev, test, prod | required | dev | dev | infrastructure/postgres/migrate-cli.ts |
UNSET_COMMIT | str | text (pattern in source) | required | 0000000000000000000000000000000000000000 | 0000000000000000000000000000000000000000 | infrastructure/postgres/migrate-cli.ts |
PG_HOST | str | text (pattern in source) | required | postgres | postgres | infrastructure/postgres/config.ts |
PG_PORT | int | 1 to 65535 | 5432 | not set | not set | infrastructure/postgres/config.ts |
PG_DATABASE | str | text (pattern in source) | required | unset | unset | infrastructure/postgres/config.ts |
PG_USER | str | text (pattern in source) | required | migrator | migrator | infrastructure/postgres/config.ts |
PG_PASSWORD | secretFile | at least 16 bytes | required | secret file | secret file | infrastructure/postgres/config.ts |
PG_SSLMODE | oneOf | disable, verify-full | required | disable | disable | infrastructure/postgres/config.ts |
PG_SSLROOTCERT | str | text (pattern in source) | (empty) | not set | not set | infrastructure/postgres/config.ts |
rewrap
| Key | Kind | Allowed | Default | local | staging | Defined in |
|---|---|---|---|---|---|---|
UNSET_ENV | oneOf | dev, test, prod | required | not in this stack | not in this stack | infrastructure/postgres/rewrap-cli.ts |
UNSET_COMMIT | str | text (pattern in source) | required | not in this stack | not in this stack | infrastructure/postgres/rewrap-cli.ts |
PG_HOST | str | text (pattern in source) | required | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_PORT | int | 1 to 65535 | 5432 | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_DATABASE | str | text (pattern in source) | required | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_USER | str | text (pattern in source) | required | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_PASSWORD | secretFile | at least 16 bytes | required | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_SSLMODE | oneOf | disable, verify-full | required | not in this stack | not in this stack | infrastructure/postgres/config.ts |
PG_SSLROOTCERT | str | text (pattern in source) | (empty) | not in this stack | not in this stack | infrastructure/postgres/config.ts |
SEAL_KEYRING | secretFile | see source | required | not in this stack | not in this stack | infrastructure/seal/keyring.ts |
pds-admin
| Key | Kind | Allowed | Default | local | staging | Defined in |
|---|---|---|---|---|---|---|
PDS_ADMIN_ENV | str | text | required | dev | dev | interfaces/pds-admin/config.ts |
PDS_DID | str | text | required | from env file: PDS_DID | from env file: PDS_DID | interfaces/pds-admin/config.ts |
PDS_INTERNAL_URL | str | text | required | http://pds:3000 | http://pds:3000 | interfaces/pds-admin/config.ts |
SIGNUPS_OPEN | str | text | required | true | true | interfaces/pds-admin/config.ts |
PDS_ADMIN_SECRETS_DIR | str | text | /run/secrets | not set | not set | interfaces/pds-admin/config.ts |
pds_admin_log_key | secretFile | file | required | secret file | secret file | interfaces/pds-admin/config.ts |
INVITE_WINDOW_HOURS | int | 1 to 720 | 24 | not set | not set | interfaces/pds-admin/config.ts |
INVITE_MAX_PER_WINDOW | int | 1 to 1000 | 5 | not set | not set | interfaces/pds-admin/config.ts |
INVITE_MAX_PER_DAY_GLOBAL | int | 1 to 100000 | 100 | not set | not set | interfaces/pds-admin/config.ts |
STATE_DIR | str | text | required | /app/state | /app/state | interfaces/pds-admin/config.ts |
PORT | int | 1 to 65535 | 8080 | 8080 | 8080 | interfaces/pds-admin/config.ts |
COMMIT | str | text | unknown | not set | not set | interfaces/pds-admin/config.ts |
pds_admin_password | secretFile | file | required | secret file | secret file | interfaces/pds-admin/config.ts |
pds_admin_keys | secretFile | file | required | secret file | secret file | interfaces/pds-admin/config.ts |
Other services
Services we run as shipped or without a settings schema: the keys each stack sets.
edge
| Key | local | staging |
|---|---|---|
ACME_EMAIL | from env file: EDGE_ACME_EMAIL | from env file: EDGE_ACME_EMAIL |
APP_HOST | from env file: APP_HOST | from env file: APP_HOST |
APP_UPSTREAM | web:8080 | web:8080 |
DOCS_HOST | not set | docs.unset.sh |
PDS_HOST | from env file: PDS_HOSTNAME | from env file: PDS_HOSTNAME |
PDS_UPSTREAM | pds:3000 | pds:3000 |
newt
| Key | local | staging |
|---|---|---|
CONFIG_FILE | not in this stack | file /tmp/newt.json |
DISABLE_CLIENTS | not in this stack | true |
DISABLE_SSH | not in this stack | true |
LOG_LEVEL | not in this stack | WARN |
NEWT_METRICS_PROMETHEUS_ENABLED | not in this stack | false |
NEWT_PPROF_ENABLED | not in this stack | false |
objects
None.
pds
| Key | local | staging |
|---|---|---|
LOG_ENABLED | false | false |
NODE_EXTRA_CA_CERTS | /etc/unset-dev-trust/root.pem | not set |
NODE_OPTIONS | --max-old-space-size=768 | --max-old-space-size=768 |
PDS_BLOBSTORE_S3_BUCKET | unset-pds | unset-pds |
PDS_BLOBSTORE_S3_ENDPOINT | http://objects:8333 | http://objects:8333 |
PDS_BLOBSTORE_S3_FORCE_PATH_STYLE | true | true |
PDS_BLOBSTORE_S3_REGION | us-east-1 | us-east-1 |
PDS_BLOB_UPLOAD_LIMIT | 5242880 | 5242880 |
PDS_CRAWLERS | (empty) | (empty) |
PDS_DATA_DIRECTORY | /home/node | /home/node |
PDS_DID_PLC_URL | https://plc.directory | https://plc.directory |
PDS_EMAIL_DISABLE_CONFIRMATION_LINK | true | true |
PDS_EMAIL_FROM_ADDRESS | not set | noreply@staging.unset.sh |
PDS_HOSTNAME | from env file: PDS_HOSTNAME | from env file: PDS_HOSTNAME |
PDS_INVITE_REQUIRED | true | true |
PDS_MODERATION_EMAIL_ADDRESS | not set | moderation@staging.unset.sh |
PDS_PORT | 3000 | 3000 |
PDS_RATE_LIMITS_ENABLED | false | false |
PDS_SERVICE_HANDLE_DOMAINS | from env file: PDS_SERVICE_HANDLE_DOMAINS | from env file: PDS_SERVICE_HANDLE_DOMAINS |
pds-token-reader
None.
postgres
| Key | local | staging |
|---|---|---|
POSTGRES_PASSWORD_FILE | file /run/secrets/pg_superuser_password | file /run/secrets/pg_superuser_password |
review
| Key | local | staging |
|---|---|---|
LISTEN_PORT | 8082 | 8082 |
UNSET_COMMIT | 0000000000000000000000000000000000000000 | 0000000000000000000000000000000000000000 |
UNSET_ENV | dev | dev |
UNSET_SERVICE | review | review |