From c6b263bb7047ed3a8ad9a520a1ebd12a958c12b7 Mon Sep 17 00:00:00 2001 From: ychung-mot Date: Wed, 4 Dec 2024 12:22:58 -0800 Subject: [PATCH] doc: environment variables for server --- server/README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 server/README.md diff --git a/server/README.md b/server/README.md new file mode 100644 index 00000000..cb982663 --- /dev/null +++ b/server/README.md @@ -0,0 +1,60 @@ +# Environment Variables + +For actual values, refer to the [gitops repo](https://github.com/bcgov-c/tenant-gitops-b0471a/tree/develop/deploy) or the [vault](https://vault.developer.gov.bc.ca/ui/vault/auth?namespace=platform-services&with=oidc) + +## Keycloak + +* SSO_AUTHORITY: +* SSO_CLIENT: + +## Common Hosted Email Service (CHES) + +* CHES_TOKEN_URL: +* CHES_URL: +* CHES_ID: +* CHES_SECRET: + +## Database + +* DB_NAME: +* DB_HOST: +* DB_USER: +* DB_PASS: +* DB_PORT: + +## Maximum File Size in MB + +* RENTAL_LISTING_REPORT_MAX_SIZE: +* BUISINESS_LICENCE_MAX_SIZE: + +## Service Account for BCeID web service + +* SA_USER: +* SA_PASS: + +## BCeID web service + +* BCEID_URL: +* BCEID_OSID: +* BCEID_CACHE_LIFESPAN: + +## App base URL for hyper link in email + +* APP_BASE_URL: + +## Email Addresses + +* ADMIN_EMAIL: +* STR_NOTICE_EMAIL: +* STR_DATA_EMAIL: +* STR_CEU_EMAIL: + +## Geocoder + +* GEOCODER_URL: +* GEOCODER_API_KEY: + +## API Gateway + +* APS_AUTHORITY: +* APS_GW_JWT_JWKS_URL: