document authorization for rt-rest2
parent
2a0eb79c41
commit
7de2f2b432
12
README.md
12
README.md
|
@ -29,6 +29,14 @@ hosts or services monitored by icinga2.
|
|||
A configuration is expected to be in `rotochute.json`, other paths can be used with the `-config` switch.
|
||||
The `rotochute.json.example` file is a good starting point for a config.
|
||||
|
||||
### Supported Configurations
|
||||
|
||||
rotochute supports the traditional RT-REST api as well as the newer RT-REST2 api.
|
||||
The latter can be configured either with http basic authentication as well as token-based
|
||||
authentication (please refer to the RT-REST2 docs for this).
|
||||
If the User is set to "" in the configuration, the token based authentication scheme is used and
|
||||
the string given for the password becomes the token.
|
||||
|
||||
### Explained Example Configuration
|
||||
|
||||
If parts of this are used, comments (//...) must be removed. Using the `-example` switch is recommended.
|
||||
|
@ -49,7 +57,8 @@ If parts of this are used, comments (//...) must be removed. Using the `-example
|
|||
},
|
||||
"RT2": {
|
||||
"URL": "https://support.example.com", // Request Tracker base URL
|
||||
"Token": "secret", // Request Tracker password
|
||||
"User": "apiuser", // Request Tracker API user
|
||||
"Password": "secret", // Request Tracker password
|
||||
"Insecure": true // Ignore SSL certificate errors
|
||||
},
|
||||
"Cache": {
|
||||
|
@ -67,6 +76,7 @@ If parts of this are used, comments (//...) must be removed. Using the `-example
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
### Mappings
|
||||
|
||||
A mapping is the tuple of an events state, the old state (if any), if the ticket is owned, and an action to
|
||||
|
|
Loading…
Reference in New Issue