Skip to content

Commit

Permalink
docs(readme): now Redsmin Proxy API (also issue 2 is already fixed #2)
Browse files Browse the repository at this point in the history
  • Loading branch information
FGRibreau committed Mar 29, 2015
1 parent 488c1f8 commit f5a6402
Showing 1 changed file with 43 additions and 8 deletions.
51 changes: 43 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,60 @@ We announce changes on our Twitter account [@redsmin](https://twitter.com/redsmi

### [Installation](https://redsmin.uservoice.com/knowledgebase/articles/121169-can-i-manage-redis-instances-only-accessible-from-)

### CLI options

### How to start Redsmin proxy

```bash
RKEY=REDSMIN_CONNECTION_KEY [RURL=redis://127.0.0.1:6379] [RAUTH=password] redsmin set_key
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token" redsmin
```

### I'm behind a firewall, what rule should I add ?
### How to start Redsmin proxy with a password protected redis

Redsmin proxy connects to `ssl.redsmin.com` on port `993` with a secure [TLS socket connection](https://en.wikipedia.org/wiki/Transport_Layer_Security). For troubleshooting: [What ip/port should I locally open to use Redsmin proxy](https://redsmin.uservoice.com/knowledgebase/articles/274294-what-ip-port-should-i-locally-open-to-use-redsmin-).
```
REDIS_URI="redis://127.0.0.1:6379" REDIS_AUTH="auth-pass" REDSMIN_KEY="redsmin-token" redsmin
```

### How to start Redsmin proxy with a redis listening on a unix-socket

```
REDIS_URI="/tmp/redis.sock" REDSMIN_KEY="5517e20046f4c7530d000357" redsmin
```

Note: you may need to use `sudo` to access to the socket.

### How to start Redsmin proxy reading a configuration file

------------------
First create a json configuration file, for instance `/etc/redsmin.json`:

### Edit configuration
```json
{
"key": "redsmin-token",
"redis": "redis://127.0.0.1:6379",
"auth": ""
}
```

Then start redsmin proxy with:

```bash
CONFIG_FILE="/etc/redsmin.json" redsmin
```

### How to run multiple Redsmin proxy daemons on the same server

```bash
vim "`npm prefix -g`/lib/node_modules/redsmin/etc/redsmin.json"
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token1" redsmin &
REDIS_URI="redis://127.0.0.1:6380" REDSMIN_KEY="redsmin-token2" redsmin &
REDIS_URI="redis://127.0.0.1:6381" REDSMIN_KEY="redsmin-token3" redsmin &
REDIS_URI="redis://127.0.0.1:6382" REDSMIN_KEY="redsmin-token4" redsmin &
```

See: [How to change Redsmin proxy Redis host/port](https://redsmin.uservoice.com/knowledgebase/articles/166408-how-to-change-redsmin-proxy-redis-host-port).
Note: of course we could have used multiple `CONFIG_FILE` instead of environment variables.

### I'm behind a firewall, what rule should I add ?

Redsmin proxy connects to `ssl.redsmin.com` on port `993` with a secure [TLS socket connection](https://en.wikipedia.org/wiki/Transport_Layer_Security). For troubleshooting: [What ip/port should I locally open to use Redsmin proxy](https://redsmin.uservoice.com/knowledgebase/articles/274294-what-ip-port-should-i-locally-open-to-use-redsmin-).


### Uninstall

Expand Down

0 comments on commit f5a6402

Please sign in to comment.