From eca7262c69dcc01e7e894b45fa5bcbb2cdbac565 Mon Sep 17 00:00:00 2001 From: m1k1o Date: Sat, 3 Apr 2021 19:07:20 +0200 Subject: [PATCH] update roadmap, mention #1. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index fc36761..6b2e1e3 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ https://www.youtube.com/watch?v=cCmnw-pq0gA You only need `.env.example`, `docker-compose.yml` and `traefik/`. +You don't need to have traefik as your entrypoint reverse proxy. In that case you can use `docker-compose.http.yml` that will expose this service to `APP_PORT`. + ### Step 1 Copy `.env.example` to `.env` and customize. @@ -61,10 +63,32 @@ chmod 600 traefik/acme.json Update your email in `traefik/traefik.yml`. +### Download images / update + +You need to pull all your images, that you want to use with neko-room. Otherwise you might get this error: `Error response from daemon: No such image:` (see issue #1). + +```sh +docker pull m1k1o/neko:latest +docker pull m1k1o/neko:chromium +# etc... +``` + +If you want to update neko image, you need to pull new image and recreate all rooms, that use old image. To update neko rooms, simpy run: + +```sh +docker-compose pull +docker-compose up -d +``` + ### Roadmap: - [x] add GUI - [x] add HTTPS support - [x] add authentication provider for traefik + - [ ] allow specifying custom ENV variables + - [ ] allow mounting direcotries for persistent data + - [ ] add upgrade button + - [ ] auto pull images, that do not exist - [ ] add bearer token to for API - [ ] add docker ssh / tcp support - [ ] add docker swarm support + - [ ] add k8s support