Applies to:
reference, configuration, docker-compose-configuration
ENV file format
This .env-file is mainly used toghether with its corresponding docker-compose.yml located in the same folder.
General Configuration Variables
| Name |
Type |
Description |
| DEPLOY_ENVIRONMENT |
string |
Deployment environment identifier, typically “mops” |
| SERVER |
string |
Windows Server version. Typically W2019, W2022 or newer. |
| DB_PORT |
int |
Port for the database connection. Typically 5432. |
| MQTT_TCP |
int |
Port for MQTT over TCP. Default is 1883. |
| MQTT_WS |
int |
Port for MQTT over WebSocket. Default is 9001. |
| INGRESS_PORT |
int |
Port for external ingress to the application. Typically 80 |
| INGRESS_ADMINUI_PORT |
int |
Port for admin UI ingress. Typically 180 |
| SUBNET |
int |
1 of 4 subnet part of the subnet mask. Typically the 2nd octet |
| DNS_SERVERS |
string |
List of DNS server IPs separated by commas. |
| DBNET_EXTERNAL |
boolean |
Indicates whether the database network is external. Defaults to false. |
| COMPOSE_PROFILES |
boolean |
Enables or disables Docker Compose profiles |
|
|
|
General Configuration Variables Example
DEPLOY_ENVIRONMENT=mops
SERVER=W2022
DB_PORT=5432
MQTT_TCP=1883
MQTT_WS=9001
INGRESS_PORT=80
INGRESS_ADMINUI_PORT=180
SUBNET=19
DNS_SERVERS=10.127.35.5,10.1.16.11,10.0.51.84
DBNET_EXTERNAL=false
COMPOSE_PROFILES=true
| Name |
Type |
Description |
| LOC_IMAGE |
string |
Image tag for the LOC container |
| MOPS_FILE_SERVER_IMAGE |
string |
Image tag for the MOPS file server container |
| BINDER_IMAGE |
string |
Image tag for the Binder container |
| SHELL_IMAGE |
string |
Image tag for the Shell container |
| DISPLAY_IMAGE |
string |
Image tag for the Display container |
| COMPONENTS_IMAGE |
string |
Image tag for the UI components container |
| CMS_IMAGE |
string |
Image tag for the CMS container |
| EVENTBROKER_IMAGE |
string |
Image tag for the Event Broker container |
| KEYCLOAK_IMAGE |
string |
Image tag for the Keycloak container |
LOC_IMAGE=:v2.1.5
MOPS_FILE_SERVER_IMAGE=:v2.1.5
BINDER_IMAGE=:v2.1.5
SHELL_IMAGE=:v2.1.5
DISPLAY_IMAGE=:v2.1.5
COMPONENTS_IMAGE=:v2.1.5
DIR_IMAGE=:v2.1.5
CMS_IMAGE=:v2.1.5
INFOSCREEN_IMAGE=:v2.1.5
CMS_NOTIF_IMAGE=:v2.1.5
CMS_LOGCHANNEL_IMAGE=:v2.1.5
EVENTBROKER_IMAGE=:v2.1.5
CMS_EMAILCHANNEL_IMAGE=:v2.1.5
CMS_ALERTMGR_IMAGE=:v2.1.5
CMS_CONDITION_MONITOR_IMAGE=:v2.1.5
MOPSDIR_IMAGE=:v2.1.5
MOPSDD_IMAGE=:v2.1.5
MOPS_PGSQL_IMAGE=:v2.1.5
KEYCLOAK_IMAGE=:v2.1.5
Service Enablement Flags
| Name |
Type |
Description |
| ENABLED_TRAEFIK_IMAGE |
boolean |
Enables Traefik container image |
| ENABLED_LOC_IMAGE |
boolean |
Enables LOC container image |
| ENABLED_SHELL_IMAGE |
boolean |
Enables Shell container image |
| ENABLED_DISPLAY_IMAGE |
boolean |
Enables Display container image |
| ENABLED_INFOSCREEN_IMAGE |
boolean |
Enables Infoscreen container image |
| ENABLED_COMPONENTS_IMAGE |
boolean |
Enables UI Components container image |
| ENABLED_DIR_IMAGE |
boolean |
Enables Directory container image |
| ENABLED_CMS_IMAGE |
boolean |
Enables CMS container image |
| ENABLED_MOPSDIR_IMAGE |
boolean |
Enables MOPS Directory container image |
| ENABLED_MOPSDD_IMAGE |
boolean |
Enables MOPS Data Distribution container image |
| ENABLED_KEYCLOAK |
boolean |
Enables Keycloak container |
| ENABLED_BINDER_IMAGE |
boolean |
Enables Binder container image |
| ENABLED_EVENTBROKER_IMAGE |
boolean |
Enables Event Broker container image |
| ENABLED_CMS_NOTIF_IMAGE |
boolean |
Enables CMS Notifications container image |
| ENABLED_CMS_LOGCHANNEL_IMAGE |
boolean |
Enables CMS Log Channel container image |
| ENABLED_CMS_EMAILCHANNEL_IMAGE |
boolean |
Enables CMS Email Channel container image |
| ENABLED_CMS_ALERTMGR_IMAGE |
boolean |
Enables CMS Alert Manager container image |
| ENABLED_CMS_CONDITION_MONITOR_IMAGE |
boolean |
Enables CMS Condition Monitor container image |
| ENABLED_MOPS_FILE_SERVERC_IMAGE |
boolean |
Enables MOPS File Server container image |
| ENABLED_KEYCLOAK_IMAGE |
boolean |
Enables Keycloak container image |
| ENABLED_DB |
boolean |
Enables database container |
|
|
|
Service Enablement Flags Example
ENABLED_TRAEFIK_IMAGE=true
ENABLED_LOC_IMAGE=true
ENABLED_SHELL_IMAGE=true
ENABLED_DISPLAY_IMAGE=true
ENABLED_INFOSCREEN_IMAGE=true
ENABLED_COMPONENTS_IMAGE=true
ENABLED_DIR_IMAGE=true
ENABLED_CMS_IMAGE=false
ENABLED_MOPSDIR_IMAGE=true
ENABLED_MOPSDD_IMAGE=true
ENABLED_KEYCLOAK=true
ENABLED_BINDER_IMAGE=true
ENABLED_EVENTBROKER_IMAGE=true
ENABLED_CMS_NOTIF_IMAGE=false
ENABLED_CMS_LOGCHANNEL_IMAGE=false
ENABLED_CMS_EMAILCHANNEL_IMAGE=false
ENABLED_CMS_ALERTMGR_IMAGE=false
ENABLED_CMS_CONDITION_MONITOR_IMAGE=false
ENABLED_MOPS_FILE_SERVERC_IMAGE=true
ENABLED_KEYCLOAK_IMAGE=true
ENABLED_DB=true
Registry URLs for Containers
| Name |
Type |
Description |
| CMS_CONDITION_MONITOR_REGISTRY |
string |
Registry URL for the CMS condition monitor container |
| TRAEFIK_REGISTRY |
string |
Registry URL for the Traefik container |
| CMS_EMAILCHANNEL_REGISTRY |
string |
Registry URL for the CMS email channel container |
| COMPONENTS_REGISTRY |
string |
Registry URL for UI components container |
| MOPSDIR_REGISTRY |
string |
Registry URL for the MOPS directory container |
| DISPLAY_REGISTRY |
string |
Registry URL for the Display container |
| CMS_REGISTRY |
string |
Registry URL for the CMS container |
| MOPS_FILE_SERVER_REGISTRY |
string |
Registry URL for the MOPS file server container |
| MOPS_PGSQL_REGISTRY |
string |
Registry URL for the PostgreSQL container |
| INFOSCREEN_REGISTRY |
string |
Registry URL for the Infoscreen container |
| CMS_ALERTMGR_REGISTRY |
string |
Registry URL for the CMS Alert Manager container |
| MOPSDD_REGISTRY |
string |
Registry URL for the MOPS Data Distribution container |
| EVENTBROKER_REGISTRY |
string |
Registry URL for the Event Broker container |
| LOC_REGISTRY |
string |
Registry URL for the LOC container |
| CMS_LOGCHANNEL_REGISTRY |
string |
Registry URL for the CMS Log Channel container |
| DIR_REGISTRY |
string |
Registry URL for the Directory container |
| SHELL_REGISTRY |
string |
Registry URL for the Shell container |
| CMS_NOTIF_REGISTRY |
string |
Registry URL for the CMS Notification container |
| BINDER_REGISTRY |
string |
Registry URL for the Binder container |
| KEYCLOAK_REGISTRY |
string |
Registry URL for the Keycloak container |
.ENV file example:
Registry URLs for Containers Example
CMS_CONDITION_MONITOR_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-cms-conditionmonitor
TRAEFIK_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-nginx
CMS_EMAILCHANNEL_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-cms-emailchannel
COMPONENTS_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-components
MOPSDIR_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-dir
DISPLAY_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-display
CMS_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-cms
MOPS_FILE_SERVER_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-serve
MOPS_PGSQL_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-pgsql
INFOSCREEN_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-infoscreen
CMS_ALERTMGR_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-cms-alertmgr
MOPSDD_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-dd
EVENTBROKER_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-event-broker
LOC_REGISTRY=registry.mopssys.com/mops-4.0/projects/mops-loc
CMS_LOGCHANNEL_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-cms-logchannel
DIR_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-dir
SHELL_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-ui-shell
CMS_NOTIF_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-cms-notif
BINDER_REGISTRY=registry.mopssys.com/mops-4.0/containers/mops-binder
KEYCLOAK_REGISTRY=registry.mopssys.com/mops-4.0/containers/openidserver
