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
Grafana package for YunoHost
189 commits 2 branches 0 tags 597 KiB
Shell 100%
Find a file
Éric Gaspar aa126767d7 v2
2023-10-24 20:25:42 +02:00
.github [autopatch] Upgrade auto-updater 2023-02-23 23:37:17 +01:00
conf Fix nginx conf for sub_path installation 2023-06-24 12:31:25 +02:00
doc Update doc/DISCLAIMER.md 2021-08-10 22:58:03 +02:00
scripts v2 2023-10-24 20:25:42 +02:00
CHANGELOG.md Upgrade to upstream version 7.4.0 2021-02-05 22:00:38 +01:00
check_process Check upgrade from current version 2022-03-08 00:22:57 +01:00
LICENSE Initial commit 2017-03-04 09:07:23 +01:00
manifest.json Upgrade to v10.1.5 2023-10-13 06:12:16 +00:00
manifest.toml v2 2023-10-24 20:25:42 +02:00
README.md Auto-update README 2023-10-13 06:12:22 +00:00
README_fr.md Auto-update README 2023-10-13 06:12:22 +00:00

README.md

Grafana for YunoHost

Integration level Working status Maintenance status

Install Grafana with YunoHost

Lire ce readme en français.

This package allows you to install Grafana quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Metric & analytic dashboards for monitoring

Shipped version: 10.1.5~ynh1

Demo: https://play.grafana.org

Screenshots

Screenshot of Grafana

Disclaimers / important information

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

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

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!

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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