aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d2ce3d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Hyperbola Mirror for docker
+
+Synchronize Hyperbola repo with docker
+
+```console
+$ cp -v config.env.example config.env
+```
+
+```console
+$ docker-compose up -d
+```
+
+## Build container from source
+
+To rebuild this container, copy this repository locally and run:
+
+```console
+$ docker build --no-cache --tag rusian/hypermirror -f Dockerfile .
+```
+
+## License
+
+This work is licensed under the [GNU GPLv3+](LICENSE)