README.md in envoy-proxy-0.0.17 vs README.md in envoy-proxy-0.0.18
- old
+ new
@@ -32,34 +32,41 @@
## Advanced Client Configuration
The client will search up from the current directory for a .envoy file. If it
exists, it must be a YAML file containing either one hash of command line
-options, or an array of multiple options. This file can also contain settings
-which will execute a command if a local connection is refused.
+options, or an array of multiple options. If an array is passed, the client
+will proxy multiple local services.
-| Option | Description | Default |
-| ------------- | ----------------------- | - |
-| `host` | The domain name prefix | None |
-| `local_port` | The local port to use | None |
-| `local_host` | The local host to use | 127.0.0.1 |
-| `server_host` | The server host to use | p45.eu |
-| `server_port` | The server port to use | 8282 |
-| `tls` | Use TLS in the server connections | false |
-| `verbose` | Be noisy | false |
-| `command` | A command to run if a local connection is refused | None |
-| `command_delay` | Number of seconds to wait before reconnecting, after starting a command | 1 |
-| `dir` | A directory to change to | . |
+This file can also contain settings which will execute a command if a local
+connection is refused.
+ Option Description Default
+ ---------------------------------------------------------------------------
+ host The domain name prefix None
+ local_port The local port to use None
+ local_host The local host to use 127.0.0.1
+ server_host The server host to use p45.eu
+ server_port The server port to use 8282
+ tls Use TLS in the server connections false
+ verbose Be noisy false
+ command A command to run if a local connection is refused None
+ delay Number of seconds to wait before reconnecting, 1
+ after starting a command
+ dir A directory to change to None
+
If no host is specified, a random one is selected by the server.
If no local port is specified, a random one is selected by the client.
The command is processed for % substitions against the configuration hash,
including any randomly selected local port.
-e.g. To start a rails app, you might use this configuration:
+e.g. To start a set of rails apps, you might use this configuration:
- host: my_app
- dir: ~/apps/my_app
- command: rails s -p %{local_port}
+ - host: backend
+ dir: ~/apps/backend
+ command: rails s -p %{local_port}
+ - host: frontend
+ dir: ~/apps/frontend
+ command: rails s -p %{local_port}
You can still specify a constant local port, if you prefer that.