From 6d68a2ccf4d6bc0b2e503df31de43361c82fb549 Mon Sep 17 00:00:00 2001 From: Henry Whitaker <36062479+henrywhitaker3@users.noreply.github.com> Date: Fri, 19 Jun 2020 22:04:01 +0100 Subject: [PATCH 1/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++ 2 files changed, 45 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..f01c4072 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Bug Report +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Context** + - OS: [e.g Docker, Ubuntu, etc.] + - Speedtest-Tracker Version: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..6b57679a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature Request]" +labels: enhancement +assignees: '' + +--- + +**Describe the feature** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. From fe35e13c12491ab46e43a1304b14c6077cc74f08 Mon Sep 17 00:00:00 2001 From: Henry Whitaker <36062479+henrywhitaker3@users.noreply.github.com> Date: Wed, 1 Jul 2020 00:30:50 +0100 Subject: [PATCH 2/2] Update README.md Added parameters for docker image to clarify params re issue #135 --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a3985ac4..b3664618 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,21 @@ docker create \ henrywhitaker3/speedtest-tracker ``` +#### Parameters + +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. + +| Parameter | Function | +| :----: | --- | +| `-p 8765:80` | Exposes the webserver on port 8765 | +| `-v /config` | All the config files reside here. | +| `-e OOKLA_EULA_GDPR` | Set to 'true' to accept the Ookla [EULA](https://www.speedtest.net/about/eula) and privacy agreement. If this is not set, the container will not start | +| `-e SLACK_WEBHOOK` | Optional. Put a slack webhook here to get slack notifications when a speedtest is run. To use discord webhooks, just append `/slack` to the end of your discord webhook URL | +| `-e TELEGRAM_BOT_TOKEN` | Optional. Telegram bot API token. | +| `-e TELEGRAM_CHAT_ID` | Optional. Telegram chat ID. | +| `-e PUID` | Optional. Supply a local user ID for volume permissions | +| `-e PGID` | Optional. Supply a local group ID for volume permissions | + ### Manual Install #### Installing Dependencies