From a963c7c538c9cd49438ab267a38a48e39a8391bc Mon Sep 17 00:00:00 2001 From: Alexandre Bouthinon Date: Sun, 10 Jan 2021 22:33:23 +0100 Subject: [PATCH] Update Readme and Docker Compose file improving the DX on first use --- README.md | 12 ++++++------ docker-compose.demo.yml | 1 - docker-compose.dev.yml | 13 ++++++------- 3 files changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b7ad771..33680ea 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,9 @@ You can found a demonstration Docker Compose file (`docker-compose.demo.yml`) in TRAEFIK_PILOT_TOKEN="xxxx" docker-compose -f docker-compose.demo.yml up -d ``` This will launch: -* A complete Kuzzle stack (Kuzzle, Elasticsearch and Redis containers) -* A Traefik instance with dashboard and latest released plugin version enabled and only available using `admin` Kuzzle user -* A `whoami` instance available using both `admin` and `developer` Kuzzle users +* A complete [Kuzzle stack](http://localhost:7512) (Kuzzle, Elasticsearch and Redis containers). +* A Traefik instance with [dashboard](http://traefik.localhost) and latest released plugin version enabled and only available using `admin` Kuzzle user +* A [`whoami` instance](http://whoami.localhost) available using both `admin` and `developer` Kuzzle users Once all containers are started and healthy, you can use the [Kuzzle Admin Console](https://next-console.kuzzle.io) to create your users (`admin` and `developer`). @@ -151,9 +151,9 @@ You can found a development Docker Compose file (`docker-compose.dev.yml`) in th TRAEFIK_PILOT_TOKEN="xxxx" docker-compose -f docker-compose.dev.yml up -d ``` This will launch: -* A complete Kuzzle stack (Kuzzle, Elasticsearch and Redis containers) -* A Traefik instance with dashboard and local plugin enabled and only available using `admin` Kuzzle user -* A `whoami` instance available using both `admin` and `developer` Kuzzle users +* A complete [Kuzzle stack](http://localhost:7512) (Kuzzle, Elasticsearch and Redis containers). +* A Traefik instance with [dashboard](http://traefik.localhost) and latest released plugin version enabled and only available using `admin` Kuzzle user +* A [`whoami` instance](http://whoami.localhost) available using both `admin` and `developer` Kuzzle users Once all containers are started and healthy, you can use the [Kuzzle Admin Console](https://next-console.kuzzle.io) to create your users (`admin` and `developer`). diff --git a/docker-compose.demo.yml b/docker-compose.demo.yml index 261fc41..4062c8f 100644 --- a/docker-compose.demo.yml +++ b/docker-compose.demo.yml @@ -13,7 +13,6 @@ services: condition: service_healthy command: - "--api.dashboard=true" - - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - "--entrypoints.web.address=:80" diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index 0df06ba..bb67111 100644 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -13,7 +13,6 @@ services: condition: service_healthy command: - "--api.dashboard=true" - - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - "--entrypoints.web.address=:80" @@ -25,9 +24,9 @@ services: - "traefik.http.routers.dashboard.entrypoints=web" - "traefik.http.routers.dashboard.rule=Host(`traefik.localhost`)" - "traefik.http.routers.dashboard.service=api@internal" - - "traefik.http.routers.dashboard.middlewares=kuzzle-auth" - - "traefik.http.middlewares.kuzzle-auth.plugin.dev.kuzzle.url=http://kuzzle:7512" - - "traefik.http.middlewares.kuzzle-auth.plugin.dev.kuzzle.allowedUsers=admin" + - "traefik.http.routers.dashboard.middlewares=kuzzle-auth-dashboard" + - "traefik.http.middlewares.kuzzle-auth-dashboard.plugin.dev.kuzzle.url=http://kuzzle:7512" + - "traefik.http.middlewares.kuzzle-auth-dashboard.plugin.dev.kuzzle.allowedUsers=admin" ports: - "80:80" volumes: @@ -94,6 +93,6 @@ services: - "traefik.enable=true" - "traefik.http.routers.whoami.rule=Host(`whoami.localhost`)" - "traefik.http.routers.whoami.entrypoints=web" - - "traefik.http.routers.whoami.middlewares=kuzzle-auth" - - "traefik.http.middlewares.kuzzle-auth.plugin.dev.kuzzle.url=http://kuzzle:7512" - - "traefik.http.middlewares.kuzzle-auth.plugin.dev.kuzzle.allowedUsers=admin,developer" + - "traefik.http.routers.whoami.middlewares=kuzzle-auth-whoami" + - "traefik.http.middlewares.kuzzle-auth-whoami.plugin.dev.kuzzle.url=http://kuzzle:7512" + - "traefik.http.middlewares.kuzzle-auth-whoami.plugin.dev.kuzzle.allowedUsers=admin,developer"