Skip to content

Commit 0328ddc

Browse files
committed
docs: update README with fork Docker image references and remove upstream links
1 parent e0a3cc4 commit 0328ddc

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Scrutiny uses `smartctl --scan` to detect devices/drives.
5555

5656
- All RAID controllers supported by `smartctl` are automatically supported by Scrutiny.
5757
- While some RAID controllers support passing through the underlying SMART data to `smartctl` others do not.
58-
- In some cases `--scan` does not correctly detect the device type, returning [incomplete SMART data](https://github.com/AnalogJ/scrutiny/issues/45).
59-
Scrutiny supports overriding detected device type via the config file: see [example.collector.yaml](https://github.com/AnalogJ/scrutiny/blob/master/example.collector.yaml)
58+
- In some cases `--scan` does not correctly detect the device type, returning incomplete SMART data.
59+
Scrutiny supports overriding detected device type via the config file: see [example.collector.yaml](example.collector.yaml)
6060
- If you use docker, you **must** pass though the RAID virtual disk to the container using `--device` (see below)
6161
- This device may be in `/dev/*` or `/dev/bus/*`.
6262
- If you're unsure, run `smartctl --scan` on your host, and pass all listed devices to the container.
@@ -67,7 +67,7 @@ See [docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md](./docs/TROUBLESHOOTING_DEVICE_COL
6767

6868
If you're using Docker, getting started is as simple as running the following command:
6969

70-
> See [docker/example.omnibus.docker-compose.yml](https://github.com/AnalogJ/scrutiny/blob/master/docker/example.omnibus.docker-compose.yml) for a docker-compose file.
70+
> See [docker/example.omnibus.docker-compose.yml](docker/example.omnibus.docker-compose.yml) for a docker-compose file.
7171
7272
```bash
7373
docker run -p 8080:8080 -p 8086:8086 --restart unless-stopped \
@@ -78,27 +78,27 @@ docker run -p 8080:8080 -p 8086:8086 --restart unless-stopped \
7878
--device=/dev/sda \
7979
--device=/dev/sdb \
8080
--name scrutiny \
81-
ghcr.io/analogj/scrutiny:master-omnibus
81+
ghcr.io/starosdev/scrutiny:latest-omnibus
8282
```
8383

8484
- `/run/udev` is necessary to provide the Scrutiny collector with access to your device metadata
8585
- `--cap-add SYS_RAWIO` is necessary to allow `smartctl` permission to query your device SMART data
86-
- NOTE: If you have **NVMe** drives, you must add `--cap-add SYS_ADMIN` as well. See issue [#26](https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130)
86+
- NOTE: If you have **NVMe** drives, you must add `--cap-add SYS_ADMIN` as well.
8787
- `--device` entries are required to ensure that your hard disk devices are accessible within the container.
88-
- `ghcr.io/analogj/scrutiny:master-omnibus` is a omnibus image, containing both the webapp server (frontend & api) as well as the S.M.A.R.T metric collector. (see below)
88+
- `ghcr.io/starosdev/scrutiny:latest-omnibus` is an omnibus image, containing both the webapp server (frontend & api) as well as the S.M.A.R.T metric collector. (see below)
8989

9090
### Hub/Spoke Deployment
9191

9292
In addition to the Omnibus image (available under the `latest` tag) you can deploy in Hub/Spoke mode, which requires 3
9393
other Docker images:
9494

95-
- `ghcr.io/analogj/scrutiny:master-collector` - Contains the Scrutiny data collector, `smartctl` binary and cron-like
95+
- `ghcr.io/starosdev/scrutiny:latest-collector` - Contains the Scrutiny data collector, `smartctl` binary and cron-like
9696
scheduler. You can run one collector on each server.
97-
- `ghcr.io/analogj/scrutiny:master-web` - Contains the Web UI and API. Only one container necessary
98-
- `influxdb:2.2` - InfluxDB image, used by the Web container to persist SMART data. Only one container necessary
97+
- `ghcr.io/starosdev/scrutiny:latest-web` - Contains the Web UI and API. Only one container necessary
98+
- `influxdb:2.2` - InfluxDB image, used by the Web container to persist SMART data. Only one container necessary.
9999
See [docs/TROUBLESHOOTING_INFLUXDB.md](./docs/TROUBLESHOOTING_INFLUXDB.md)
100100

101-
> See [docker/example.hubspoke.docker-compose.yml](https://github.com/AnalogJ/scrutiny/blob/master/docker/example.hubspoke.docker-compose.yml) for a docker-compose file.
101+
> See [docker/example.hubspoke.docker-compose.yml](docker/example.hubspoke.docker-compose.yml) for a docker-compose file.
102102
103103
```bash
104104
docker run -p 8086:8086 --restart unless-stopped \
@@ -109,7 +109,7 @@ docker run -p 8086:8086 --restart unless-stopped \
109109
docker run -p 8080:8080 --restart unless-stopped \
110110
-v `pwd`/scrutiny:/opt/scrutiny/config \
111111
--name scrutiny-web \
112-
ghcr.io/analogj/scrutiny:master-web
112+
ghcr.io/starosdev/scrutiny:latest-web
113113

114114
docker run --restart unless-stopped \
115115
-v /run/udev:/run/udev:ro \
@@ -118,12 +118,12 @@ docker run --restart unless-stopped \
118118
--device=/dev/sdb \
119119
-e COLLECTOR_API_ENDPOINT=http://SCRUTINY_WEB_IPADDRESS:8080 \
120120
--name scrutiny-collector \
121-
ghcr.io/analogj/scrutiny:master-collector
121+
ghcr.io/starosdev/scrutiny:latest-collector
122122
```
123123

124124
## Manual Installation (without-Docker)
125125

126-
While the easiest way to get started with [Scrutiny is using Docker](https://github.com/AnalogJ/scrutiny#docker),
126+
While the easiest way to get started with Scrutiny is using Docker (see above),
127127
it is possible to run it manually without much work. You can even mix and match, using Docker for one component and
128128
a manual installation for the other.
129129

@@ -154,8 +154,8 @@ There are two configuration files available:
154154
Neither file is required, however if provided, it allows you to configure how Scrutiny functions.
155155

156156
## Cron Schedule
157-
Unfortunately the Cron schedule cannot be configured via the `collector.yaml` (as the collector binary needs to be trigged by a scheduler/cron).
158-
However, if you are using the official `ghcr.io/analogj/scrutiny:master-collector` or `ghcr.io/analogj/scrutiny:master-omnibus` docker images,
157+
Unfortunately the Cron schedule cannot be configured via the `collector.yaml` (as the collector binary needs to be triggered by a scheduler/cron).
158+
However, if you are using the official `ghcr.io/starosdev/scrutiny:latest-collector` or `ghcr.io/starosdev/scrutiny:latest-omnibus` docker images,
159159
you can use the `COLLECTOR_CRON_SCHEDULE` environmental variable to override the default cron schedule (daily @ midnight - `0 0 * * *`).
160160

161161
`docker run -e COLLECTOR_CRON_SCHEDULE="0 0 * * *" ...`
@@ -240,12 +240,12 @@ scrutiny-collector-metrics run --debug --log-file /tmp/collector.log
240240
| linux-amd64 | :white_check_mark: | :white_check_mark: |
241241
| linux-arm-5 | :white_check_mark: | |
242242
| linux-arm-6 | :white_check_mark: | |
243-
| linux-arm-7 | :white_check_mark: | web/collector only. see [#236](https://github.com/AnalogJ/scrutiny/issues/236) |
243+
| linux-arm-7 | :white_check_mark: | web/collector only |
244244
| linux-arm64 | :white_check_mark: | :white_check_mark: |
245245
| freebsd-amd64 | :white_check_mark: | |
246246
| macos-amd64 | :white_check_mark: | :white_check_mark: |
247247
| macos-arm64 | :white_check_mark: | :white_check_mark: |
248-
| windows-amd64 | :white_check_mark: | WIP, see [#15](https://github.com/AnalogJ/scrutiny/issues/15) |
248+
| windows-amd64 | :white_check_mark: | WIP |
249249
| windows-arm64 | :white_check_mark: | |
250250

251251

0 commit comments

Comments
 (0)