diff options
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 279e5bd6..085f9c66 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -4,25 +4,24 @@ Configuration ============= -See the following pages for Configuration Information: +.. note:: + * This section is used to describe the options a software component offers for configuration. -.. toctree:: - :maxdepth: 1 + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. - Single-Site Install <single> - Multi-Site Install <multi> - Authentication <authentication> +Example ... -.. Example ... +You can provide the following in ``basic.conf`` -.. You can provide the following in ``basic.conf`` +``host=ADDRESS`` + The address of the host -.. ``host=ADDRESS`` -.. The address of the host +``port=PORT`` + The port used for signaling -.. ``port=PORT`` -.. The port used for signaling - -.. Optional. Default: ``8080`` + Optional. Default: ``8080`` |