Skip to content

Process settings

Generated by scripts/docs/settings.ts. Do not edit.

Every environment setting, by process. “not set” means the default applies.

web

KeyKindAllowedDefaultlocalstagingDefined in
UNSET_ENVoneOfdev, test, prodrequireddevdevshared/config/schema.ts
UNSET_SERVICEoneOfhttp, admin, api, indexer, media, review, jobs, audit-verify, chat-authrequiredhttphttpshared/config/schema.ts
UNSET_COMMITstrtext (pattern in source)required00000000000000000000000000000000000000000000000000000000000000000000000000000000shared/config/schema.ts
LISTEN_PORTint1024 to 65535required80808080shared/config/schema.ts
PUBLIC_ORIGINoriginhttps: or http:requiredfrom env file: WEB_PUBLIC_ORIGINfrom env file: WEB_PUBLIC_ORIGINshared/http/config.ts
HTTP_ALLOWED_HOSTSlistcomma-separated strrequiredfrom env file: WEB_ALLOWED_HOSTSfrom env file: WEB_ALLOWED_HOSTSshared/http/config.ts
SHUTDOWN_GRACE_MSint1000 to 3000010000not setnot setshared/http/config.ts
REQUEST_DEADLINE_MSint5000 to 6000030000not setnot setshared/http/config.ts
TRUSTED_PROXY_MODEoneOfheader, socketrequiredsocketsocketshared/http/config.ts
TRUSTED_PROXY_HEADERstrtext (pattern in source)(empty)not setnot setshared/http/config.ts
TRUSTED_PROXY_CIDRSlistcomma-separated str(empty list)not setnot setshared/http/config.ts
TRUSTED_PROXY_HOPSint1 to 31not setnot setshared/http/config.ts
HTTP_BODY_LIMIT_BYTESint1024 to 104857665536not setnot setshared/http/config.ts
RATE_LIMIT_MAX_KEYSint1 to 1000000100000not setnot setshared/http/config.ts
MEDIA_ORIGINoriginhttps: or http:requiredfrom env file: WEB_MEDIA_ORIGINfrom env file: WEB_MEDIA_ORIGINshared/http/config.ts
SESSION_IDLE_Sint300 to 2592000604800not setnot setinterfaces/web/src/lib/server/config.ts
SESSION_ABSOLUTE_Sint300 to 25920002592000not setnot setinterfaces/web/src/lib/server/config.ts
SESSION_TOUCH_INTERVAL_Sint1 to 3600300not setnot setinterfaces/web/src/lib/server/config.ts
PG_HOSTstrtext (pattern in source)requiredpostgrespostgresinfrastructure/postgres/config.ts
PG_PORTint1 to 655355432not setnot setinfrastructure/postgres/config.ts
PG_DATABASEstrtext (pattern in source)requiredunsetunsetinfrastructure/postgres/config.ts
PG_USERstrtext (pattern in source)requiredwebwebinfrastructure/postgres/config.ts
PG_PASSWORDsecretFileat least 16 bytesrequiredsecret filesecret fileinfrastructure/postgres/config.ts
PG_SSLMODEoneOfdisable, verify-fullrequireddisabledisableinfrastructure/postgres/config.ts
PG_SSLROOTCERTstrtext (pattern in source)(empty)not setnot setinfrastructure/postgres/config.ts
PG_POOL_MAXint1 to 50required55infrastructure/postgres/config.ts
PG_CONNECT_TIMEOUT_MSint100 to 100002000not setnot setinfrastructure/postgres/config.ts
PG_MAX_REPLICASint1 to 43not setnot setinfrastructure/postgres/config.ts
LOCK_POOL_MAXint1 to 208not setnot setinfrastructure/postgres/config.ts
SEAL_KEYRINGsecretFilesee sourcerequiredsecret filesecret fileinfrastructure/seal/keyring.ts
NETGUARD_INTERNAL_HOSTSlistcomma-separated str(empty list)from env file: PDS_HOSTNAMEnot setshared/config/netGuard.ts
NETGUARD_ALLOW_LOOPBACKbooltrue or falsefalsenot setnot setshared/config/netGuard.ts
PLC_URLurlhttps:requiredhttps://plc.directoryhttps://plc.directoryinterfaces/web/src/lib/server/config.ts
IDENTITY_HTTP_TIMEOUT_MSint500 to 100003000not setnot setinterfaces/web/src/lib/server/config.ts
IDENTITY_DNS_TIMEOUT_MSint500 to 100002000not setnot setinterfaces/web/src/lib/server/config.ts
DID_DOC_CACHE_TTL_Sint1 to 3600300not setnot setinterfaces/web/src/lib/server/config.ts
DID_DOC_CACHE_MAXint1 to 10000010000not setnot setinterfaces/web/src/lib/server/config.ts
HANDLE_VERIFY_TTL_Sint1 to 3600600not setnot setinterfaces/web/src/lib/server/config.ts
HANDLE_INVALID_TTL_Sint1 to 360060not setnot setinterfaces/web/src/lib/server/config.ts
HANDLE_CACHE_MAXint1 to 10000010000not setnot setinterfaces/web/src/lib/server/config.ts
OAUTH_CLIENT_KEYSsecretFilesee sourcerequiredsecret filesecret fileinfrastructure/pds/oauth/oauth-client.ts
OAUTH_ACTIVE_KIDstrtext (pattern in source)requiredfrom env file: WEB_OAUTH_ACTIVE_KIDfrom env file: WEB_OAUTH_ACTIVE_KIDinfrastructure/pds/oauth/oauth-client.ts
OAUTH_ALLOW_HTTPbooltrue or falsefalsenot setnot setinfrastructure/pds/oauth/oauth-client.ts
PDS_HOSTNAMEstrtext (pattern in source)requiredfrom env file: PDS_HOSTNAMEfrom env file: PDS_HOSTNAMEinterfaces/web/src/lib/server/config.ts
PDS_WEB_KEYsecretFileat least 64 bytesrequiredsecret filesecret fileinterfaces/web/src/lib/server/config.ts
HANDLE_SUFFIXstrtext (pattern in source)requiredfrom env file: PDS_SERVICE_HANDLE_DOMAINSfrom env file: PDS_SERVICE_HANDLE_DOMAINSinterfaces/web/src/lib/server/config.ts
EMAIL_RECHECK_Sint60 to 900900not setnot setinterfaces/web/src/lib/server/config.ts
MIN_AGEint16 to 12016not setnot setinterfaces/web/src/lib/server/config.ts
INVITE_COUNTRY_RULEoneOfon, offonnot setnot setinterfaces/web/src/lib/server/config.ts
PDS_ADMIN_URLoriginhttp: or https:requiredhttp://pds-admin:8080http://pds-admin:8080interfaces/web/src/lib/server/config.ts
PDS_ADMIN_WEB_KEYsecretFileat least 64 bytesrequiredsecret filesecret fileinterfaces/web/src/lib/server/config.ts
PDS_ADMIN_WEB_KIDstrtext (pattern in source)requiredfrom env file: WEB_PDS_ADMIN_KIDfrom env file: WEB_PDS_ADMIN_KIDinterfaces/web/src/lib/server/config.ts
PDS_DIDstrtext (pattern in source)requiredfrom env file: PDS_DIDfrom env file: PDS_DIDinterfaces/web/src/lib/server/config.ts
INVITE_REQUESTSoneOfon, offoffnot setnot setinterfaces/web/src/lib/server/config.ts
INVITE_REQUEST_SMTP_URLsecretFileat least 16 bytesoptionalnot setnot setinterfaces/web/src/lib/server/config.ts
INVITE_REQUEST_TOsecretFileat least 6 bytesoptionalnot setnot setinterfaces/web/src/lib/server/config.ts
INVITE_REQUEST_FROMstrtext (pattern in source)(empty)not setnot setinterfaces/web/src/lib/server/config.ts
OBJECT_STORE_URLoriginhttp: or https:requiredhttp://objects:8333http://objects:8333interfaces/web/src/lib/server/config.ts
OBJECT_STORE_BUCKETstrtext (pattern in source)requiredunset-privateunset-privateinterfaces/web/src/lib/server/config.ts
OBJECT_STORE_ACCESS_IDstrtext (pattern in source)requiredunset-webunset-webinterfaces/web/src/lib/server/config.ts
OBJECT_STORE_SECRETsecretFileat least 32 bytesrequiredsecret filesecret fileinterfaces/web/src/lib/server/config.ts
REVIEW_URLoriginhttp:requiredhttp://review:8082http://review:8082interfaces/web/src/lib/server/config.ts
SEARCH_LISTINGoneOfon, offoffoffoffinterfaces/web/src/lib/server/config.ts
PRIVACY_OFFICER_TITLEstrtext (pattern in source)required[to fill: PRIVACY_OFFICER_TITLE]Privacy Officerinterfaces/web/src/lib/server/legal.ts
PRIVACY_OFFICER_CONTACTstrtext (pattern in source)required[to fill: PRIVACY_OFFICER_CONTACT]contact@staging.unset.shinterfaces/web/src/lib/server/legal.ts
SUPPORT_EMAILstrtext (pattern in source)required[to fill: SUPPORT_EMAIL]support@staging.unset.shinterfaces/web/src/lib/server/legal.ts
SECURITY_CONTACTstrtext (pattern in source)requiredprivacy-pageprivacy-pageinterfaces/web/src/lib/server/legal.ts
SECURITY_TXT_EXPIRESstrtext (pattern in source)required2027-10-01T00:00:00Z2027-10-01T00:00:00Zinterfaces/web/src/lib/server/legal.ts
TEST_ROUTESbooltrue or falsefalsenot setnot setinterfaces/web/src/lib/server/config.ts

