Table of contents
- How does it work?
- Ignition via Homebrew
- Which formulae are available?
- How do I install these formulae?
- How do I start/stop/restart Ignition when installed via Homebrew?
- How do I start Ignition automatically at Login?
- How do I check the status of the Ignition service?
- How do I run
- How do I uninstall Ignition?
- Caveats and Limitations
- Where do I get support if something goes wrong?
During the winter break we started working in a way to get Ignition, by Inductive Automation, installed via Homebrew, and recently our efforts have come to fruition.
For those who might not be aware of Homebrew, Homebrew is “The Missing Package Manager for macOS (or Linux)”.
What Does Homebrew Do?
Homebrew installs the stuff you need that Apple (or your Linux system) didn’t.
The main reason is to give developers the ability to install multiple versions. Granted, this is something that can be accomplished via the ZIP File Installations, but doing it via Homebrew is a little less involved.
How does it work?
First you’ll need Homebrew, see Installation.
Ignition via Homebrew
Once you’ve installed Homebrew, or if you already have it, you’ll need to tap coatl-dev’s Homebrew tap with the following command:
brew tap coatl-dev/coatl-dev
That will tap our Homebrew repository and will allow you to install its formulae or casks.
Please note that multiple releases can be installed side-by-side, with some considerations like the port number used for each Gateway.
To get a list of available versions, run
brew search ignition after you’ve tapped our repo or refer to which formulae are available.
Which formulae are available?
You may visit coatl.dev formulae for the complete list.
How do I install these formulae?
You can run
brew install coatl-dev/coatl-dev/<formula>, or
brew tap coatl-dev/coatl-dev and then
brew install <formula> .
$ brew tap coatl-dev/coatl-dev ==> Tapping coatl-dev/coatl-dev Cloning into '/usr/local/Homebrew/Library/Taps/coatl-dev/homebrew-coatl-dev'... $ brew install email@example.com ==> Installing firstname.lastname@example.org from coatl-dev/coatl-dev ==> Downloading https://files.inductiveautomation.com/release/ia/8.1.2/20210203-1115/Ignition-osx-8.1.2.zip ################################################ 100.0% ==> Caveats To have launchd start email@example.com now and restart at login: brew services start firstname.lastname@example.org ==> Summary 🍺 /usr/local/Cellaremail@example.com/8.1.2: 1,330 files, 1.4GB, built in 56 seconds
After that, just open a new Terminal window or tab, and run
ignition-8.1.2 start and after that completes successfully just go to http://localhost:8088/ to provision your Gateway.
How do I start/stop/restart Ignition when installed via Homebrew?
The installation creates a symlink located in
/usr/local/bin, and each Ignition release is named according to its version. E.g. firstname.lastname@example.org installs
/usr/local/bin/ignition-8.1.2, email@example.com installs
ignition-8.0.17, firstname.lastname@example.org installs
ignition-edge-8.1.1, and so on.
So you’ll just have to run
ignition-x-x-x start or
ignition-edge-x-x-x start for the Edge release.
$ ignition-8.1.2 start Starting Ignition-Gateway... Waiting for Ignition-Gateway......... running: PID:5999
The first time you start Ignition you might see the following output:
$ ignition-8.1.2 start decompressing runtime.. runtime decompression complete Starting Ignition-Gateway... Waiting for Ignition-Gateway....... running: PID:6811
This means that Ignition is decompressing the pre-bundled JRE.
How do I start Ignition automatically at Login?
As the installation messages suggests, just run
brew services start email@example.com. Alternatively you could run
sudo brew services start firstname.lastname@example.org to start at startup.
$ brew services start email@example.com ==> Successfully started `firstname.lastname@example.org` (label: email@example.com)
For more information about
brew services, run
brew services --help.
How do I check the status of the Ignition service?
Simply run the following command:
$ ignition-8.1.2 status Ignition-Gateway (not installed) is running: PID:5999, Wrapper:STARTED, Java:STARTED
Or to check the
$ brew services Name Status User Plist firstname.lastname@example.org started thecesrom /Users/thecesrom/Library/LaunchAgentsemail@example.com
It may occur that before you restart your Mac you might get
error as the Status, like this:
$ brew services Name Status User Plist firstname.lastname@example.org error thecesrom /Users/thecesrom/Library/LaunchAgentsemail@example.com
There is no issue with the service, you might just need to restart.
How do I run
For those of you that wish to manage your Gateway through the Gateway Command-line Utility, or
gwcmd, it can be found at
$ cd "$(brew --cellar)/firstname.lastname@example.org/8.1.2/libexec" $ ./gwcmd.sh --info Gateway Name: Ignition-Cesars-MacBook-Air.local Gateway Version: 8.1.2 (64-bit) Web Server Status: RUNNING Gateway Status: RUNNING Http Port: 8088 Https Port: 8443 $ ./gwcmd.sh --port 80 HTTP port changed. $ ./gwcmd.sh --sslport 443 HTTPS port changed. $ ./gwcmd.sh --restart Waiting for Gateway restart.. Gateway is now running $ ./gwcmd.sh --info Gateway Name: Ignition-Cesars-MacBook-Air.local Gateway Version: 8.1.2 (64-bit) Web Server Status: RUNNING Gateway Status: RUNNING Http Port: 80 Https Port: 443
To see a full list of options run
./gwcmd.sh --help or read the documentation here.
How do I uninstall Ignition?
- ⚠️ Stop the Gateway by running
ignition-edge-x.x.x stop⚠️ (Learn more)
brew uninstall email@example.com
brew uninstall firstname.lastname@example.org
Caveats and Limitations
This is only currently working on macOS Mojave or higher.
You can only provision or select one version for each release. This means that if you install
email@example.com and during provisioning you select Maker, you cannot try to install
firstname.lastname@example.org again and select another version while provisioning your Gateway. The same applies to all other formulae.
As mentioned above, it is important to first stop the Gateway, otherwise you might run into an issue if you want to reinstall the same version.
While testing Ignition formulae we noticed that if the formula is uninstalled via
brew uninstall ignition[-edge]-x.x.x before the service is stopped, the running service does not allow Homebrew to perform proper cleanup so the formula directory cannot be deleted (found at
For example, if you installed
email@example.com, then uninstalled without stopping the service, and try to install again, you might get the following error:
$ brew install firstname.lastname@example.org Warning: email@example.com 8.1.2 is already installed, it's just not linked You can use `brew link firstname.lastname@example.org` to link this version.
Steps to fix this:
- Stop the Ignition process using
ignition[-edge]-x.x.xfolder from your Cellar
$ brew uninstall email@example.com Uninstalling /usr/local/Cellarfirstname.lastname@example.org/8.1.2... (6.5KB)
Where do I get support if something goes wrong?
Try the Discussions.
Hopefully you find it useful.