Skip to end of metadata
Go to start of metadata

This page contains command line argument keys that can be used to modify the installation process. Each operating system supports launching with arguments, but with some small modifications to ensure they are passed through to the installer:

  • Windows: a  --%  arg should go before installer args
  • Mac: requires  open  -a  command with  --args  before the args to pass to the installer
  • Linux: a  --  arg should go before installer args

Arguments should be quoted.

Arguments Table

The table below lists the supported arguments.

Command Line Argument KeyDescriptionPossible ValuesExample
unattended

The unattended install mode to run the installer in. It runs with all default values unless otherwise specified

The unattended upgrades remove known IA modules that are deprecated, leaves third party as they are, and upgrades currently installed bundled modules. Additionally, unattended upgrades do not trigger the Ignition service to start automatically. The Ignition service must be started by a user. 

The argument also works with the uninstaller, allowing for unattended uninstalls. 

  • graphical - run with full size installer window but no interaction
  • minimal - shows a progress bar only unless errors occur
  • text - feedback on the command line only, no GUI
  • none - completely silent, no feedback except for the log file when complete regardless of success or fail
"unattended=minimal"
textModeWhether to run this installer in interactive text mode regardless of graphical support. Note that unattended supersedes this value.true - run in text mode"textMode=true"
locationOverrides the default installation directory, allowing you to specify where Ignition should be installed. A fully qualified file path"location=/usr/local/ignition"
logLevel

The logging level for the installer. The default is INFO, however more detail can be provided, revealing more information about the install process, as wells as the installer's internal operations.

Options are (from most granular to least granular):

  • trace
  • debug
  • info
  • warn
  • error
"logLevel=trace"
userSets the ownership of the install to this user.The username (as recognized by the operating system) that should be the owner of the installation."user=myUser"
serviceName

Sets the service name for the Gateway. Defaults to "Ignition". When running the graphical installer, the service is installed immediately on Windows and set for optional future installs on Linux/Mac .

When using this key with the unattended key during an upgrade, the existing service on windows will be removed, and replaced by a new service. 

my-gateway"serviceName=my-gateway"

Example Commands

The following examples demonstrate how arguments can be used when running the installer from. For the purposes of these examples, any mention of a user directory will use "yourUser", and the Ignition version number in the installer name will be "8.0.14". These should be replaced by appropriate values when attempting to run the installer on your system. 

Windows

# Runs the installer on command line only and requires user interaction.
C:\Users\yourUser\Downloads\ignition-8.0.14-windows-x64-installer.exe --% "textMode=true" 

# Runs the installer on command line, changes the default install directory, and does not requires user interaction.
C:\Users\yourUser\Downloads\ignition-8.0.14-windows-x64-installer.exe --% "unattended=text" "location=C:\Ignition"

Mac

# Runs the installer on command line only and requires user interaction.
open -a /Volumes/IgnitionInstaller/ignition-8.0.14-osx-installer.app --args "textMode=true" 

# Runs the installer on command line, changes the default install directory, and does not requires user interaction.
open -a /Volumes/IgnitionInstaller/ignition-8.0.14-osx-installer.app --args "unattended=text" "location=/Users/yourUser/Desktop/test"

Linux

# Runs the installer on command line only and requires user interaction.
"homes/yourUser/Downloads/ignition-8.0.14-linux-x64-installer.run" -- "textMode=true" 

# Runs the installer on command line, changes the default install directory, and does not requires user interaction.
"homes/yourUser/Downloads/ignition-8.0.14-linux-x64-installer.run" -- "unattended=text" "location=/home/yourUser/Desktop/test"


  • No labels