Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
FieldofClay authored Nov 2, 2023
1 parent b429954 commit 0b87ed3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ Adds an alert action to Splunk that allows sending a notification using any of t
For a full list of notification services, see https://github.com/caronc/apprise/wiki

There are two ways of using this addon:
- Providing a URL in each alert action
- Using a configuration file and tags
- Providing a URL in each alert action
- Using a configuration file and tags

### Providing a URL in each alert action
This requires no configuration to use. Just put a valid URL in the alert action and the service will be sent the alert.

### Using a configuration file and tags
See https://github.com/caronc/apprise/wiki/config for creating an Apprise configuration file.

To provide the configuration file to the add-on, in the Splunk UI go to Settings>Alert Actions>Setup Apprise Alert Action*
To provide the configuration file to the add-on, in the Splunk UI go to *Settings>Alert Actions>Setup Apprise Alert Action*

Alternatively, this can be done by updating and placing the below config in local/alert_actions.conf

[apprise_alert]
param.config = <<config_file>>

Note: The default path the addon looks in for configuration files the apprise_alert/bin/ folder. Either provide a full path or relative path from this directory.
Note: The default path the addon looks in for configuration files the apprise_alert/bin/ folder. Either provide a full path or relative path from this directory.

0 comments on commit 0b87ed3

Please sign in to comment.