Portainer Templates logo

Portainer Templates

Inductive Automation - Ignition Gateway Inductive Automation - Ignition Gateway

Stack

edge

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

Image details

Pulls: 1.2M
Architecture: amd64, arm64, arm/v7
Image size: 2.0 GB
Latest: 8.3
User: inductiveautomation
Created: May 13, 2020
Updated: 1 day 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}EULA=Yadminuser=''adminpass=''gwedition=standard
Source
Repo

Template by portainer·Source

Notes

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

Standalone Install

Select an install method, to see config/commands for deploying Inductive Automation - Ignition Gateway

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  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 Inductive Automation - Ignition Gateway, fill in any config options, and hit Deploy

Template Import URL

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

The compose file this template deploys, straight from its repo:

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 deploy it directly from the source:

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

More install options in our documentation.

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.

Required settings are blank

adminuser, adminpass have no default value, and gateway may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

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.

A Compose stack

Inductive Automation - Ignition Gateway is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Inductive Automation - Ignition Gateway needs bundled into one download. This template pulls inductiveautomation/ignition:8.1.8, which Docker fetches once (about 2.0 GB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Inductive Automation - Ignition Gateway's comes from Docker Hub, published by inductiveautomation.

Version tags

The bit after the colon in the image name is the version tag. This one pins 8.1.8, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8088:8088 means it's reachable on port 8088 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8088:8088
  • 8043:8043
  • 4446:4446 over UDP

Volumes

A volume is where Inductive Automation - Ignition Gateway keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /usr/local/bin/ignition/data kept in the gw-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Inductive Automation - Ignition Gateway takes 9 of them, and 2 need a value before it'll start properly:

  • ACCEPT_IGNITION_EULA, pulled from your own environment
  • GATEWAY_ADMIN_USERNAME, pulled from your own environment
  • GATEWAY_ADMIN_PASSWORD, pulled from your own environment
  • IGNITION_EDITION, pulled from your own environment
  • TZ, pulled from your own environment. Time Zone
  • EULA, pick one of Y. Accept Igntion EULA
  • adminuser, needs a value. Gateway UI Admin Username
  • adminpass, needs a value. Gateway UI Admin Password
  • gwedition, pick one of standard, edge, maker. Gateway Edition

Networking

Nothing custom is set, so Inductive Automation - Ignition Gateway sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container gateway. That's what you'll spot in the containers list and use in commands like docker logs gateway.

Startup command

The command is what runs the moment the container starts. This template sets its own, -n ${EDGE_ID} -m 1024 -- wrapper.java.initmemory=512 -Dignition.allowunsignedmodules=true, in place of the image's default.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Inductive Automation - Ignition Gateway up. Add the template list to Portainer once, then deploying Inductive Automation - Ignition Gateway is a click rather than a wall of config.