1. Environment Variables
The following environment variables can be used to configure the katapp backend.
| Name of the environment variable | Required | Default | Meaning and Usage |
|---|---|---|---|
| KATAPP_WS_PORT | NO | 9998 | specify the port of the WebSocket server, allowed values: 0, …, 65353 |
| KATAPP_HTTP_PORT | NO | 9997 | specify the port of the HTTP server, allowed values: 0, …, 65353 |
| KATAPP_STORE_DRIVER | NO | “DynamoDB” for aws deployment, “MongoDB” for other | specify the type of storage driver, allowed values: “MongoDB” or “DynamoDB” |
| KATAPP_STORE_ENDPOINT | YES | - | specify the endpoint of the blob storage |
| KATAPP_DATABASE_NAME | NO | - | specify the database name |
| KATAPP_BLOB_DRIVER | NO | “S3” for aws deployment, “MongoDB” for other | specify the blob storage driver, allowed values: “S3” or “MongoDB” |
| KATAPP_BLOB_ENDPOINT | YES | s | specify the endpoint of the blob storage |
| KATAPP_S3_BUCKET_NAME | NO | “katapp” | specify the name of the s3 storage bucket |
| KATAPP_WEBSOCKET_CONNECTION_URL | ONLY for AWS | - | specify the WebSocket connection url |
| KATAPP_TOKEN_SECRET | YES | - | specify the jwt token salt |
| KATAPP_STORE_USERS | YES | - | specify the store name of the user store |
| KATAPP_STORE_DEVICES | YES | - | specify the store name of the device store |
| KATAPP_STORE_TENANTS | YES | - | specify the store name of the tenant store |
| KATAPP_STORE_WEBSOCKET_CLIENTS | YES | - | specify the store name of the web socket client store |
| KATAPP_STORE_DISASTERS | YES | - | specify the store name of the disaster store |
| KATAPP_STORE_TRIAGES | YES | - | specify the store name of the triage store |
| KATAPP_STORE_PATIENTS | YES | - | specify the store name of the patient store |
| KATAPP_STORE_ROLES | YES | - | specify the store name of the role store |
| KATAPP_STORE_BILLING | YES | - | specify the store name of the billing store |
| KATAPP_ESTIMATED_COST_PER_API_GATEWAY_REQUEST | YES | - | specify the cost per request for the service: AWS API Gateway |
| KATAPP_ESTIMATED_COST_PER_WEB_SOCKET_REQUEST | YES | - | specify the cost per request for the service: AWS API Gateway WebSocket |
| KATAPP_ESTIMATED_COST_PER_LAMBDA_INVOCATION | YES | - | specify the cost per request for the service: AWS Lambda |
| KATAPP_ESTIMATED_COST_PER_DYNAMODB_READ | YES | - | specify the cost per read request for the service: AWS DynamoDB |
| KATAPP_ESTIMATED_COST_PER_DYNAMODB_WRITE | YES | - | specify the cost per write request for the service: AWS DynamoDB |
| KATAPP_ESTIMATED_COST_PER_S3_READ | YES | - | specify the cost per read request for the service: AWS S3 |
| KATAPP_ESTIMATED_COST_PER_S3_WRITE | YES | - | specify the cost per write request for the service: AWS S3 |
| KATAPP_API_STAGE | NO | “Unknown” | specify the api stage |
| KATAPP_API_VERSION | NO | “Unknown” | specify the api version |
| KATAPP_DEPLOYMENT_DATE | NO | “Unknown” | specify the deployment date |
| KATAPP_GIT_COMMIT_HASH | NO | “Unknown” | specify the git commit hash |
| KATAPP_GIT_COMMIT_DATE | NO | “Unknown” | specify the git commit date |
| KATAPP_GIT_COMMIT_TEXT | NO | “Unknown” | specify the git commit text |
| KATAPP_GIT_COMMIT_AUTHOR | NO | “Unknown” | specify the git commit author |
| KATAPP_GIT_BRANCH | NO | “Unknown” | specify the git branch |