indexer

KeyKindAllowedDefaultlocalstagingDefined in
UNSET_ENVoneOfdev, test, prodrequireddevdevshared/config/schema.ts
UNSET_SERVICEoneOfhttp, admin, api, indexer, media, review, jobs, audit-verify, chat-authrequiredindexerindexershared/config/schema.ts
UNSET_COMMITstrtext (pattern in source)required00000000000000000000000000000000000000000000000000000000000000000000000000000000shared/config/schema.ts
LISTEN_PORTint1024 to 65535required80818081shared/config/schema.ts
PG_HOSTstrtext (pattern in source)requiredpostgrespostgresinfrastructure/postgres/config.ts
PG_PORTint1 to 655355432not setnot setinfrastructure/postgres/config.ts
PG_DATABASEstrtext (pattern in source)requiredunsetunsetinfrastructure/postgres/config.ts
PG_USERstrtext (pattern in source)requiredindexerindexerinfrastructure/postgres/config.ts
PG_PASSWORDsecretFileat least 16 bytesrequiredsecret filesecret fileinfrastructure/postgres/config.ts
PG_SSLMODEoneOfdisable, verify-fullrequireddisabledisableinfrastructure/postgres/config.ts
PG_SSLROOTCERTstrtext (pattern in source)(empty)not setnot setinfrastructure/postgres/config.ts
PG_POOL_MAXint1 to 50required33infrastructure/postgres/config.ts
PG_CONNECT_TIMEOUT_MSint100 to 100002000not setnot setinfrastructure/postgres/config.ts
PG_MAX_REPLICASint1 to 43not setnot setinfrastructure/postgres/config.ts
NETGUARD_INTERNAL_HOSTSlistcomma-separated str(empty list)not setnot setshared/config/netGuard.ts
NETGUARD_ALLOW_LOOPBACKbooltrue or falsefalsenot setnot setshared/config/netGuard.ts
PLC_URLurlhttps:requiredhttps://plc.directoryhttps://plc.directoryinterfaces/indexer/config.ts
IDENTITY_HTTP_TIMEOUT_MSint500 to 100003000not setnot setinterfaces/indexer/config.ts
IDENTITY_DNS_TIMEOUT_MSint500 to 100002000not setnot setinterfaces/indexer/config.ts
DID_DOC_CACHE_TTL_Sint1 to 3600300not setnot setinterfaces/indexer/config.ts
DID_DOC_CACHE_MAXint1 to 10000010000not setnot setinterfaces/indexer/config.ts
INDEXER_ENABLEDbooltrue or falsefalsetruetrueinterfaces/indexer/config.ts
INDEXER_PDS_URLurlhttp: or https:requiredhttp://pds:3000http://pds:3000interfaces/indexer/config.ts
PDS_PUBLIC_URLurlhttps:requiredfrom env file: PDS_PUBLIC_URLfrom env file: PDS_PUBLIC_URLinterfaces/indexer/config.ts
INDEXER_PASS_INTERVAL_MSint1000 to 30000010000not setnot setinterfaces/indexer/config.ts
INDEXER_PASS_OVERDUE_MSint300000 to 864000001800000not setnot setinterfaces/indexer/config.ts
INDEXER_TIMEOUT_MSint500 to 300005000not setnot setinterfaces/indexer/config.ts
INDEXER_REPO_TIMEOUT_MSint1000 to 12000030000not setnot setinterfaces/indexer/config.ts
INDEXER_REPO_MAX_BYTESint1048576 to 6710886433554432not setnot setinterfaces/indexer/config.ts
INDEXER_RESTART_DELAY_MSint100 to 600001000not setnot setinterfaces/indexer/config.ts
INDEXER_MAX_RESTART_DELAY_MSint1000 to 60000060000not setnot setinterfaces/indexer/config.ts
HEALTH_PORTint1024 to 655358081not setnot setinterfaces/indexer/config.ts
INDEXER_STREAM_UNHEALTHY_MSint60000 to 3600000300000not setnot setinterfaces/indexer/config.ts
INDEXER_SHUTDOWN_GRACE_MSint1000 to 90008000not setnot setinterfaces/indexer/config.ts
HOSTED_HANDLE_SUFFIXESlistcomma-separated strrequiredfrom env file: PDS_SERVICE_HANDLE_DOMAINSfrom env file: PDS_SERVICE_HANDLE_DOMAINSinterfaces/indexer/config.ts
HANDLE_RECHECK_Sint600 to 60480086400not setnot setinterfaces/indexer/config.ts

migrate

KeyKindAllowedDefaultlocalstagingDefined in
UNSET_ENVoneOfdev, test, prodrequireddevdevinfrastructure/postgres/migrate-cli.ts
UNSET_COMMITstrtext (pattern in source)required00000000000000000000000000000000000000000000000000000000000000000000000000000000infrastructure/postgres/migrate-cli.ts
PG_HOSTstrtext (pattern in source)requiredpostgrespostgresinfrastructure/postgres/config.ts
PG_PORTint1 to 655355432not setnot setinfrastructure/postgres/config.ts
PG_DATABASEstrtext (pattern in source)requiredunsetunsetinfrastructure/postgres/config.ts
PG_USERstrtext (pattern in source)requiredmigratormigratorinfrastructure/postgres/config.ts
PG_PASSWORDsecretFileat least 16 bytesrequiredsecret filesecret fileinfrastructure/postgres/config.ts
PG_SSLMODEoneOfdisable, verify-fullrequireddisabledisableinfrastructure/postgres/config.ts
PG_SSLROOTCERTstrtext (pattern in source)(empty)not setnot setinfrastructure/postgres/config.ts

rewrap

KeyKindAllowedDefaultlocalstagingDefined in
UNSET_ENVoneOfdev, test, prodrequirednot in this stacknot in this stackinfrastructure/postgres/rewrap-cli.ts
UNSET_COMMITstrtext (pattern in source)requirednot in this stacknot in this stackinfrastructure/postgres/rewrap-cli.ts
PG_HOSTstrtext (pattern in source)requirednot in this stacknot in this stackinfrastructure/postgres/config.ts
PG_PORTint1 to 655355432not in this stacknot in this stackinfrastructure/postgres/config.ts
PG_DATABASEstrtext (pattern in source)requirednot in this stacknot in this stackinfrastructure/postgres/config.ts
PG_USERstrtext (pattern in source)requirednot in this stacknot in this stackinfrastructure/postgres/config.ts
PG_PASSWORDsecretFileat least 16 bytesrequirednot in this stacknot in this stackinfrastructure/postgres/config.ts
PG_SSLMODEoneOfdisable, verify-fullrequirednot in this stacknot in this stackinfrastructure/postgres/config.ts
PG_SSLROOTCERTstrtext (pattern in source)(empty)not in this stacknot in this stackinfrastructure/postgres/config.ts
SEAL_KEYRINGsecretFilesee sourcerequirednot in this stacknot in this stackinfrastructure/seal/keyring.ts

