mirror of
https://github.com/YunoHost-Apps/grafana_ynh.git
synced 2024-09-03 20:36:29 +02:00
57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Grafana for YunoHost
|
|
|
|
[![Integration level](https://dash.yunohost.org/integration/grafana.svg)](https://dash.yunohost.org/appci/app/grafana) ![Working status](https://ci-apps.yunohost.org/ci/badges/grafana.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/grafana.maintain.svg)
|
|
|
|
[![Install Grafana with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grafana)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Grafana quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
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!)
|
|
|
|
|
|
**Shipped version:** 10.2.3~ynh2
|
|
|
|
**Demo:** <https://play.grafana.org>
|
|
|
|
## Screenshots
|
|
|
|
![Screenshot of Grafana](./doc/screenshots/Grafana8_Kubernetes.jpg)
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://grafana.com/>
|
|
- Upstream app code repository: <https://github.com/grafana/grafana>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/grafana>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/grafana_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/grafana_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade grafana -u https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|