readme-vars.yml

---

# project information
project_name: scrutiny
project_url: "https://github.com/AnalogJ/scrutiny"
project_logo: "https://raw.githubusercontent.com/AnalogJ/scrutiny/master/docs/dashboard.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

project_blurb_optional_extras_enabled: false
project_blurb_optional_extras: []

project_deprecation_status: true
project_deprecation_message: |
  We recommend the official images:
  https://github.com/AnalogJ/scrutiny#docker

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# development version
development_versions: false
development_versions_items:

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"

param_usage_include_net: false

param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
  - { env_var: "SCRUTINY_API_ENDPOINT", env_value: "http://localhost:8080", desc: "# optional - API endpoint of the scrutiny UI. Do not change unless using as a remote collector" }
  - { env_var: "SCRUTINY_WEB", env_value: "true", desc: "# optional - Run the web service." }
  - { env_var: "SCRUTINY_COLLECTOR", env_value: "true", desc: "# optional - Run the metrics collector." }

param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/config", desc: "Where config is stored." }
  - { vol_path: "/run/udev:ro", vol_host_path: "/run/udev", desc: "Provides necessary metadata to Scrutiny." }

param_device_map: true
param_devices:
  - { device_path: "/dev/sda", device_host_path: "/dev/sda", desc: "This is how Scrutiny accesses drives. Optionally supply `/dev:/dev` instead for all devices." }
  - { device_path: "/dev/sdb", device_host_path: "/dev/sdb", desc: "A second drive." }
  - { device_path: "/dev/nvme1n1", device_host_path: "/dev/nvme1n1", desc: "An NVMe drive. NVMe requires `--cap-add=SYS_ADMIN`." }

param_usage_include_ports: true
param_ports:
  - { external_port: "8080", internal_port: "8080", port_desc: "Port for scrutiny's web interface and API." }

# optional container parameters
opt_param_usage_include_env: false
opt_param_env_vars:

opt_param_usage_include_vols: false
opt_param_volumes:

opt_param_usage_include_ports: false
opt_param_ports:

opt_param_device_map: false
opt_param_devices:

cap_add_param: true
cap_add_param_vars:
    - { cap_add_var: "SYS_RAWIO" }
    
opt_cap_add_param: true
opt_cap_add_param_vars:
  - { cap_add_var: "SYS_ADMIN" }
optional_block_1: false
optional_block_1_items: ""

privileged: false

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  This container can be run as an 'all-in-one' deployment or as a hub / spoke deployment. Use the environment variables `SCRUTINY_WEB` and `SCRUTINY_COLLECTOR` to control the mode of the container. Setting both to `true` will deploy the container as both a collector and the web UI - this is the simplest and most straightforward deployment approach. To make use of the hub and spoke model, run this container in "collector" mode by specifying `SCRUTINY_API_ENDPOINT`. Set this to the host that is running the API. For this to work, you will need to expose the API port directly from the container (by default this is `8080`).

  You may need to manually enter the container to run `scrutiny-collector-metrics run` for your first job or wait until around midnight for it to kick off.
  
  A fully commented example configuration yaml file can be found in the original project repository [here](https://github.com/AnalogJ/scrutiny/blob/master/example.scrutiny.yaml). Place this file in the location mounted to `/config`.

  A note on `--cap-add` for this container: 
    * `SYS_RAWIO` is necessary to allow smartctl permission to query your device SMART data.
    * `SYS_ADMIN` is required for NVMe drives as per upstream issue [#26](https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130). 

# changelog
changelogs:
  - { date: "13.06.22:", desc: "Deprecate container." }
  - { date: "19.01.22:", desc: "Rebase to Alpine 3.15." }
  - { date: "22.11.20:", desc: "Added fix for `nsswitch.conf` to resolve local hosts" }
  - { date: "17.09.20:", desc: "Initial Release." }