Improve README.md a little bit
Set indentation of docker commands, and set the language of code block to enable syntax highlight in README.md
This commit is contained in:
@@ -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
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user