Skip to content

Commit 3cdf940

Browse files
committed
[DOC] Add more detail in the quickstart guide for setup with ember-cli-deploy-redis.
1 parent 5d1c189 commit 3cdf940

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,32 @@ To get up and running quickly, do the following:
2626
$ ember install ember-cli-deploy-ssh-tunnel
2727
```
2828

29-
- Place the following configuration into `config/deploy.js`
29+
- For typical usage with `ember-cli-deploy-redis`, place the following configuration into `config/deploy.js`.
3030

3131
```javascript
3232
ENV['ssh-tunnel'] = {
3333
username: 'yourname',
3434
host: 'yourserver',
35+
36+
// A unique port on your local machine to forward to on the remote
37+
// server. This will be set to a random port between 49151 and 65535
38+
// by default.
39+
// srcPort: <49151 - 65535>,
40+
41+
// The port that the remote redis server listens on. 6379 is the default value.
42+
// dstPort: 6379
3543
};
44+
45+
ENV.redis.host = 'localhost':
46+
47+
// ember-cli-redis will connect to redis locally on `ENV['ssh-tunnel'].srcPort`.
48+
// Transmissions on that port will be forwarded over SSH and be received on
49+
// the remote machine on `ENV['ssh-tunnel'].dstPort`.
50+
// With `ember-cli-deploy-redis >= 0.1.1` `ENV.redis.port` will default
51+
// to `ENV['ssh-tunnel'].srcPort` if available. On lower versions
52+
// you must explicitly set it to match `ENV['ssh-tunnel'].srcPort.
53+
//
54+
// ENV.redis.port = 49151;
3655
```
3756

3857
- Run the pipeline

0 commit comments

Comments
 (0)