pds-admin

KeyKindAllowedDefaultlocalstagingDefined in
PDS_ADMIN_ENVstrtextrequireddevdevinterfaces/pds-admin/config.ts
PDS_DIDstrtextrequiredfrom env file: PDS_DIDfrom env file: PDS_DIDinterfaces/pds-admin/config.ts
PDS_INTERNAL_URLstrtextrequiredhttp://pds:3000http://pds:3000interfaces/pds-admin/config.ts
SIGNUPS_OPENstrtextrequiredtruetrueinterfaces/pds-admin/config.ts
PDS_ADMIN_SECRETS_DIRstrtext/run/secretsnot setnot setinterfaces/pds-admin/config.ts
pds_admin_log_keysecretFilefilerequiredsecret filesecret fileinterfaces/pds-admin/config.ts
INVITE_WINDOW_HOURSint1 to 72024not setnot setinterfaces/pds-admin/config.ts
INVITE_MAX_PER_WINDOWint1 to 10005not setnot setinterfaces/pds-admin/config.ts
INVITE_MAX_PER_DAY_GLOBALint1 to 100000100not setnot setinterfaces/pds-admin/config.ts
STATE_DIRstrtextrequired/app/state/app/stateinterfaces/pds-admin/config.ts
PORTint1 to 65535808080808080interfaces/pds-admin/config.ts
COMMITstrtextunknownnot setnot setinterfaces/pds-admin/config.ts
pds_admin_passwordsecretFilefilerequiredsecret filesecret fileinterfaces/pds-admin/config.ts
pds_admin_keyssecretFilefilerequiredsecret filesecret fileinterfaces/pds-admin/config.ts

