-
Notifications
You must be signed in to change notification settings - Fork 28
Advanced Installation
SORMAS allows some customization to its application.
Most settings can by modifiyng the content of the .env file.
If you would like to run SORMAS using your own host name (e.g. https://sormas.example.com) , please follow these steps:
- Obtain a certificate and private key for the chosen host name using e.g. LetsEncrypt
- Copy the certificate file (e.g. fullchain.pem if you use letsencrpyt) to the ./apache2/certs directory using these filenames:
- [hostname].crt for the certificate file (e.g. sormas.example.com.crt)
- [hostname].key for the private key file (e.g. sormas.example.com.key)
- set the environment variable SORMAS_SERVER_URL to the hostname you have chosen
- make sure dns resolves to the host name you have chosen
SORMAS_POSTGRES_USER User for the SORMAS databases
SORMAS_POSTGRES_PASSWORD Password for this user
DB_NAME Name of the database for the SORMAS data
DB_NAME_AUDIT Name of the database for SORMAS audit data
DB_HOST Hostname or IP of the database host (with docker-compose, this should be postgres)
DB_JDBC_MAXPOOLSIZE Sets the maximum number of database connections
SORMAS_VERSION Version of SORMAS that should be installed (Dockerimages are provided starting from the Version 1.33.0)
SORMAS_DOCKER_VERSION Version of docker images (see https://github.com/hzi-braunschweig/SORMAS-Docker/releases for all release)
SORMAS_SERVER_URL URL under which the SORMAS installation should be accessed
DOMAIN_NAME Name of the Domain in the Payara Server
LOCALE Default language of the SORMAS server. This impacts both the language that SORMAS is displayed in as well as e.g. date formats.
EPIDPREFIX SORMAS automatically generates EPID numbers for new cases. This is the prefix your country is using for all of these numbers. Most of the time it will be some sort of country code and should be three characters long.
MAIL_HOST Hostname or IP of the SMTP host
SEPARATOR The separator that CSV files should use to separate columns. This is depending on your server locale. Most systems should be fine using the default (,), but e.g. German systems should be set to use ;.
EMAIL_SENDER_ADDRESS email from which the mail is going to be send
EMAIL_SENDER_NAME Name of the sender of the email
LATITUDE Latitude of the map center. Should be the latitude of the region/country you're using SORMAS in.
LONGITUDE Longitude of the map center. Should be the longitude of the region/country you're using SORMAS in.
MAP_ZOOM The default zoom level of the map on the dashboard
SORMAS_PATH Path on dockerhost to store the Docker volumes
TZ The timezone to choose (available timezones can be found here: https://nodatime.org/TimeZones)
DEVMODE Enabling developer mode will give you access to a tab in the Configuration menu that allows admins to create dummy cases and contacts to quickly fill the database. This is only meant to be used on development or demo systems and should be left disabled for production servers.
JSON_LOGGING Change the output of sormas server.log to JSON format
PROMETHEUS_SERVERS One or more ip-addresses of prometheus monitoring servers (to scrape metrics from payara) seperated by spaces. If you don't have one, just leave it at 127.0.0.1. The metrics page will be available via https://<SORMAS_SERVER_URL>/metrics
CUSTOMBRANDING_ENABLED Enables the custombranding feature
CUSTOMBRANDING_NAME Name of the custombranding
CUSTOMBRANDING_LOGO_PATH Path to the custom logo
CUSTOMBRANDING_USE_LOGINSIDEBAR Enables the customization of the loginsidebar
CUSTOMBRANDING_LOGINBACKGROUND_PATH Path to the custom loginsidebar image
SORMAS2SORMAS_ENABLED Enables the "Sormas to Sormas" feature
SORMAS2SORMAS_KEYALIAS Alias of the key
SORMAS2SORMAS_KEYSTORENAME Name of the used keystore
SORMAS2SORMAS_KEYPASSWORD Password for the keystore
SORMAS2SORMAS_TRUSTSTORENAME Name of the truststore
SORMAS2SORMAS_TRUSTSTOREPASSWORD Password for the truststore
SORMAS2SORMAS_DIR Path to the sormas to sormas directory
SORMAS_ORG_ID ID of the organisiation
SORMAS_ORG_NAME Name of the organisation
SORMAS_S2S_CERT_PASS Password for the certificate
SORMAS_S2S_REST_PASSWORD Password for the rest user to connect to sormas
NOTE For all configuration options below, memory should be given as a positive integer number followed by an upper-case "M" - for example 1000M. CPU counts should be given as a floating point value with the dot ( . ) as decimal separator, for example "2.5".
APPSERVER_JVM_MAX Maximum heap space to be used for the java application server used by SORMAS. (For example 4096M for 4096MB)
APPSERVER_MEM Maximum available memory for SORMAS application server. Should be set to be at least 150 MB above SORMAS_JVM_MAX. (For example 4300M for 4300MB)
APPSERVER_MEM_RESERVED Memory reserved for SORMAS application server. This memory may not be used by other processes on the same host. (For example 4300M for 4300MB)
APPSERVER_CPUS CPU cores reserved for the SORMAS java application server. This should be a floating point value. (Example: 2.0)
WEBSERVER_MEM Maximum available memory for the used web server. (For example 1000M for 1000MB)
WEBSERVER_MEM_RESERVED Memory reserved for the used web server. This memory may not be used by other processes on the same host. (For example 400M for 400MB)
WEBSERVER_CPUS CPU cores reserved for the used web server. This should be a floating point value. (Example: 2.0)
DB_MEM Maximum available memory for the used database server. (For example 3000M for 3000MB)
DB_MEM_RESERVED Memory reserved for the used database server. This memory may not be used by other processes on the same host. (For example 2500M for 2500MB)
DB_CPUS CPU cores reserved for the used web server. This should be a floating point value. (Example: 3.0 )
DB_DUMP_MEM Maximum available memory for the database dump tool. (For example 500M for 500MB)
DB_DUMP_MEM_RESERVED Memory reserved for the database dump tool. This memory may not be used by other processes on the same host. (For example 100M for 100MB)
DB_DUMP_CPUS CPU cores reserved for the used web server. This should be a floating point value. (Example: 0.5 )