Skip to content

Commit

Permalink
Doc/Help update on Icinga2 API
Browse files Browse the repository at this point in the history
  • Loading branch information
bashgeek committed Sep 26, 2017
1 parent ebbe2d8 commit c2f71c9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $ service icinga2 restart
```
- You will find the automatically generated API user here: `/etc/icinga2/conf.d/api-users.conf`
- The default port of the Icinga 2 API is `5665`, so the URL to go with would be like: `https://myicingaserver.com:5665/`
- If you use a self-signed certificate (like the one automatically created in the first step) you have to add it to Chrome's trusted store before it'll work in the plugin. This can easily be done be visiting the API URL in a browser tab and accept the certificate.
- If you use a self-signed certificate (like the one automatically created in the first step) you have to add it to your browsers/OS trusted store before it'll work in the plugin. This can easily be done be visiting the API URL in a browser tab and accept the certificate.
- If you run into any problems, please stick to the official [Icinga 2 API documentation](https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/)


Expand Down
16 changes: 16 additions & 0 deletions help.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,22 @@ <h2>Instance Settings</h2>
</tbody>
</table>

<h2>How-to for using the Icinga 2 API</h2>
<ul>
<li>
Please make sure you enabled and configured the new API in your Icinga 2 installation by either setting it up manually or use the CLI command for the automatic setup, which also creates a root-user for the API with a random password.
<pre># Run the automatic setup
$ icinga2 api setup

# Restart the icinga2 service
$ service icinga2 restart</pre>
</li>
<li>You will find the automatically generated API user here: /etc/icinga2/conf.d/api-users.conf</li>
<li>The default port of the Icinga 2 API is 5665, so the URL to go with would be like: https://myicingaserver.com:5665/</li>
<li>If you use a self-signed certificate (like the one automatically created in the first step) you have to add it to your browser/OS trusted store before it'll work in the plugin. This can easily be done be visiting the API URL in a browser tab and accept the certificate.</li>
<li>If you run into any problems, please stick to the official <a href="https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/" target="_blank">Icinga 2 API documentation</a></li>
</ul>

<h2>Extension Badges</h2>
<table class="table table-bordered table-striped">
<thead>
Expand Down

0 comments on commit c2f71c9

Please sign in to comment.