Other services

Services we run as shipped or without a settings schema: the keys each stack sets.

edge

Keylocalstaging
ACME_EMAILfrom env file: EDGE_ACME_EMAILfrom env file: EDGE_ACME_EMAIL
APP_HOSTfrom env file: APP_HOSTfrom env file: APP_HOST
APP_UPSTREAMweb:8080web:8080
DOCS_HOSTnot setdocs.unset.sh
PDS_HOSTfrom env file: PDS_HOSTNAMEfrom env file: PDS_HOSTNAME
PDS_UPSTREAMpds:3000pds:3000

newt

Keylocalstaging
CONFIG_FILEnot in this stackfile /tmp/newt.json
DISABLE_CLIENTSnot in this stacktrue
DISABLE_SSHnot in this stacktrue
LOG_LEVELnot in this stackWARN
NEWT_METRICS_PROMETHEUS_ENABLEDnot in this stackfalse
NEWT_PPROF_ENABLEDnot in this stackfalse

objects

None.

pds

Keylocalstaging
LOG_ENABLEDfalsefalse
NODE_EXTRA_CA_CERTS/etc/unset-dev-trust/root.pemnot set
NODE_OPTIONS--max-old-space-size=768--max-old-space-size=768
PDS_BLOBSTORE_S3_BUCKETunset-pdsunset-pds
PDS_BLOBSTORE_S3_ENDPOINThttp://objects:8333http://objects:8333
PDS_BLOBSTORE_S3_FORCE_PATH_STYLEtruetrue
PDS_BLOBSTORE_S3_REGIONus-east-1us-east-1
PDS_BLOB_UPLOAD_LIMIT52428805242880
PDS_CRAWLERS(empty)(empty)
PDS_DATA_DIRECTORY/home/node/home/node
PDS_DID_PLC_URLhttps://plc.directoryhttps://plc.directory
PDS_EMAIL_DISABLE_CONFIRMATION_LINKtruetrue
PDS_EMAIL_FROM_ADDRESSnot setnoreply@staging.unset.sh
PDS_HOSTNAMEfrom env file: PDS_HOSTNAMEfrom env file: PDS_HOSTNAME
PDS_INVITE_REQUIREDtruetrue
PDS_MODERATION_EMAIL_ADDRESSnot setmoderation@staging.unset.sh
PDS_PORT30003000
PDS_RATE_LIMITS_ENABLEDfalsefalse
PDS_SERVICE_HANDLE_DOMAINSfrom env file: PDS_SERVICE_HANDLE_DOMAINSfrom env file: PDS_SERVICE_HANDLE_DOMAINS

pds-token-reader

None.

postgres

Keylocalstaging
POSTGRES_PASSWORD_FILEfile /run/secrets/pg_superuser_passwordfile /run/secrets/pg_superuser_password

review

Keylocalstaging
LISTEN_PORT80828082
UNSET_COMMIT00000000000000000000000000000000000000000000000000000000000000000000000000000000
UNSET_ENVdevdev
UNSET_SERVICEreviewreview