2023-06-29 18:56:46 +02:00
---
gitea: none
include_toc: true
---
2023-08-11 09:38:05 +02:00
[Return to the list of application services. ](../README.md )
2023-06-29 18:56:46 +02:00
# grafana
2023-08-02 09:26:54 +02:00
## Synopsis
2023-06-29 18:56:46 +02:00
2023-08-11 09:38:05 +02:00
[Grafana is an analytics and interactive visualization web application. ](https://grafana.com/ )
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
grafana:
applicationservice: grafana
zones_name:
- localdns
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.oauth2_client.oauth2_email_domain: example.net
```
2023-06-29 18:56:46 +02:00
2023-08-02 09:26:54 +02:00
## Basic variables
2023-08-01 15:13:17 +02:00
2023-08-11 09:38:05 +02:00
### General
2023-08-01 15:13:17 +02:00
2023-08-02 09:26:54 +02:00
#### Reverse proxy
2023-08-01 15:13:17 +02:00
2023-08-11 09:38:05 +02:00
##### Clients configuration
2023-08-02 09:26:54 +02:00
2023-08-10 21:55:46 +02:00
This family is a leadership.
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| ** [general.revprox.revprox_client.revprox_client_external_domainnames ](dictionaries/21_revprox_client.xml )**< br /> mandatory, multiple< br /> **Type:** [`domainname` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | Service external domain name.< br /> **Example:** service.example.net |
| ** [general.revprox.revprox_client.revprox_client_location ](dictionaries/21_revprox_client.xml )**< br /> mandatory< br /> **Type:** [`filename` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | URI to route request to the correct service.< br /> **Default:** / |
2023-08-02 09:26:54 +02:00
#### OAuth2 client
##### external
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| ** [general.oauth2_client.oauth2_email_domain ](dictionaries/31_grafana.xml )**< br /> mandatory< br /> **Type:** [`domainname` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | Domain name allowed to log on Grafana.< br /> **Example:** example.net |
2023-08-11 09:38:05 +02:00
## Variables
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
### General
2023-08-02 09:26:54 +02:00
#### Reverse proxy
2023-08-11 09:38:05 +02:00
##### Clients configuration
2023-08-02 09:26:54 +02:00
2023-08-10 21:55:46 +02:00
This family is a leadership.
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| ** [general.revprox.revprox_client.revprox_client_max_body_size ](dictionaries/21_revprox_client.xml )**< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | The maximum allowed size of the client request body. |
2023-08-02 09:26:54 +02:00
#### OAuth2 client
2023-08-11 09:38:05 +02:00
| Parameter | Comment |
2023-08-02 09:26:54 +02:00
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| ** [general.oauth2_client.oauth2_client_name ](dictionaries/31_grafana.xml )**< br /> mandatory< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 client name.< br /> **Default:** Grafana< br /> **Example:** example |
| ** [general.oauth2_client.oauth2_client_description ](dictionaries/31_grafana.xml )**< br /> mandatory< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 client description.< br /> **Default:** Visualisation de données< br /> **Example:** Example description |
| ** [general.oauth2_client.oauth2_client_login ](dictionaries/30_oauth2_client.xml )**< br /> **Type:** [`web_address` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 URL to valid login. |
##### external
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| ** [general.oauth2_client.external.oauth2_client_external ](dictionaries/30_oauth2_client.xml )**< br /> mandatory, multiple< br /> **Type:** [`web_address` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 client external.< br /> **Default:** *calculated* |
| ** [general.oauth2_client.external.oauth2_client_family ](dictionaries/30_oauth2_client.xml )**< br /> mandatory< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 family.< br /> **Default:** users |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| ** [general.oauth2_client.oauth2_client_category ](dictionaries/31_grafana.xml )**< br /> mandatory< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 category.< br /> **Default:** Administration |
| ** [general.oauth2_client.oauth2_client_logo ](dictionaries/31_grafana.xml )**< br /> mandatory< br /> **Type:** [`string` ](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable ) | OAuth2 logo.< br /> **Default:** silique_note.png |
2023-08-11 09:38:05 +02:00
## Requirements services
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
### Mandatories
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
- [LocalDNS ](../README.LocalDNS.md ): DNS forwarder for local domain name.
- [SMTP ](../README.SMTP.md ): Create a SMTP relay account and authorize sending email.
- [ReverseProxy ](../README.ReverseProxy.md ): Register to service to a reverse proxy server.
- [Postgresql ](../README.Postgresql.md ): Create account and connexion to a PostgreSQL server.
- [OAuth2 ](../README.OAuth2.md ): Remote clients needing to verify OAuth2 account.
2023-08-02 09:26:54 +02:00
2023-08-11 09:38:05 +02:00
### Optionals
2023-08-01 15:13:17 +02:00
2023-08-11 09:38:05 +02:00
- [Journald ](../README.Journald.md ): Concentrate journal messages on one host.
2023-08-01 15:13:17 +02:00
2023-06-29 18:56:46 +02:00
## Dependances
2023-08-11 09:38:05 +02:00
- [base-fedora-38 ](../base-fedora-38/README.md ): Base information of a Fedora 38.
- [base-fedora ](../base-fedora/README.md ): Base information of a Fedora.
- [systemd ](../systemd/README.md ): Systemd, a system and service manager.
- [base-machine ](../base-machine/README.md ): Base information for a machine.
- [base ](../base/README.md ): Base of all application services.
- [dns-local ](../dns-local/README.md ): DNS client with access to local zones.
- [pki-tls ](../pki-tls/README.md ): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald ](../journald/README.md ): Journald.
- [resolved ](../resolved/README.md ): Resolved.
- [postgresql-client ](../postgresql-client/README.md ): Application service needs interact with a Postgresql server.
- [oauth2-client ](../oauth2-client/README.md ): Application service needs interact with a Oauth2 server.
- [reverse-proxy-client ](../reverse-proxy-client/README.md ): Application service needs interact with a a reverse proxy server.
- [relay-mail-client ](../relay-mail-client/README.md ): Client SMTP.
