Skip to content

Commit

Permalink
Update Readme and Docker Compose file improving the DX on first use
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrebouthinon committed Jan 10, 2021
1 parent 3dd0ebe commit a963c7c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand Down Expand Up @@ -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`).

Expand Down
1 change: 0 additions & 1 deletion docker-compose.demo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
13 changes: 6 additions & 7 deletions docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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:
Expand Down Expand Up @@ -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"

0 comments on commit a963c7c

Please sign in to comment.