Added clarification about importance of DefaultInterface configuration #139
Conversation
Signed-off-by: Matt Oswalt <[email protected]>
docs/installconfig/configure.rst
Outdated
| @@ -4,12 +4,21 @@ Configuring ToDD | |||
| ToDD uses configuration files (typically found in ``/etc/todd``) to control it's behavior. The server and the agent use their own individual config files, and sample files are shown below. | |||
There was a problem hiding this comment.
I would also break second sentence in two. Maybe:
The server and the agent each use their own individual config files. Samples are shown below.
docs/installconfig/configure.rst
Outdated
|
|
||
| .. WARNING:: | ||
|
|
||
| Pay particular note to he LocalResources section of the configuration. The DefaultInterface option is required (or in lieu thereof, the IPAddrOverride option) so that the server will know what IP address to serve assets from to the agents. The server will not successfully start if an address is not determined. |
There was a problem hiding this comment.
You might consider formatting marks around "LocalResources", "DefaultInterface", "IPAddrOverride" - e.g. put `` around each.
There was a problem hiding this comment.
I would write "The server will not successfully start if an address is not determined" as
"The server will not start if it cannot determine its IP address." Minor style thing though, so it's not important.
docs/installconfig/configure.rst
Outdated
|
|
||
| Pay particular note to he LocalResources section of the configuration. The DefaultInterface option is required (or in lieu thereof, the IPAddrOverride option) so that the server will know what IP address to serve assets from to the agents. The server will not successfully start if an address is not determined. | ||
|
|
||
| If this is configured, but incorrectly, agents may not retrieve the required asset files and will therefore fail to register with the server. |
There was a problem hiding this comment.
Could make it more simpler with "If this is configured incorrectly, agents will be unable to retrieve the required asset files, and will fail to register with the server."
Signed-off-by: Matt Oswalt <[email protected]>
|
@LindsayHill All great comments - thanks! |
Just adding some clarification about DefaultInterface since this code was recently changed, and several issues have illuminated shortcomings in the current docs.
Closes #113