gilles/scrutiny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve README.md a little bit

Browse Source 
Set indentation of docker commands, and set the language of code block to enable syntax highlight in README.md
This commit is contained in:
Peter Dave Hello
2022-01-05 21:03:37 +08:00
committed by GitHub
parent 060ac7b83a
commit a8952eff0c
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -22
View File
@@ -72,12 +72,12 @@ If you're using Docker, getting started is as simple as running the following co
```bash ```bash
docker run -it --rm -p 8080:8080 \ docker run -it --rm -p 8080:8080 \
-v /run/udev:/run/udev:ro \ -v /run/udev:/run/udev:ro \
--cap-add SYS_RAWIO \ --cap-add SYS_RAWIO \
--device=/dev/sda \ --device=/dev/sda \
--device=/dev/sdb \ --device=/dev/sdb \
--name scrutiny \ --name scrutiny \
analogj/scrutiny analogj/scrutiny
``` ```
- `/run/udev` is necessary to provide the Scrutiny collector with access to your device metadata - `/run/udev` is necessary to provide the Scrutiny collector with access to your device metadata
@@ -95,17 +95,17 @@ In addition to the Omnibus image (available under the `latest` tag) there are 2
```bash ```bash
docker run -it --rm -p 8080:8080 \ docker run -it --rm -p 8080:8080 \
--name scrutiny-web \ --name scrutiny-web \
analogj/scrutiny:web analogj/scrutiny:web
docker run -it --rm \ docker run -it --rm \
-v /run/udev:/run/udev:ro \ -v /run/udev:/run/udev:ro \
--cap-add SYS_RAWIO \ --cap-add SYS_RAWIO \
--device=/dev/sda \ --device=/dev/sda \
--device=/dev/sdb \ --device=/dev/sdb \
-e SCRUTINY_API_ENDPOINT=http://SCRUTINY_WEB_IPADDRESS:8080 \ -e SCRUTINY_API_ENDPOINT=http://SCRUTINY_WEB_IPADDRESS:8080 \
--name scrutiny-collector \ --name scrutiny-collector \
analogj/scrutiny:collector analogj/scrutiny:collector
``` ```
## Manual Installation (without-Docker) ## Manual Installation (without-Docker)
@@ -126,7 +126,7 @@ drive that Scrutiny detected. The collector is configured to run once a day, but
For users of the docker Hub/Spoke deployment or manual install: initially the dashboard will be empty. For users of the docker Hub/Spoke deployment or manual install: initially the dashboard will be empty.
After the first collector run, you'll be greeted with a list of all your hard drives and their current smart status. After the first collector run, you'll be greeted with a list of all your hard drives and their current smart status.
``` ```bash
docker exec scrutiny /scrutiny/bin/scrutiny-collector-metrics run docker exec scrutiny /scrutiny/bin/scrutiny-collector-metrics run
``` ```
@@ -165,7 +165,7 @@ Check the `notify.urls` section of [example.scrutiny.yml](example.scrutiny.yaml)
You can test that your notifications are configured correctly by posting an empty payload to the notifications health check API. You can test that your notifications are configured correctly by posting an empty payload to the notifications health check API.
``` ```bash
curl -X POST http://localhost:8080/api/health/notify curl -X POST http://localhost:8080/api/health/notify
``` ```
@@ -176,14 +176,14 @@ Scrutiny provides various methods to change the log level to debug and generate
You can use environmental variables to enable debug logging and/or log files for the web server: You can use environmental variables to enable debug logging and/or log files for the web server:
``` ```bash
DEBUG=true DEBUG=true
SCRUTINY_LOG_FILE=/tmp/web.log SCRUTINY_LOG_FILE=/tmp/web.log
``` ```
You can configure the log level and log file in the config file: You can configure the log level and log file in the config file:
``` ```yml
log: log:
file: '/tmp/web.log' file: '/tmp/web.log'
level: DEBUG level: DEBUG
@@ -191,7 +191,7 @@ log:
Or if you're not using docker, you can pass CLI arguments to the web server during startup: Or if you're not using docker, you can pass CLI arguments to the web server during startup:
``` ```bash
scrutiny start --debug --log-file /tmp/web.log scrutiny start --debug --log-file /tmp/web.log
``` ```
@@ -199,14 +199,14 @@ scrutiny start --debug --log-file /tmp/web.log
You can use environmental variables to enable debug logging and/or log files for the collector: You can use environmental variables to enable debug logging and/or log files for the collector:
``` ```bash
DEBUG=true DEBUG=true
COLLECTOR_LOG_FILE=/tmp/collector.log COLLECTOR_LOG_FILE=/tmp/collector.log
``` ```
Or if you're not using docker, you can pass CLI arguments to the collector during startup: Or if you're not using docker, you can pass CLI arguments to the collector during startup:
``` ```bash
scrutiny-collector-metrics run --debug --log-file /tmp/collector.log scrutiny-collector-metrics run --debug --log-file /tmp/collector.log
``` ```