From 35cb1967b6b9f58ec5819f5056f381d8b1080580 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonas=20M=C3=B6ller?= <mail@jonasmoeller.de>
Date: Tue, 22 Oct 2019 23:43:18 +0200
Subject: [PATCH] initial commit

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..066109a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# ooklaserver-docker
+
+Ookla Server for Linux/Unix as Docker container
+
+
+## How to use?
+
+Simply run the container:
+```sh
+docker run -p 8080:8080 -p 5060:5060 aledjones/ooklaserver
+```
+or use it in `docker-compose`:
+```yaml
+version: '3'
+services:
+  server:
+  image: aledjones/ooklaserver
+  restart: always
+  ports:
+    - 8080:8080
+    - 5060:5060
+```
+
+## Planned features
+
+- use ENV to initilize `OoklaServer.properties`
+- provide volumes to mount custom certificates as LE doesn't properly work inside the container
+
+## Register your server with Ookla
+
+Please refer to the guide [How To Install & Submit Server](https://support.ookla.com/hc/en-us/articles/234578568-How-To-Install-Submit-Server).
+
+Please be aware, that Ookla requires you to setup a fallback option with HTTP. Otherwise your server will not be listed. 
+