mirror of
https://github.com/YunoHost-Apps/scrutiny_ynh.git
synced 2024-09-03 20:16:24 +02:00
78 lines
4 KiB
Markdown
78 lines
4 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.
|
|||
|
-->
|
|||
|
|
|||
|
# Scrutiny pour YunoHost
|
|||
|
|
|||
|
[![Niveau d’intégration](https://dash.yunohost.org/integration/scrutiny.svg)](https://dash.yunohost.org/appci/app/scrutiny) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/scrutiny.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/scrutiny.maintain.svg)
|
|||
|
|
|||
|
[![Installer Scrutiny avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrutiny)
|
|||
|
|
|||
|
*[Read this readme in english.](./README.md)*
|
|||
|
|
|||
|
> *Ce package vous permet d’installer Scrutiny 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.*
|
|||
|
|
|||
|
## Vue d’ensemble
|
|||
|
|
|||
|
WebUI for smartd S.M.A.R.T monitoring
|
|||
|
|
|||
|
> NOTE: Scrutiny is a Work-in-Progress and still has some rough edges.
|
|||
|
|
|||
|
# Introduction
|
|||
|
|
|||
|
If you run a server with more than a couple of hard drives, you're probably already familiar with S.M.A.R.T and the `smartd` daemon. If not, it's an incredible open source project described as the following:
|
|||
|
|
|||
|
> smartd is a daemon that monitors the Self-Monitoring, Analysis and Reporting Technology (SMART) system built into many ATA, IDE and SCSI-3 hard drives. The purpose of SMART is to monitor the reliability of the hard drive and predict drive failures, and to carry out different types of drive self-tests.
|
|||
|
|
|||
|
Theses S.M.A.R.T hard drive self-tests can help you detect and replace failing hard drives before they cause permanent data loss. However, there's a couple issues with `smartd`:
|
|||
|
|
|||
|
- There are more than a hundred S.M.A.R.T attributes, however `smartd` does not differentiate between critical and informational metrics
|
|||
|
- `smartd` does not record S.M.A.R.T attribute history, so it can be hard to determine if an attribute is degrading slowly over time.
|
|||
|
- S.M.A.R.T attribute thresholds are set by the manufacturer. In some cases these thresholds are unset, or are so high that they can only be used to confirm a failed drive, rather than detecting a drive about to fail.
|
|||
|
- `smartd` is a command line only tool. For head-less servers a web UI would be more valuable.
|
|||
|
|
|||
|
**Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates.**
|
|||
|
|
|||
|
# Features
|
|||
|
|
|||
|
Scrutiny is a simple but focused application, with a couple of core features:
|
|||
|
|
|||
|
- Web UI Dashboard - focused on Critical metrics
|
|||
|
- `smartd` integration (no re-inventing the wheel)
|
|||
|
- Auto-detection of all connected hard-drives
|
|||
|
- S.M.A.R.T metric tracking for historical trends
|
|||
|
- Customized thresholds using real world failure rates
|
|||
|
- Temperature tracking
|
|||
|
- Provided as an all-in-one Docker image (but can be installed manually)
|
|||
|
- Configurable Alerting/Notifications via Webhooks
|
|||
|
- (Future) Hard Drive performance testing & tracking
|
|||
|
|
|||
|
|
|||
|
**Version incluse :** 0.6.0~ynh1
|
|||
|
|
|||
|
## Captures d’écran
|
|||
|
|
|||
|
![Capture d’écran de Scrutiny](./doc/screenshots/dashboard.png)
|
|||
|
|
|||
|
## Documentations et ressources
|
|||
|
|
|||
|
* Documentation officielle de l’admin : <https://github.com/AnalogJ/scrutiny/tree/master/docs>
|
|||
|
* Dépôt de code officiel de l’app : <https://github.com/AnalogJ/scrutiny>
|
|||
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_scrutiny>
|
|||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/scrutiny_ynh/issues>
|
|||
|
|
|||
|
## Informations pour les développeurs
|
|||
|
|
|||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing).
|
|||
|
|
|||
|
Pour essayer la branche testing, procédez comme suit.
|
|||
|
|
|||
|
``` bash
|
|||
|
sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug
|
|||
|
ou
|
|||
|
sudo yunohost app upgrade scrutiny -u https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug
|
|||
|
```
|
|||
|
|
|||
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|