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

update manual instructions to include InfluxDB installation.

Browse Source
This commit is contained in:
Jason Kulatunga
2022-05-12 10:30:36 -07:00
parent e7801619cd
commit 489534cb73
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/INSTALL_MANUAL.md
+18 -1
View File
@@ -4,10 +4,16 @@ While the easiest way to get started with [Scrutiny is using Docker](https://git
it is possible to run it manually without much work. You can even mix and match, using Docker for one component and it is possible to run it manually without much work. You can even mix and match, using Docker for one component and
a manual installation for the other. There's also [an installer](INSTALL_ANSIBLE.md) which automates this manual installation procedure. a manual installation for the other. There's also [an installer](INSTALL_ANSIBLE.md) which automates this manual installation procedure.
Scrutiny is made up of two components: a collector and a webapp/api. Here's how each component can be deployed manually. Scrutiny is made up of three components: an influxdb Database, a collector and a webapp/api. Here's how each component can be deployed manually.
> Note: the `/opt/scrutiny` directory is not hardcoded, you can use any directory name/path. > Note: the `/opt/scrutiny` directory is not hardcoded, you can use any directory name/path.
## InfluxDB
Please follow the official InfluxDB installation guide. Note, you'll need to install v2.2.0+.
https://docs.influxdata.com/influxdb/v2.2/install/
## Webapp/API ## Webapp/API
### Dependencies ### Dependencies
@@ -45,6 +51,17 @@ web:
# The path to the Scrutiny frontend files (js, css, images) must be specified. # The path to the Scrutiny frontend files (js, css, images) must be specified.
# We'll populate it with files in the next section # We'll populate it with files in the next section
path: /opt/scrutiny/web path: /opt/scrutiny/web
# if you're runnning influxdb on a different host (or using a cloud-provider) you'll need to update the host & port below.
# token, org, bucket are unnecessary for a new InfluxDB installation, as Scrutiny will automatically run the InfluxDB setup,
# and store the information in the config file. If you 're re-using an existing influxdb installation, you'll need to provide
# the `token`
influxdb:
host: 0.0.0.0
port: 8086
# token: 'my-token'
# org: 'my-org'
# bucket: 'bucket'
``` ```
> Note: for a full list of available configuration options, please check the [example.scrutiny.yaml](https://github.com/AnalogJ/scrutiny/blob/master/example.scrutiny.yaml) file. > Note: for a full list of available configuration options, please check the [example.scrutiny.yaml](https://github.com/AnalogJ/scrutiny/blob/master/example.scrutiny.yaml) file.