Bring Your Own Docker
Clarity Gateway runs on a wide range of devices that have a modern Linux OS and Docker runtime.
Running with docker compose
Docker Compose allows you to create a short yaml configuration file that defines the container version, TCP port mappings, and volume mappings you'll be using. Create a directory for Clarity Gateway, e.g. /opt/clarity-gateway, and create a compose.yaml file inside that directory. Here's the format of a compose.yaml file that runs Clarity Gateway:
services:
clarity-gateway:
image: jcoreio/clarity-gateway:<VERSION>
ports:
- <TCP PORT>:3030
volumes:
- <DATA DIRECTORY>:/dataIf you choose version 10.3.1, port 5000, and ./data for your data directory, your compose.yaml will look like:
services:
clarity-gateway:
image: jcoreio/clarity-gateway:7.5.3
ports:
- 5000:3030
volumes:
- ./data:/dataRunning with docker run
When running Clarity Gateway on the command line, you'll need to choose a location for your data directory, and map that directory into your container. To use /opt/clarity-gateway/data as your data directory, run:
sudo mkdir -p /opt/clarity-gateway/data
To pull and run the Clarity Gateway container, type the following command:
docker run --name clarity-gateway -p 3030:3030 -v <DATA DIRECTORY>:/data --restart unless-stopped -d jcoreio/clarity-gateway:<VERSION>
If your data directory is /var/clarity-gateway and you want to run version 10.3.1, the command would be:
docker run --name clarity-gateway -p 3030:3030 -v /var/clarity-gateway:/data --restart unless-stopped -d jcoreio/clarity-gateway:10.3.1
Check the Clarity Gateway page on Docker Hub for a list of available versions.
Run the docker ps command to check that Clarity Gateway is running:
Accessing the Web Interface
Point your browser to http://<DEVICE IP ADDRESS>:<PORT> (for example, http://192.168.1.220:3030) to access the Clarity Gateway web interface.
The default password is password.
After you've successfully logged in, you will see the license entry screen. Enter your license key if you have one, or click "Start Trial" to try Clarity Gateway free for 2 hours:

After entering your license or starting the trial, you can get data flowing through Clarity Gateway by creating connectors:

Container logs
Run the docker logs clarity-gateway to see the container's logs:

In the example above, the container started successfully. You can safely ignore the error message about the local I/O driver: that driver only runs on the Iron Pi, and Clarity Gateway can operate without it.
Last updated