Added influx database pre-requisite. Resolves #2 #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
techie2000
commented
Apr 22, 2021
Comment on lines
+32
to
+58
| # Pre-requisites | ||
| The Influx database needs to be created before captured data can be sent to it. | ||
| If you are not sending your data to an existing Influx database, this can be done most easily via the CLI. | ||
| Execute the `influx` command to get an interactive prompt | ||
|
|
||
| ``` | ||
| root@72ee790882b5:/# influx | ||
| Connected to http://localhost:8086 version 1.8.4 | ||
| InfluxDB shell version: 1.8.4 | ||
| > | ||
| ``` | ||
|
|
||
| Verify you have admin privs on the Influx server | ||
|
|
||
| ``` | ||
| > show users | ||
| user admin | ||
| ---- ----- | ||
| root true | ||
| ``` | ||
|
|
||
| Create the database. You can change parameters if you wish, or accept the defaults by simply entering | ||
| ``` | ||
| > create database meross | ||
| ``` | ||
| where meross can be replaced with the name of the database you wish to create to capture your data. | ||
| Enter this name as the database in your `-e INFLUX_DATABASE=database` docker instantiation. |
There was a problem hiding this comment.
Added commentary around the need for an Influx db to created before using this container successfully. Less experienced users (including myself up to this point) may be used to containers creating required/default databases if they don't already exist.
techie2000
commented
Apr 22, 2021
| @@ -27,8 +27,35 @@ docker run --name meross-ingestor \ | |||
| - ⚠️MEROSS_EMAIL | |||
| - ⚠️MEROSS_PASSWORD | |||
|
|
|||
| Variables marked with `⚠️` are required | |||
| Variables marked with ⚠️ are required | |||
There was a problem hiding this comment.
Removed the `` so that that the explanation icon matched that used in the main body.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.