From 1d8ff68034afa5fef843df4a64d0b5ecf10cc0be Mon Sep 17 00:00:00 2001 From: FG Ribreau Date: Sun, 29 Mar 2015 14:38:21 +0200 Subject: [PATCH] docs(readme): add environment variables --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 430e15d..94880b6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![npm](https://nodei.co/npm/redsmin.png) -Redsmin proxy securely expose one [or more](https://redsmin.uservoice.com/knowledgebase/articles/169404-how-to-run-multiple-redsmin-daemons-on-the-same-se) local Redis instance to [Redsmin](https://redsmin.com). +Redsmin proxy securely connects one or more(https://redsmin.uservoice.com/knowledgebase/articles/169404-how-to-run-multiple-redsmin-daemons-on-the-same-se) locally available Redis instance to [Redsmin](https://redsmin.com). We announce changes on our Twitter account [@redsmin](https://twitter.com/redsmin) and our [Facebook page](https://www.facebook.com/redis.redsmin). @@ -11,6 +11,21 @@ We announce changes on our Twitter account [@redsmin](https://twitter.com/redsmi #### [Changelog](/CHANGELOG.md) +#### Environment variables options: + +- `CONFIG_FILE`: configuration file to read (if any), default: `/path/to/redsmin-proxy/etc/redsmin.json` + +- `REDIS_URI`: Redis URI or socket path, default `redis://127.0.0.1:6379` +- `REDIS_AUTH`: Redis authenticat password, default `null` + +- `REDSMIN_KEY`: your Redsmin server connection key, default `''` + +Advanced configuration: + +- `REDSMIN_PORT`: where redsmin proxy should connect, default: `993` +- `REDSMIN_HOSTNAME`: where redsmin proxy should connect, default `ssl.redsmin.com` +- `DEBUG`: debug mode, default `false` + #### How to start Redsmin proxy - MacOS, Debian/Ubuntu: @@ -123,6 +138,26 @@ START /B redsmin Note: of course we could have used multiple `CONFIG_FILE` instead of environment variables. +#### How to keep redsmin proxy up once I disconnect + +On MacOS, Ubuntu/Debian, the simplest way is to use [screen](http://www.rackaid.com/blog/linux-screen-tutorial-and-how-to/): + +``` +# start screen +screen +# start redsmin-proxy +REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token1" redsmin +# Ctrl+A+D to detach from screen +# and then to reattach to the screen session: +screen -r +``` + +But you could also use [Upstart](http://upstart.ubuntu.com/), [systemd](http://www.freedesktop.org/wiki/Software/systemd/), [supervisord](http://supervisord.org/) or [pm2](https://github.com/Unitech/PM2) on these system. + +On Windows you will need to [create a service](http://support.microsoft.com/en-us/kb/251192) or use [pm2](https://github.com/Unitech/PM2). + +**We will happily merge into this repository any pull-request describing a configuration file for one of the above process runner (or any other one).** + #### 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-).