initial commit

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d55cf22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# MicroLab
+
+Docker image of [Hyperbola GNU plus Linux-libre](https://www.hyperbola.info/) with
+[tmate](https://github.com/nviennot/tmate) client support access via **SSH** or **HTTPS**
+and with [HyperTerm](https://git.sr.ht/~heckyel/hyperterm) support.
+
+## Docker
+
+```console
+$ docker run --name microlab --hostname hyperbola.info -it -e API_KEY=<YOUR-KEY> -e NAME_SESSION=<YOUR-SESSION-NAME> -d rusian/microlab
+```
+
+## Docker compose
+
+Set `API_KEY` and `NAME_SESSION` in the file `micro.env`
+
+```console
+$ cp -v micro.env.sample micro.env
+```
+
+Run:
+
+```console
+$ docker-compose up -d
+```
+
+## Build image docker
+
+```console
+$ cd microlab/core
+```
+
+```console
+$ docker build --no-cache --tag rusian/microlab -f Dockerfile .
+```
+
+## License
+
+This work is licensed under the [GNU GPLv3+](LICENSE)