aboutsummaryrefslogtreecommitdiff
path: root/docs/shoelaces.8.scd
diff options
context:
space:
mode:
authorRaul Benencia <raul@thousandeyes.com>2021-01-12 16:57:26 -0800
committerRaul Benencia <46945030+raul-te@users.noreply.github.com>2021-01-13 10:50:35 -0800
commitcfa915142c2bbff8d1572488b6343e56dfef9b64 (patch)
tree66961e8009fb10e84ddec3b55633d8cd4769cff8 /docs/shoelaces.8.scd
parentfa13436d4ceba235081c9eedb8d6f586ea21e7aa (diff)
Segregate BindAddr and BaseURL
Diffstat (limited to 'docs/shoelaces.8.scd')
-rw-r--r--docs/shoelaces.8.scd20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/shoelaces.8.scd b/docs/shoelaces.8.scd
index ec38101..492b452 100644
--- a/docs/shoelaces.8.scd
+++ b/docs/shoelaces.8.scd
@@ -10,6 +10,15 @@ shoelaces - automated server bootstrapping
# OPTIONS
+*-base-url* <string>
+ Optional parameter. Specifies the base address that will be used when
+ generating URLs.
+ If it's not specified, the value of "-bind-addr" will be used.
+
+*-bind-addr* <host:port>
+ The address where Shoelaces will listen for requests. Defaults to
+ "localhost:8081".
+
*-config* <config>
Specifies a config file. All the following options can be specified in
the config.
@@ -20,10 +29,6 @@ shoelaces - automated server bootstrapping
*-debug*
Enables debug mode.
-*-domain* <hostname>
- Specifies the address where the server is going to listen.
- Defaults to "localhost".
-
*-env-dir* <directory>
Specifies a directory with environment overrides. Refer to the README of
the project for more information about environment overrides.
@@ -32,10 +37,6 @@ shoelaces - automated server bootstrapping
Specifies a mappings YAML file. Defaults to "mappings.yaml". Refer to the
README of the project for more information about mappings.
-*-port* <port>
- Specifies the port where the server is going to listen.
- Defaults to 8080.
-
*-static-dir* <directory>
Specifies a custom web directory with static files. Defaults to "web".
@@ -73,8 +74,7 @@ specified.
Here is example config file:
```
-port=8081
-domain=localhost
+bind-addr=localhost:8081
data-dir=/etc/shoelaces/data-dir/
template-extension=.slc
mappings-file=mappings.yaml
nihil fit ex nihilo