Skip to content

Commit

Permalink
Adjusted docs to reflect new config mechanism for Redis. See #83
Browse files Browse the repository at this point in the history
  • Loading branch information
achwie committed Sep 15, 2017
1 parent a086555 commit fde1d80
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions doc/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,24 +105,14 @@ If everything is successful, you will now be able to access the API Portal at [`

#### Using Redis as session store

By default, the Portal UI will store session information in files on disk. This prevents the component from being deployed redundantly behind a load balancer for high availability. If HA is a requirement for the Portal UI, you can use [Redis](https://redis.io/) as a distributed session store. The session store is configured via three environment variables:
By default, the Portal UI will store session information in files on disk. This prevents the component from being deployed redundantly behind a load balancer for high availability. If HA is a requirement for the Portal UI, you can use [Redis](https://redis.io/) as a distributed session store. The session store is configured via the kickstarter in the section "IP Config". Don't forget to restart `portal-api` as well after you changed the configuration.

* `SESSION_STORE_TYPE`: Sets the session store type. Set to `redis` to use Redis (default: `file`).
* `SESSION_STORE_HOST`: Sets the session store host (default: `localhost`).
* `SESSION_STORE_PORT`: Sets the session store port (default: `6379`).

For an easy start, you can run Redis in a Docker container:
For an easy start, you can run Redis in a local Docker container:

```
$ docker run -p 6379:6379 redis
```

Then select Redis as session store when starting the Portal UI:

```
$ SESSION_STORE_TYPE=redis node bin/www
```


### Starting `kong-adapter`, `mailer` or `chatbot`

Expand Down Expand Up @@ -183,4 +173,4 @@ The following debugging scopes (`DEBUG=`) can be useful to know:
* `portal-chatbot:*`: Chatbot debugging
* `wicked-sdk`: Debugging messages from the [wicked SDK](https://www.npmjs.com/package/wicked-sdk), which is the base for kong adapter, mailer and chatbot (and partly the portal)

Make sure you define the `DEBUG` variable everywhere you need the debugging output.
Make sure you define the `DEBUG` variable everywhere you need the debugging output.

0 comments on commit fde1d80

Please sign in to comment.