Portainer Templates logo

Portainer Templates

Inductive Automation - Ignition Gateway Inductive Automation - Ignition Gateway

edge

Ignition Gateway is the primary software service that drives everything in Ignition - Single Server Deployment

Image details

Pulls: 1.2M
Architectures: amd64, arm64, arm/v7
Image size: 2.0 GB
Latest: 8.3
User: inductiveautomation
Created: May 13, 2020
Updated: 1 hour ago
Status: active

Configuration

Type
Compose
Platform
linux
Image
inductiveautomation/ignition:8.1.8
Command
-n ${EDGE_ID} -m 1024 -- wrapper.java.initmemory=512 -Dignition.allowunsignedmodules=true
Ports
8088:80888043:80434446:4446/udp
Volumes
/usr/local/bin/ignition/data : gw-data
Env vars
ACCEPT_IGNITION_EULA=${EULA}GATEWAY_ADMIN_USERNAME=${adminuser}GATEWAY_ADMIN_PASSWORD=${adminpass}IGNITION_EDITION=${gwedition}TZ=${TZ}
Source
Repo

Template by portainer·Source

Notes

For TZ see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name gateway \
  -p 8088:8088 \
  -p 8043:8043 \
  -p 4446:4446/udp \
  -e 'ACCEPT_IGNITION_EULA=${EULA}' \
  -e 'GATEWAY_ADMIN_USERNAME=${adminuser}' \
  -e 'GATEWAY_ADMIN_PASSWORD=${adminpass}' \
  -e 'IGNITION_EDITION=${gwedition}' \
  -e 'TZ=${TZ}' \
  -v gw-data:/usr/local/bin/ignition/data \
  inductiveautomation/ignition:8.1.8 \
  -n ${EDGE_ID} -m 1024 -- wrapper.java.initmemory=512 -Dignition.allowunsignedmodules=true

If the stack expects env vars, set them or add them to a .env file first.

services:
  # Ignition Gateway
  gateway:
    image: inductiveautomation/ignition:8.1.8
    ports:
      - 8088:8088
      - 8043:8043
      - 4446:4446/udp
    volumes:
      - gw-data:/usr/local/bin/ignition/data
    environment:
      - ACCEPT_IGNITION_EULA=${EULA}
      - GATEWAY_ADMIN_USERNAME=${adminuser}
      - GATEWAY_ADMIN_PASSWORD=${adminpass}
      - IGNITION_EDITION=${gwedition}
      - TZ=${TZ}  # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
    command: >
      -n ${EDGE_ID}
      -m 1024
      --
      wrapper.java.initmemory=512
      -Dignition.allowunsignedmodules=true
 
volumes:
  gw-data:

Or, use the original compose file, straight from the template repo. Deploy with:

git clone https://github.com/portainer/templates
cd templates
docker compose -f edge/ignition_gw/docker-compose.yml up -d

Save this file as inductive-automation-ignition-gateway-stack.yml, then from a manager node, run docker stack deploy -c inductive-automation-ignition-gateway-stack.yml inductive-automation-ignition-gateway

version: '3.8'
services:
  inductive-automation-ignition-gateway:
    image: inductiveautomation/ignition:8.1.8
    command: >
      -n ${EDGE_ID} -m 1024 -- wrapper.java.initmemory=512
      -Dignition.allowunsignedmodules=true
    ports:
      - '8088:8088'
      - '8043:8043'
      - 4446:4446/udp
    volumes:
      - gw-data:/usr/local/bin/ignition/data
    environment:
      ACCEPT_IGNITION_EULA: ${EULA}
      GATEWAY_ADMIN_USERNAME: ${adminuser}
      GATEWAY_ADMIN_PASSWORD: ${adminpass}
      IGNITION_EDITION: ${gwedition}
      TZ: ${TZ}

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

inductive-automation-ignition-gateway-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: inductive-automation-ignition-gateway
  labels:
    app: inductive-automation-ignition-gateway
spec:
  replicas: 1
  selector:
    matchLabels:
      app: inductive-automation-ignition-gateway
  template:
    metadata:
      labels:
        app: inductive-automation-ignition-gateway
    spec:
      containers:
        - name: inductive-automation-ignition-gateway
          image: inductiveautomation/ignition:8.1.8
          args:
            - '-n'
            - ${EDGE_ID}
            - '-m'
            - '1024'
            - '--'
            - wrapper.java.initmemory=512
            - '-Dignition.allowunsignedmodules=true'
          env:
            - name: ACCEPT_IGNITION_EULA
              value: ${EULA}
            - name: GATEWAY_ADMIN_USERNAME
              value: ${adminuser}
            - name: GATEWAY_ADMIN_PASSWORD
              value: ${adminpass}
            - name: IGNITION_EDITION
              value: ${gwedition}
            - name: TZ
              value: ${TZ}
          ports:
            - containerPort: 8088
              protocol: TCP
            - containerPort: 8043
              protocol: TCP
            - containerPort: 4446
              protocol: UDP
          volumeMounts:
            - name: inductive-automation-ignition-gateway-data-0
              mountPath: /usr/local/bin/ignition/data
      volumes:
        - name: inductive-automation-ignition-gateway-data-0
          hostPath:
            path: gw-data

