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.

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

.env.example with variables documentation #25

Merged
merged 3 commits into from
Oct 7, 2020

Conversation

sblrok
Copy link
Contributor

@sblrok sblrok commented Sep 28, 2020

Changes

  1. Added .env.example files with descriptions of each variable inside.
  2. Added 'python-dotenv' library to load variables from .env file
  3. Included .env file to .gitignore

Now you can create .env files based on them for separate hastic/server and hastic/analytics use

.env.example Outdated
# Hastic server url
HASTIC_SERVER_URL=ws://localhost:8002
# Log level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
HS_AN_LOGGING_LEVEL=DEBUG
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
HS_AN_LOGGING_LEVEL=DEBUG
HS_AN_LOGGING_LEVEL=DEBUG

.gitignore Outdated
test/
.env
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
.env
.env

@rozetko
Copy link
Member

rozetko commented Sep 29, 2020

also, LEARNING_TIMEOUT variable is missing

@rozetko rozetko changed the title Created a .env.example with variables documentation .env.example with variables documentation Oct 1, 2020
.env.example Outdated
@@ -0,0 +1,4 @@
# Hastic server url
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Hastic server url
# (optional) websockets URL to connect to hastic-server

.env.example Outdated
@@ -0,0 +1,4 @@
# Hastic server url
HASTIC_SERVER_URL=ws://localhost:8002
# Log level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Log level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
# (optional) logging level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'

@rozetko rozetko merged commit 53e392a into master Oct 7, 2020
@rozetko rozetko deleted the env_variables_documentation_issue_24 branch October 7, 2020 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants