diff options
| author | elijah <elijah@riseup.net> | 2013-06-22 16:05:42 -0700 |
|---|---|---|
| committer | elijah <elijah@riseup.net> | 2013-06-22 16:05:42 -0700 |
| commit | 5e12c1711f3576be6ef07f54a68883999c4f2063 (patch) | |
| tree | 40bd5ecb57583c7f8959e9f09ba2ecbd95f5bf31 /docs | |
| parent | e200826e8fbc81fb3712b4f6754f5c5fe082e2fa (diff) | |
added note about common config options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/config.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/platform/config.md b/docs/platform/config.md index 209998e..d0b1f6a 100644 --- a/docs/platform/config.md +++ b/docs/platform/config.md @@ -108,6 +108,21 @@ The `provider_base` directory is under the `leap_platform` specified in the file To see all the variables a node has inherited, you could run `leap inspect willamette`. +Common configuration options +---------------------------------------- + +You can use the command `leap inspect` to see what options are available for a provider, node, service, or tag configuration. For example: + +* `leap inspect common` -- show the options inherited by all nodes. +* `leap inspect --base common` -- show the common.json from `provider_base` without the local `common.json` inheritance applied. +* `leap inspect webapp` -- show all the options available for the service `webapp`. + +Here are some of the more important options you should be aware of: + +* `ip_address` -- Required for all nodes, no default. +* `ssh.port` -- The SSH port you want the node's OpenSSH server to bind to. This is also the default when trying to connect to a node, but if the node currently has OpenSSH running on a different port then run deploy with `--port` to override the `ssh.port` configuration value. +* `mosh.enabled` -- If set to `true`, then mosh will be installed on the server. The default is `false`. + Macros ---------------------------------------- |