Platform Team/Sugar Network/Implementation: Difference between revisions
No edit summary |
|||
| Line 19: | Line 19: | ||
== sugar-network-node == | == sugar-network-node == | ||
This application provides Sugar Network server functionality. Such functionality provided via the Sugar Network [[Platform_Team/Sugar_Network/API|API]]. | |||
The configuration occurs based on several sources (sorted by applied order): | |||
* Command-line arguments (configuration names equal to command-line arguments), | |||
* {{Code|/etc/sugar-network/config}} system-wide configuration file, | |||
* {{Code|~/.config/sugar-network/config}} user-wide configuration file. | |||
To get the current configuration, call: | |||
sugar-network-node config | |||
The major configuration options are: | |||
[node] | |||
# path to a directory to place server data | |||
data-root = /var/lib/sugar-network | |||
# hostname to listen for incomming connections and using for publicly visible urls | |||
host = 0.0.0.0 | |||
# port number to listen incomming connections | |||
port = 8000 | |||
Note that `sugar-network-node` needs OpenSSH-5.6 or later to verify users' credentials. If you don't have such version, enable `--trust-users` to disable any verification: | |||
[node] | |||
# switch off user credentials check; disabling this option will require OpenSSH-5.6 or later | |||
trust-users = True | |||
Assuming that configuration was set properly, use the following commands to manipulate `sugar-network-node` daemon: | |||
sugar-network-node start | |||
sugar-network-node stop | |||
sugar-network-node status | |||
To run application in the foreground instead of switching to daemon mode, call: | |||
sugar-network-node -F start | |||
Optionally (next releases might have WebUI as a separate application), it is possible to run [[Platform_Team/Sugar_Network/Web_UI|Web UI]] client from the same process if the following configuration options were set: | |||
[webui] | |||
# start web application to serve Sugar Network content | |||
webui = True | |||
# hostname to bind | |||
webui-host = 0.0.0.0 | |||
# address to listen for Web clients | |||
webui-port = 5000 | |||
== sugar-network-client == | == sugar-network-client == | ||