Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added influx database pre-requisite. Resolves #2 #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added influx database pre-requisite. Resolves #2 #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,35 @@ docker run --name meross-ingestor \
- ⚠️MEROSS_EMAIL
- ⚠️MEROSS_PASSWORD

Variables marked with `⚠️` are required
Variables marked with ⚠️ are required
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the `` so that that the explanation icon matched that used in the main body.


# 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.
Comment on lines +32 to +58
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


# Changelog
## [1.3.0] - 2021-04-18
Expand Down