inductive-automation-ignition-gateway-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: inductive-automation-ignition-gateway
spec:
  type: LoadBalancer
  selector:
    app: inductive-automation-ignition-gateway
  ports:
    - name: 8088-tcp
      port: 8088
      targetPort: 8088
      protocol: TCP
    - name: 8043-tcp
      port: 8043
      targetPort: 8043
      protocol: TCP
    - name: 4446-udp
      port: 4446
      targetPort: 4446
      protocol: UDP

Save this file as ~/.config/containers/systemd/inductive-automation-ignition-gateway.container

[Unit]
Description=Inductive Automation - Ignition Gateway

[Container]
Image=inductiveautomation/ignition:8.1.8
ContainerName=inductive-automation-ignition-gateway
PublishPort=8088:8088
PublishPort=8043:8043
PublishPort=4446:4446/udp
Environment=ACCEPT_IGNITION_EULA=${EULA}
Environment=GATEWAY_ADMIN_USERNAME=${adminuser}
Environment=GATEWAY_ADMIN_PASSWORD=${adminpass}
Environment=IGNITION_EDITION=${gwedition}
Environment=TZ=${TZ}
Volume=gw-data:/usr/local/bin/ignition/data
Exec=-n ${EDGE_ID} -m 1024 -- wrapper.java.initmemory=512 -Dignition.allowunsignedmodules=true


[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start inductive-automation-ignition-gateway

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

Ignition

Ignition is a powerful integrated development environment with everything you need to create virtually any kind of industrial application – SCADA, IIoT, MES and beyond – all on one platform. Try the live demo, read the documentation, or buy now.

About this Image

Official container images for Inductive Automation's Ignition. Consult the Ignition Docker Image Documentation for detailed guidance and examples.

Supported tags

  • 8.3.8, 8.3, latest - Latest stable release from the 8.3.x branch.
  • 8.3-nightly, nightly - Latest development snapshot, updated nightly.
  • 8.1.53, 8.1 - Latest stable release from the 8.1.x branch.
  • 8.1-nightly - Latest development snapshot from the 8.1.x branch, updated nightly.

How to use this Image

The example below will provide a running gateway that you can connect to via port 9088. More information on the available runtime arguments/flags and environment variable configurability can be found in the Ignition Docker Image Documentation.
docker run -d -p 9088:8088 \
    --name ignition-test \
    --volume ignition-test-data:/usr/local/bin/ignition/data \
    inductiveautomation/ignition:8.3.8 \
    -n docker-test -a localhost -h 9088 -s 9043

docker pull inductiveautomation/ignition:latest to pull the latest stable release from the current primary branch - e.g. 8.3.8. Use tag nightly to pull the latest development snapshot, updated, as the name implies, nightly.

Licensing

The Inductive Automation software contained in this Docker container image is licensed under the terms of the Inductive Automation Software License Agreement.
By passing the value ACCEPT_IGNITION_EULA=Y, you agree that your use of Inductive Automation software running in this Docker container image is governed by the terms of the Inductive Automation Software License Agreement.
All third party software (whether open or closed) running in this Docker container image is licensed as indicated in this Docker Hub “License” section or in the container itself, usually as a NOTICE or LICENSE file. You agree to comply with any relevant licenses for third party software contained in this Docker container image.

Serve Inductive Automation - Ignition Gateway on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying inductive-automation-ignition-gateway.example.com to http://gateway:8088

Add this to your Caddyfile

inductive-automation-ignition-gateway.example.com {
	reverse_proxy http://gateway:8088
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8088 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8088
  • Stop the other service, or pick a different host port. In 8088:8088 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8088. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, gateway can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8088

Image won't pull

Test the pull directly on the host: docker pull inductiveautomation/ignition:8.1.8

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Similar apps

Anyviz Cloud Adaptor Anyviz Cloud Adaptor edge CockroachDB (stack) edgeEMQX Open Source MQTT Broker EMQX Open Source MQTT Broker edgeFloating License Server Floating License Server edgeGrafana Dashboard Grafana Dashboard edgeInfluxDB for Edge InfluxDB for Edge edgeLitmus Edge Litmus Edge edgeLitmus Edge Digital Factory Demo Litmus Edge Digital Factory Demo edge