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

Add Docker quickstart or example reference to readme #123

Open
dkisselev opened this issue Oct 13, 2021 · 0 comments
Open

Add Docker quickstart or example reference to readme #123

dkisselev opened this issue Oct 13, 2021 · 0 comments

Comments

@dkisselev
Copy link

The Readme includes the run steps for starting the exporter directly but the Docker containers behave a little differently which lead to some confusion before I found the compose examples nested in the project.

Specifically, the entrypoint is the start.sh script, which looks for environment variables to declare the single device settings or config file.

As a user, I expected to be able to run something like docker run mikrotik-exporter "--config-file <config-file" using the same argument structure that was in the readme.

I would recommend adding a "Running with Docker" section that lists the available/required environment variables.

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

No branches or pull requests

1 participant