You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With the provided Docker Compose files you can instantiate a deployment of the OpenWifi microservices and related components. The repository contains a self-signed certificate and a TIP-signed gateway certificate which are valid for the *.wlan.local domain. You also have the possibility to either generate and use Let's Encrypt certs or provide your own certificates. Furthermore the deployments are split by whether Traefik is used as a reverse proxy/load balancer in front of the microservices or if they are exposed directly on the host. The advantage of using the deployments with Traefik is that you can use Let's Encrypt certs (automatic certificate generation and renewal) and you have the ability to scale specific containers to multiple replicas.
The repository also contains a separate Docker Compose deployment to set up the OWLS microservice and related components for running a load simulation test against an existing controller.
Config files for the microservices are generated on every startup based on the environment variables in the microservice specific env files. For an overview of the supported configuration properties have a look into these files. For an explanation of the configuration properties please see the README in the respective microservice repository.
Be aware that local changes to the config files will be overwritten on every startup if TEMPLATE_CONFIG is set to true in the microservice env files. If you want to bind mount your own config file or make local changes, please set this variable to false.
Required password changing on the first startup
One important action that must be done before using the deployment is changing password for the default user in owsec as described in owsec docs. Please use these docs to find the actions that must be done after the deployment in order to start using your deployment.
Ports
Every OpenWifi service is exposed via a separate port either directly on the host or through Traefik. For an overview of the exposed ports have a look into the deployment specific Docker Compose file. If you use your own certificates, you can also configure different hostnames for the microservices.
Please note that the OWProv-UI is exposed on port 8080(HTTP)/8443(HTTPS) by default.
owsec templates and wwwassets
On the startup of owsec directories for wwwassets and mailer templates are created from the base files included in Docker image. After the initial startup you may edit those files as you wish in the owsec-data/persist directory.
PostgreSQL
PostgreSQL is used by default for the database for all components.
The following variables may be set in the env files. It is highly recommended that you change the DB passwords to some random string. The defaults are shown here.
owgw.env
Variable
Value/Description
STORAGE_TYPE
postgresql
STORAGE_TYPE_POSTGRESQL_HOST
postgresql
STORAGE_TYPE_POSTGRESQL_USERNAME
owgw
STORAGE_TYPE_POSTGRESQL_PASSWORD
owgw
STORAGE_TYPE_POSTGRESQL_DATABASE
owgw
owsec.env
Variable
Value/Description
STORAGE_TYPE
postgresql
STORAGE_TYPE_POSTGRESQL_HOST
postgresql
STORAGE_TYPE_POSTGRESQL_USERNAME
owsec
STORAGE_TYPE_POSTGRESQL_PASSWORD
owsec
STORAGE_TYPE_POSTGRESQL_DATABASE
owsec
owfms.env
Variable
Value/Description
STORAGE_TYPE
postgresql
STORAGE_TYPE_POSTGRESQL_HOST
postgresql
STORAGE_TYPE_POSTGRESQL_USERNAME
owfms
STORAGE_TYPE_POSTGRESQL_PASSWORD
owfms
STORAGE_TYPE_POSTGRESQL_DATABASE
owfms
owprov.env
Variable
Value/Description
STORAGE_TYPE
postgresql
STORAGE_TYPE_POSTGRESQL_HOST
postgresql
STORAGE_TYPE_POSTGRESQL_USERNAME
owprov
STORAGE_TYPE_POSTGRESQL_PASSWORD
owprov
STORAGE_TYPE_POSTGRESQL_DATABASE
owprov
owanalytics.env
Variable
Value/Description
STORAGE_TYPE
postgresql
STORAGE_TYPE_POSTGRESQL_HOST
postgresql
STORAGE_TYPE_POSTGRESQL_USERNAME
owanalytics
STORAGE_TYPE_POSTGRESQL_PASSWORD
owanalytics
STORAGE_TYPE_POSTGRESQL_DATABASE
owanalytics
postgresql.env
Variable
Value
POSTGRES_PASSWORD
postgres
POSTGRES_USER
postgres
OWGW_DB
owgw
OWGW_DB_USER
owgw
OWGW_DB_PASSWORD
owgw
OWSEC_DB
owsec
OWSEC_DB_USER
owsec
OWSEC_DB_PASSWORD
owsec
OWFMS_DB
owfms
OWFMS_DB_USER
owfms
OWFMS_DB_PASSWORD
owfms
OWPROV_DB
owprov
OWPROV_DB_USER
owprov
OWPROV_DB_PASSWORD
owprov
OWANALYTICS_DB
owanalytics
OWANALYTICS_DB_USER
owanalytics
OWANALYTICS_DB_PASSWORD
owanalytics
OWSUB_DB
owsub
OWSUB_DB_USER
owsub
OWSUB_DB_PASSWORD
owsub
Non-LB deployment with self-signed certificates
Switch into the project directory with cd docker-compose/.
Add an entry for openwifi.wlan.local in your hosts file which points to 127.0.0.1 or whatever the IP of the host running the deployment is.
Spin up the deployment with docker-compose up -d.
Check if the containers are up and running with docker-compose ps.
Connect to your AP via SSH and add a static hosts entry in /etc/hosts for openwifi.wlan.local. This should point to the address of the host the Compose deployment runs on.
Login to the UI https://openwifi.wlan.local and follow the instructions to change your default password.
To use the curl test scripts included in the microservice repositories set the following environment variables:
⚠️Note: When deploying with self-signed certificates you can not use the 'Trace' and 'Connect' features in the UI since the AP will throw a TLS error. Please use the Let's Encrypt deployment or provide your own valid certificates if you want to use these features.
Non-LB deployment with own certificates
Switch into the project directory with cd docker-compose/. Copy your websocket and REST API certificates into the certs/ directory. Make sure to reference the certificates accordingly in the service config if you use different file names or if you want to use different certificates for the respective microservices.
Adapt the following hostname and URI variables according to your environment:
.env
Variable
Description
INTERNAL_OWGW_HOSTNAME
Set this to your OWGW hostname, for example owgw.example.com.
INTERNAL_OWSEC_HOSTNAME
Set this to your OWSec hostname, for example owsec.example.com.
INTERNAL_OWFMS_HOSTNAME
Set this to your OWFms hostname, for example owfms.example.com.
INTERNAL_OWPROV_HOSTNAME
Set this to your OWProv hostname, for example owprov.example.com.
INTERNAL_OWANALYTICS_HOSTNAME
Set this to your OWAnalytics hostname, for example owanalytics.example.com.
INTERNAL_OWSUB_HOSTNAME
Set this to your OWSub hostname, for example owsub.example.com.
owgw.env
Variable
Description
FILEUPLOADER_HOST_NAME
Set this to your OWGW fileupload hostname, for example owgw.example.com.
FILEUPLOADER_URI
Set this to your OWGW fileupload URL, for example https://owgw.example.com:16003.
SYSTEM_URI_PRIVATE,SYSTEM_URI_PUBLIC
Set this to your OWGW REST API URL, for example https://owgw.example.com:16002.
RTTY_SERVER
Set this to your OWGW RTTYS hostname, for example owgw.example.com.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://owgw-ui.example.com.
owgw-ui.env
Variable
Description
REACT_APP_UCENTRALSEC_URL
Set this to your OWSec URL, for example https://owsec.example.com:16001.
owsec.env
Variable
Description
SYSTEM_URI_PRIVATE,SYSTEM_URI_PUBLIC
Set this to your OWSec URL, for example https://owsec.example.com:16001.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://owgw-ui.example.com.
owfms.env
Variable
Description
SYSTEM_URI_PRIVATE,SYSTEM_URI_PUBLIC
Set this to your OWFms URL, for example https://owfms.example.com:16004.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://owgw-ui.example.com.
owprov.env
Variable
Description
SYSTEM_URI_PRIVATE,SYSTEM_URI_PUBLIC
Set this to your OWProv URL, for example https://owprov.example.com:16005.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://owgw-ui.example.com.
owprov-ui.env
Variable
Description
REACT_APP_UCENTRALSEC_URL
Set this to your OWSec URL, for example https://owsec.example.com:16001.
owanalytics.env
Variable
Description
SYSTEM_URI_PRIVATE,SYSTEM_URI_PUBLIC
Set this to your OWAnalytics URL, for example https://owanalytics.example.com:16009.
SYSTEM_URI_UI
Set this to your OWProv-UI URL, for example https://owprov-ui.example.com.
Spin up the deployment with docker-compose up -d.
Check if the containers are up and running with docker-compose ps.
Login to the UI and and follow the instructions to change your default password.
LB deployment with self-signed certificates
Follow the same instructions as for the self-signed deployment without Traefik. The only difference is that you have to spin up the deployment with docker-compose -f docker-compose.lb.selfsigned.yml --env-file .env.selfsigned up -d. Make sure to specify the Compose and the according .env file every time you're working with the deployment or create an alias, for example alias docker-compose-lb-selfsigned="docker-compose -f docker-compose.lb.selfsigned.yml --env-file .env.selfsigned". You also have the possibility to scale specific services to a specified number of instances with docker-compose-lb-selfsigned up -d --scale SERVICE=NUM, where SERVICE is the service name as defined in the Compose file.
LB deployment with Let's Encrypt certificates
For the Let's Encrypt challenge to work you need a public IP address. The hostname which you set in the $SDKHOSTNAME env variable has to resolve to this IP address to pass the HTTP-01 challenge (https://letsencrypt.org/docs/challenge-types/#http-01-challenge).
Switch into the project directory with cd docker-compose/.
Adapt the following hostname and URI variables according to your environment.
.env.letsencrypt
Variable
Description
SDKHOSTNAME
Set this to the public hostname you want to use for all microservices, for example openwifi.example.com.
owgw.env
Variable
Description
FILEUPLOADER_HOST_NAME
Set this to your OWGW fileupload hostname, for example openwifi.example.com.
FILEUPLOADER_URI
Set this to your OWGW fileupload URL, for example https://openwifi.example.com:16003.
SYSTEM_URI_PUBLIC
Set this to your OWGW REST API URL, for example https://openwifi.example.com:16002.
RTTY_SERVER
Set this to your OWGW RTTYS hostname, for example openwifi.example.com.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://openwifi.example.com.
owgw-ui.env
Variable
Description
REACT_APP_UCENTRALSEC_URL
Set this to your OWSec URL, for example https://openwifi.example.com:16001.
owsec.env
Variable
Description
SYSTEM_URI_PUBLIC
Set this to your OWSec URL, for example https://openwifi.example.com:16001.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://openwifi.example.com.
owfms.env
Variable
Description
SYSTEM_URI_PUBLIC
Set this to your OWFms URL, for example https://openwifi.example.com:16004.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://openwifi.example.com.
owprov.env
Variable
Description
SYSTEM_URI_PUBLIC
Set this to your OWProv URL, for example https://openwifi.example.com:16005.
SYSTEM_URI_UI
Set this to your OWGW-UI URL, for example https://openwifi.example.com.
owprov-ui.env
Variable
Description
REACT_APP_UCENTRALSEC_URL
Set this to your OWSec URL, for example https://openwifi.example.com:16001.
owanalytics.env
Variable
Description
SYSTEM_URI_PUBLIC
Set this to your OWAnalytics URL, for example https://openwifi.example.com:16009.
SYSTEM_URI_UI
Set this to your OWProv-UI URL, for example https://openwifi.example.com.
owsub.env
Variable
Description
SYSTEM_URI_PUBLIC
Set this to your OWSub URL, for example https://openwifi.example.com:16006.
| SYSTEM_URI_UI | Set this to your OWGW-UI URL, for example https://openwifi.example.com. |
traefik.env
Variable
Description
TRAEFIK_CERTIFICATESRESOLVERS_OPENWIFI_ACME_EMAIL
Email address used for ACME registration.
Spin up the deployment with docker-compose -f docker-compose.lb.letsencrypt.yml --env-file .env.letsencrypt up -d. Make sure to specify the Compose and the according .env file every time you're working with the deployment or create an alias, for example alias docker-compose-lb-letsencrypt="docker-compose -f docker-compose.lb.letsencrypt.yml --env-file .env.letsencrypt". You also have the possibility to scale specific services to a specified number of instances with docker-compose-lb-letsencrypt up -d --scale SERVICE=NUM, where SERVICE is the service name as defined in the Compose file.
Check if the containers are up and running with docker-compose-lb-letsencrypt ps.
Login to the UI and follow the instructions to change your default password.
Note: All deployments create local volumes to persist mostly application, database and certificate data. In addition to that the certs/ directory is bind mounted into the microservice containers. Be aware that for the bind mounts the host directories and files will be owned by the user in the container. Since the files are under version control, you may have to change the ownership to your user again before pulling changes.