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] 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 `<external>:<internal>` 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