Skip to content

Commit

Permalink
docs(readme): add commands for windows
Browse files Browse the repository at this point in the history
  • Loading branch information
FGRibreau committed Mar 29, 2015
1 parent f5a6402 commit e2a9dd7
Showing 1 changed file with 73 additions and 9 deletions.
82 changes: 73 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,62 @@ Redsmin proxy securely expose one [or more](https://redsmin.uservoice.com/knowle

We announce changes on our Twitter account [@redsmin](https://twitter.com/redsmin) and our [Facebook page](https://www.facebook.com/redis.redsmin).

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

#### [Changelog](/CHANGELOG.md)

### How to start Redsmin proxy
#### How to start Redsmin proxy

- MacOS, Debian/Ubuntu:

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

### How to start Redsmin proxy with a password protected redis
- Windows:

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

#### How to start Redsmin proxy with a password protected redis

- MacOS, Debian/Ubuntu:

```bash
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
- Windows:

```bash
set REDIS_URI="redis://127.0.0.1:6379"
set REDIS_AUTH="auth-pass"
set REDSMIN_KEY="redsmin-token"
redsmin
```

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

- MacOS, Debian/Ubuntu:

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

- Windows:

```bash
set REDIS_URI="/tmp/redis.sock"
set 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
#### How to start Redsmin proxy reading a configuration file

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

Expand All @@ -44,11 +76,22 @@ First create a json configuration file, for instance `/etc/redsmin.json`:

Then start redsmin proxy with:

- MacOS, Debian/Ubuntu:

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

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

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

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

- MacOS, Debian/Ubuntu:

```bash
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token1" redsmin &
Expand All @@ -57,17 +100,38 @@ 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 &
```

- Windows:

```bash
set REDIS_URI="redis://127.0.0.1:6379"
set REDSMIN_KEY="redsmin-token1"
START /B redsmin

set REDIS_URI="redis://127.0.0.1:6380"
set REDSMIN_KEY="redsmin-token2"
START /B redsmin

set REDIS_URI="redis://127.0.0.1:6381"
set REDSMIN_KEY="redsmin-token3"
START /B redsmin

set REDIS_URI="redis://127.0.0.1:6382"
set REDSMIN_KEY="redsmin-token4"
START /B redsmin
```


Note: of course we could have used multiple `CONFIG_FILE` instead of environment variables.

### I'm behind a firewall, what rule should I add ?
#### 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
#### Uninstall

```bash
npm uninstall redsmin -g
```

[Changelog](/CHANGELOG.md)

0 comments on commit e2a9dd7

Please sign in to comment.