Octo-Notifier
Description
The Octo-Notifier is a command line tool included in Octory's packages. It allows you to trigger actions and update application monitors whenever you want it. It is a powerfull addition to Octory and can be used directly in your scripts to have full control over Octory's behaviour.
When deployed, Octo-Notifier is installed in /usr/local/bin/octo-notifier
.
Name
octo-notifier - Send a notification to Octory's public interface
Synopsis
octo-notifier [--version] [--help | -h]
octo-notifier command [options] [--help | -h]
Commands
The following commands are available:
- monitor - Change the status of a monitor.
- trigger - Trigger an action.
- help - Display information on other commands.
Monitor
Send an update to a monitor's installation state.
Synopsis
- octo-notifier monitor name [--state | -s] state
Argument | Possible values | Description |
---|---|---|
name | - | The name of your application must be matching the Name key from Octory's configuration. |
state | notInstalled, installing, installed, failed | Installation state displayed in the AppMonitor component. |
Trigger
Send a custom trigger event to execute one or more ActionSets.
Synopsis
- octo-notifier trigger name
Argument | Possible values | Description |
---|---|---|
name | - | The custom trigger name in Octory's configuration. |
Help
Show command's help information.
Synopsis
- octo-notifier help command
Argument | Possible values | Description |
---|---|---|
command | monitor, trigger | The command for which you need help with. |