YunoHost-Apps/grafana_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grafana_ynh.git synced 2024-09-03 20:36:29 +02:00
Code Issues Activity Actions

cleaning

Browse source
This commit is contained in:
Éric Gaspar 2023-12-04 23:08:03 +01:00
parent 2470f689ae
commit 578c6a6e83
4 changed files with 21 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
doc/ADMIN.md
View file

@ -1,35 +0,0 @@
## Configuration
**Important at first login:**
* you have to go the Grafana Menu (Grafana icon), select your account menu and select *Switch to Main Org.*
* you can now access the default NetData dashboard via the Home menu
**Don't hesitate to create new dashboards**: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard!
## Documentation
* Official Grafana documentation: https://grafana.com/docs/grafana/latest/
* Official InfluxdB documentation: https://docs.influxdata.com/influxdb/
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
* installs InfluxDB as time series database
* if the NetData package is installed, configures NetData to feed InfluxDB every minute
* installs Grafana as dashboard server
* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!)
* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!)
#### General architecture
![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png)
#### Multi-users support
LDAP and HTTP auth are supported.
## Limitations
* The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
* Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: **please do not create organizations**!

10
doc/DESCRIPTION.md
View file

@ -1 +1,9 @@
Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources. Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources.
## YunoHost specific features
* installs InfluxDB as time series database
* if the NetData package is installed, configures NetData to feed InfluxDB every minute
* installs Grafana as dashboard server
* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!)
* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!)

8
doc/POST_INSTALL.md Normal file
View file

@ -0,0 +1,8 @@
## Configuration
**Important at first login:**
* you have to go the Grafana Menu (Grafana icon), select your account menu and select *Switch to Main Org.*
* you can now access the default NetData dashboard via the Home menu
**Don't hesitate to create new dashboards**: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard!

4
doc/PRE_INSTALL.md Normal file
View file

@ -0,0 +1,4 @@
## Limitations
* The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
* Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: **please do not create organizations**!