Skip to content

Commit

Permalink
docs(readme)
Browse files Browse the repository at this point in the history
  • Loading branch information
FGRibreau committed Sep 15, 2015
1 parent 53479c8 commit 3806a5e
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,45 @@ Advanced configuration:

#### How to start Redsmin proxy

###### Docker
##### Docker

###### Start and connect Redsmin proxy to an network-wide available Redis

```bash
docker run -it --rm --name redsmin-proxy -e REDSMIN_KEY=5069597bb849097c1000000f -e REDIS_URI="redis://192.168.3.50:6379" redsmin/proxy
```

Where `redis://192.168.3.50:6379` will be the ip address and port of the running Redis server.

###### Start and connect Redsmin proxy to an Redis container

Let first say you've started a Redis container:

```bash
docker run --name my-redis --rm redis
```

You can now start the redsmin-proxy container with:
You can [link](https://docs.docker.com/userguide/dockerlinks/) redsmin proxy container to the redis one with `--link:

```bash
docker run -it --rm --name redsmin-proxy --link my-redis:local-redis -e REDSMIN_KEY=YOUR_KEY -e REDIS_URI="redis://local-redis:6379" redsmin/proxy
```

###### Docker auto-restart

If you want to leverage docker [auto-restart docker feature](https://docs.docker.com/reference/run/#restart-policies-restart), use the `--restart=always` command.

###### MacOS, Debian/Ubuntu
======================================================================

##### MacOS, Debian/Ubuntu

```bash
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token" redsmin
```

###### Windows
======================================================================

##### Windows

```bash
set REDIS_URI="redis://127.0.0.1:6379"
Expand Down

0 comments on commit 3806a5e

Please sign in to comment.