Skip to content
Snippets Groups Projects
Commit 00b59229 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update readme

parent 6c5c31bb
No related branches found
No related tags found
1 merge request!75915 update docs
......@@ -2,58 +2,11 @@
Demo of a custom Dashboard for IML Appmonitor using the API to fetch data. It works offline without a webserver using the Javascript fetch() function.
The Dashboards reads the tags from the IML appmonitor. You can enable/ disable each existing tag. The application section shows the application status of matching apps. The view will be refreshed in the given interval.
Author: Axel Hahn; Institute for Medical Education; University of Bern
👤 Author: Axel Hahn; Institute for Medical Education; University of Bern \
📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/appmonitor-dashboard/> \
📜 License: GNU GPL 3.0
## Requirements ##
* an already running IML Appmonitor instance - <https://github.com/iml-it/appmonitor>
* Appmonitor API must allow access from your ip address in its config (api -> sourceips)
* Your application checks use tags
## Installation ##
Extract the archive (or use git pull).
We need to setup the url for the api of the IML Appmonitor instance. In `public_html/javascript` copy the dist file inc_config.js.dist to inc_config.js
Replace values in the first object in the AM_INSTANCES array with your real data:
```js
/**
* you can add multiple instances of appmonitor servers
*/
const AM_INSTANCES=[
{
'label': 'local Docker',
'url': 'http://localhost:8001',
'tags': 'monitoring',
'user': 'api',
'password': 'hello'
}
];
const REFRESHTIME=30; // in sec
```
You can multiple instances of appmonitor servers with creating an additional object here. You get a select box to switch between them.
Open the file `public_html/index.html` in your webbrowser.
## Troubleshooting ##
* "no response" error \
--> Open the requested api url in the browser. Reasons why does it fail are:
* the base url in AM_SERVER_URL does not point to the api url
* your ip address is not whitelisted in the appmonitor api config. The api request with the browser identifies a non configured ip as a JSON message.
* Error 404
* no application matches the given tag or tag combination. Delete the tags with button [X] and try to start with a single tag.
📜 License: GNU GPL 3.0 \
📗 Docs: <https://os-docs.iml.unibe.ch/appmonitor-dashboard/>
## Screenshot ##
![Screenshot](docs/images/screenshot_main.png "Screenshot")
\ No newline at end of file
![Screenshot](docs/images/screenshot_main.png "Screenshot")
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment