From d4945ef11906a71030343591cbf915e8629de1a9 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 18 Sep 2020 16:59:03 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-scrutiny.md | 164 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100755 images/docker-scrutiny.md diff --git a/images/docker-scrutiny.md b/images/docker-scrutiny.md new file mode 100755 index 000000000..b460689bc --- /dev/null +++ b/images/docker-scrutiny.md @@ -0,0 +1,164 @@ +# [linuxserver/scrutiny](https://github.com/linuxserver/docker-scrutiny) + +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-scrutiny) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-scrutiny/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-scrutiny/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-scrutiny/container_registry) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/scrutiny "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/scrutiny) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/scrutiny) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-scrutiny%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-scrutiny/job/master/) +[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Fscrutiny%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/scrutiny/latest/index.html) + +[Scrutiny](https://github.com/AnalogJ/scrutiny) WebUI for smartd S.M.A.R.T monitoring. + +## Supported Architectures + +Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). + +Simply pulling `linuxserver/scrutiny` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v7-latest | + + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker + +``` +docker create \ + --name=scrutiny \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=Europe/London \ + -e SCRUTINY_API_ENDPOINT=http://localhost:8080 \ + -e SCRUTINY_WEB=true \ + -e SCRUTINY_COLLECTOR=true \ + -p 8080:8080 \ + -v :/config \ + --restart unless-stopped \ + linuxserver/scrutiny +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2.1" +services: + scrutiny: + image: linuxserver/scrutiny + container_name: scrutiny + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/London + - SCRUTINY_API_ENDPOINT=http://localhost:8080 + - SCRUTINY_WEB=true + - SCRUTINY_COLLECTOR=true + volumes: + - :/config + ports: + - 8080:8080 + restart: unless-stopped +``` + +## Parameters + +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `8080` | Port for scrutiny's web interface and API. | + + +### Environment Variables (`-e`) + +| Env | Function | +| :----: | --- | +| `PUID=1000` | for UserID - see below for explanation | +| `PGID=1000` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `SCRUTINY_API_ENDPOINT=http://localhost:8080` | (optional) API endpoint of the scrutiny UI. | +| `SCRUTINY_WEB=true` | (optional) Run the web service. | +| `SCRUTINY_COLLECTOR=true` | (optional) Run the metrics collector. | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Where scrutiny config is stored. | + + + +## Environment variables from files (Docker secrets) + +You can set any environment variable from a file by using a special prepend `FILE__`. + +As an example: + +``` +-e FILE__PASSWORD=/run/secrets/mysecretpassword +``` + +Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file. + +## Umask for running applications + +For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. +Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support. + + +## User / Group Identifiers + +When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. + +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. + +In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: + +``` + $ id username + uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) +``` + +## Application Setup + +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` control which mode the containe will run in. Setting both to `true` will deploy the container as both a collector and the web UI / "Port for scrutiny's web interface and API." + +You can deploy the same container on multiple hosts running only the collector by specifying the `SCRUTINY_API_ENDPOINT` to point to the host that is running the API. + + +## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27scrutiny%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=scrutiny "view available mods for this container.") + +We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. + + +## Support Info + +* Shell access whilst the container is running: + * `docker exec -it scrutiny /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f scrutiny` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' scrutiny` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/scrutiny` + +## Versions + +* **17.09.20:** - Initial Release.