Skip to content

Environment Variables

Jump to bottom
Slin Lee edited this page Mar 23, 2021 · 13 revisions

Environment Variables (alphabetical order)

These are the environment variables used for the development environment

https://github.com/SkymindIO/pathmind-webapp/wiki/Env-variables-for-the-Updater,-Punctuator-and-Webapp

  • Required: Indicates if this needs to be set in the developer's environment for the system to run. If it's not required it's either because it's optional OR it's been defaulted.
  • Defaulted: Indicates if the environment variable has a default value in the configuration.
Environment Variable Required Defaulted Description
AWS_ACCESS_KEY_ID true false Individual developer AWS access keys (provided by Dae)
AWS_DEFAULT_REGION true false Individual developer AWS default region (provided by Dae)
AWS_ENDPOINT_URL true false Individual developer AWS endpoint URL (provided by Dae)
AWS_SECRET_ACCESS_KEY true false Individual developer AWS secret access key (provided by Dae)
DB_URL true false Your local environment's database URL (which points to the postgresql Pathmind database. Most like in the format of: jdbc:postgresql://localhost/PATHMIND?user=[username]&password=[password]
ENVIRONMENT 🆕 true false prod, dev, test, staging - for creating URL like the policy server
JOB_MOCK_CYCLE false false Required when using the mock backend server. More details here. Should be set to 10. If set, the webapp will trigger the actual deployment of downstream training services but will rely on Mocked data. JOB_MOCK_CYCLE itself sets the frequency in seconds, in which the Mock server produces a new chunk of pre-recorded training data. Mock server is available on dev and test environments. Recommended setting JOB_MOCK_CYCLE=10
MIGRATE_DB false true #f03c15 PLEASE CONFIRM Determines if the liquibase database script should be applied on server startup or if it needs to be done manually. False means that the liquibase update script will NOT be run automatically on server startup.
MODEL_ANALYZER_URL false true #f03c15 PLEASE CONFIRM Defaulted to https://ma.devpathmind.com/
MULTI_AGENT false true Determines if we run the training with multi-agents or not. Defaulted to false.
NEW_RUN_DAILY_LIMIT false true Determines the maximum number of runs a user can execute in a single day. Defaulted to 100
NEW_RUN_MONTHLY_LIMIT false true Determines the maximum number of runs a user can execute in a month. Defaulted to 1000
NEW_RUN_NOTIFICATION_THRESHOLD false true The threshold (percentage) of which a user has to exceed for NEW_RUN_DAILY_LIMIT or NEW_RUN_MONTHLY_LIMIT after which we will send ourselves notifications by Segment to be able to further investigate. Defaulted to 90%
PATHMIND_DEV_MODE #f03c15 PLEASE CONFIRM IF THIS IS STILL USED. I don't believe it is
PATHMIND_STRIPE_PROFESSIONAL_PLAN_ID false true Needed to process payments
PATHMIND_STRIPE_PUBLIC_KEY false true Needed to process payments
PATHMIND_STRIPE_SECRET_KEY false true Needed to process payments
PATHMIND_UPLOAD_FILE_LIMIT false true #f03c15 PLEASE CONFIRM WHAT THIS DOES Maximum filesize for the policy upload. Defaulted to 200MB
PATHMIND_UPLOAD_REQUEST_LIMIT false true #f03c15 PLEASE CONFIRM WHAT THIS DOES Defaulted to 200MB
PATHMIND_WEBCLIENT_MAX false true #f03c15 PLEASE CONFIRM Webflux memory setting for web client. Defaulted to 5MB
PBT_RUN_ITERATIONS false 500 #f03c15 PLEASE CONFIRM
PBT_NUM_SAMPLES false 4 #f03c15 PLEASE CONFIRM
PBT_MAX_TIME_IN_SEC false 43200 #f03c15 PLEASE CONFIRM Max time for a training session to be allowed to run Defaulted to 12 hours
RESCALE_URL #f03c15 PLEASE CONFIRM IF THIS IS STILL USED. I don't believe it is
RESET_S3_BUCKET_ON_DATABASE_RESET false true Determines if the S3 bucket should be reset when setting up a new database in the liquibase script. Defaulted to false
S3_BUCKET true false Individual developer S3 buckets required to run experiments and runs (provided by Dae)
SEGMENT_SERVER_KEY false true Required to run Segment.
SEGMENT_WEBSITE_KEY false true Required to run Segment.
SIMULATION_METRICS false true Determines whether or not to show simulation metrics. Defaulted to false
SNS_UPDATER_SQS_FILTER_ATTR true false #f03c15 PLEASE CONFIRM WHAT THIS DOES
SNS_UPDATER_TOPIC_ARN true false #f03c15 PLEASE CONFIRM WHAT THIS DOES
SQS_UPDATER_PUNCTUATOR_QUEUE 🆕 https://github.com/SkymindIO/pathmind-webapp/wiki/Env-variables-for-the-Updater,-Punctuator-and-Webapp
SQS_UPDATER_URL true false #f03c15 PLEASE CONFIRM WHAT THIS DOES
SQS_URL true false #f03c15 PLEASE CONFIRM WHAT THIS DOES
SQS_POLICY_SERVER_URL 🆕 true false
WEBAPP_UPDATER_RATE_MSEC true false #f03c15 PLEASE CONFIRM WHAT THIS DOES Defaulted to 20000
WEBAPP_UPDATER_SQS_WAIT_SEC true false #f03c15 PLEASE CONFIRM WHAT THIS DOES Defaulted to 5

Clone this wiki locally