diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index 2890b79..db8dfd7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Loki + Promtail with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=loki) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Loki + Promtail 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.* +> *This package allows you to install Loki + Promtail 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 @@ -30,6 +30,7 @@ A Loki-based logging stack consists of 3 components: - Loki is the main server, responsible for storing logs and processing queries. - [Grafana](https://github.com/Yunohost-Apps/grafana_ynh) for querying and displaying the logs. + **Shipped version:** 2.9.5~ynh1 ## Documentation and resources @@ -41,9 +42,9 @@ A Loki-based logging stack consists of 3 components: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index da7e94e..d903b40 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Loki + Promtail pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Loki + Promtail avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=loki) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Loki + Promtail rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d’installer Loki + Promtail rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -30,20 +30,21 @@ A Loki-based logging stack consists of 3 components: - Loki is the main server, responsible for storing logs and processing queries. - [Grafana](https://github.com/Yunohost-Apps/grafana_ynh) for querying and displaying the logs. -**Version incluse :** 2.9.5~ynh1 + +**Version incluse :** 2.9.5~ynh1 ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug @@ -51,4 +52,4 @@ ou sudo yunohost app upgrade loki -u https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..6cac9a2 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,55 @@ + + +# Loki + Promtail para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/loki.svg)](https://dash.yunohost.org/appci/app/loki) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/loki.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/loki.maintain.svg) + +[![Instalar Loki + Promtail con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=loki) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Loki + Promtail de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate. It does not index the contents of the logs, but rather a set of labels for each log stream. + +Compared to other log aggregation systems, Loki: + +- does not do full text indexing on logs. By storing compressed, unstructured logs and only indexing metadata, Loki is simpler to operate and cheaper to run. +- indexes and groups log streams using the same labels you’re already using with Prometheus, enabling you to seamlessly switch between metrics and logs using the same labels that you’re already using with Prometheus. +- is an especially good fit for storing Kubernetes Pod logs. Metadata such as Pod labels is automatically scraped and indexed. +- has native support in Grafana (needs Grafana v6.0). + +A Loki-based logging stack consists of 3 components: +- Promtail (included in this package) is the agent, responsible for gathering logs and sending them to Loki. +- Loki is the main server, responsible for storing logs and processing queries. +- [Grafana](https://github.com/Yunohost-Apps/grafana_ynh) for querying and displaying the logs. + + +**Versión proporcionada:** 2.9.5~ynh1 +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug +ou +sudo yunohost app upgrade loki -u https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..52b17f0 --- /dev/null +++ b/README_it.md @@ -0,0 +1,55 @@ + + +# Loki + Promtail per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/loki.svg)](https://dash.yunohost.org/appci/app/loki) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/loki.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/loki.maintain.svg) + +[![Installa Loki + Promtail con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=loki) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Loki + Promtail su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate. It does not index the contents of the logs, but rather a set of labels for each log stream. + +Compared to other log aggregation systems, Loki: + +- does not do full text indexing on logs. By storing compressed, unstructured logs and only indexing metadata, Loki is simpler to operate and cheaper to run. +- indexes and groups log streams using the same labels you’re already using with Prometheus, enabling you to seamlessly switch between metrics and logs using the same labels that you’re already using with Prometheus. +- is an especially good fit for storing Kubernetes Pod logs. Metadata such as Pod labels is automatically scraped and indexed. +- has native support in Grafana (needs Grafana v6.0). + +A Loki-based logging stack consists of 3 components: +- Promtail (included in this package) is the agent, responsible for gathering logs and sending them to Loki. +- Loki is the main server, responsible for storing logs and processing queries. +- [Grafana](https://github.com/Yunohost-Apps/grafana_ynh) for querying and displaying the logs. + + +**Versione pubblicata:** 2.9.5~ynh1 +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/loki_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug +o +sudo yunohost app upgrade loki -u https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**