docs/templates/sections/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Configuration
   5 =============
   6
   7 .. note::
   8    * This section is used to describe the options a software component offers for configuration.
   9
  10    * Configuration is typically: provided for platform-component and sdk projects;
  11      and referenced in developer and user guides.
  12
  13    * This note must be removed after content has been added.
  14
  15
  16
  17 Example ...
  18
  19 You can provide the following in ``basic.conf``
  20
  21 ``host=ADDRESS``
  22   The address of the host
  23
  24 ``port=PORT``
  25   The port used for signaling
  26
  27   Optional. Default: ``8080``