Environment¶

wis2box initializes the environment when starting, before data processing or publishing. To view the environment, run the following command:

wis2box environment show

For the purposes of documentation, the value WIS2BOX_DATADIR represents the base directory for all data managed in wis2box.

The default enviroment variables are below.

# data paths and retention
WIS2BOX_DATADIR=/data/wis2box

# API
WIS2BOX_API_TYPE=pygeoapi
WIS2BOX_API_URL=http://localhost/oapi
WIS2BOX_API_BACKEND_TYPE=Elasticsearch
WIS2BOX_API_BACKEND_URL=http://elasticsearch:9200
WIS2BOX_DOCKER_API_URL=http://wis2box-api:80/oapi

# csv2bufr transformation 
WIS2BOX_OBSERVATION_DISTANCE_THRESHOLD=1000

# logging
WIS2BOX_LOGGING_LOGLEVEL=ERROR
WIS2BOX_LOGGING_LOGFILE=stdout

# Pub/Sub
WIS2BOX_BROKER_USERNAME=wis2box
WIS2BOX_BROKER_PASSWORD=wis2box
WIS2BOX_BROKER_HOST=mosquitto
WIS2BOX_BROKER_PORT=1883
WIS2BOX_BROKER_QUEUE_MAX=1000

WIS2BOX_BROKER_PUBLIC=mqtt://wis2box:wis2box@mosquitto:1883

# Web application
WIS2BOX_BASEMAP_URL=https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
WIS2BOX_BASEMAP_ATTRIBUTION=<a href="https://osm.org/copyright">OpenStreetMap</a> contributors

# contact identification
# WIS2BOX_ICON=https://example.org/icon
# WIS2BOX_LOGO=https://example.org/logo
# WIS2BOX_IDENTIFICATION_TITLE=title
# WIS2BOX_IDENTIFICATION_DESCRIPTION=description
# WIS2BOX_IDENTIFICATION_TERMS_OF_SERVICE=CC-BY 4.0
# WIS2BOX_IDENTIFICATION_URL=https://example.org/tos
# WIS2BOX_LICENSE_NAME=CC-BY 4.0
# WIS2BOX_LICENSE_URL=https://creativecommons.org/licenses/by/4.0
# WIS2BOX_PROVIDER_NAME=Firstname Lastname
# WIS2BOX_PROVIDER_URL=https://example.org/provider
# WIS2BOX_CONTACT_NAME=Firstname Lastname
# WIS2BOX_CONTACT_POSITION=staff
# WIS2BOX_CONTACT_ADDRESS=123 Main street
# WIS2BOX_CONTACT_CITY=city
# WIS2BOX_CONTACT_POSTALCODE=postal code
# WIS2BOX_CONTACT_COUNTRY=country
# WIS2BOX_CONTACT_EMAIL=you@example.org
# WIS2BOX_CONTACT_URL=https://example.org/contact
# WIS2BOX_CONTACT_INSTRUCTIONS=contact instructions
# WIS2BOX_CONTACT_ROLE=host

# Admin UI
WIS2BOX_UI_ADMIN_BASEURL=/admin

# other
WIS2BOX_URL=http://localhost

# access control
WIS2BOX_AUTH_URL=http://wis2box-auth

# storage
WIS2BOX_STORAGE_TYPE=S3
WIS2BOX_STORAGE_SOURCE=http://minio:9000
# storage username should be 3 or more characters
WIS2BOX_STORAGE_USERNAME=minio
# storage password should be 8 or more characters
WIS2BOX_STORAGE_PASSWORD=minio123
WIS2BOX_STORAGE_INCOMING=wis2box-incoming
WIS2BOX_STORAGE_PUBLIC=wis2box-public
WIS2BOX_STORAGE_DATA_RETENTION_DAYS=7
WIS2BOX_STORAGE_API_RETENTION_DAYS=7

# you should be okay from here

# MinIO
MINIO_ROOT_USER=${WIS2BOX_STORAGE_USERNAME}
MINIO_ROOT_PASSWORD=${WIS2BOX_STORAGE_PASSWORD}
MINIO_PROMETHEUS_AUTH_TYPE=public
MINIO_NOTIFY_MQTT_ENABLE_WIS2BOX=on
MINIO_NOTIFY_MQTT_USERNAME_WIS2BOX=${WIS2BOX_BROKER_USERNAME}
MINIO_NOTIFY_MQTT_PASSWORD_WIS2BOX=${WIS2BOX_BROKER_PASSWORD}
MINIO_NOTIFY_MQTT_BROKER_WIS2BOX=tcp://${WIS2BOX_BROKER_HOST}:${WIS2BOX_BROKER_PORT}
MINIO_NOTIFY_MQTT_TOPIC_WIS2BOX=wis2box/storage
MINIO_NOTIFY_MQTT_QOS_WIS2BOX=1

# downloader settings
DOWNLOAD_BROKER_HOST=globalbroker.meteo.fr
DOWNLOAD_BROKER_PORT=443
DOWNLOAD_BROKER_USERNAME=everyone
DOWNLOAD_BROKER_PASSWORD=everyone
# download transport mechanism (tcp or websockets)
DOWNLOAD_BROKER_TRANSPORT=websockets
# maximum MB in download directory
DOWNLOAD_MIN_FREE_SPACE_GB=1

WIS2 in a box

Environment¶