mirror of
https://github.com/YunoHost-Apps/scrutiny_ynh.git
synced 2024-09-03 20:16:24 +02:00
78 lines
3.8 KiB
Markdown
78 lines
3.8 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 for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/scrutiny)  
|
|
|
|
[](https://install-app.yunohost.org/?app=scrutiny)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Scrutiny 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
|
|
|
|
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
|
|
|
|
|
|
**Shipped version:** 0.6.0~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
* Official admin documentation: <https://github.com/AnalogJ/scrutiny/tree/master/docs>
|
|
* Upstream app code repository: <https://github.com/AnalogJ/scrutiny>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_scrutiny>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/scrutiny_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade scrutiny -u https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|