Deployment Platform/Gateway: Difference between revisions
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Background == | == Background == | ||
This is [[Deployment_Platform/Deployment|one of possible]] deployment scenarios | This is [[Deployment_Platform/Deployment|one of the possible]] deployment scenarios for [[Deployment Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students. | ||
<big>'''Targeting environment'''</big> | |||
The standard targeting environment | The standard targeting environment assumes: | ||
* | * Dedicated hardware for school server; | ||
* Client machines connected via Intranet to the server. | * Client machines connected via Intranet to the server. | ||
The final environment might be similar. | |||
== Server side == | == Server side == | ||
| Line 14: | Line 15: | ||
=== Run Sugar Network node === | === Run Sugar Network node === | ||
[[Sweets_Distribution#Add_repository|Attach]] | [[Sweets_Distribution#Add_repository|Attach]] 0.94:SugarNetwork [[Sweets Distribution]] repository and install the {{Code|sugar-network}} package. | ||
Before running server, populate the {{Code|/etc/sugar-network/config}} configuration file with content similar to following (to get full list of configuration options, call the {{Code|sugar-network-node config}} command): | Before running installed server, populate the {{Code|/etc/sugar-network/config}} configuration file with content similar to the following (to get the full list of configuration options, call the {{Code|sugar-network-node config}} command): | ||
[main] | [main] | ||
# debug logging level; 0 means only warning and errors | |||
debug = 3 | |||
# path to a directory to place log files | # path to a directory to place log files | ||
logdir = /var/log/sugar-network | logdir = /var/log/sugar-network | ||
| Line 33: | Line 37: | ||
port = 8000 | port = 8000 | ||
# | # directories to place server data | ||
data-root = /var/lib/sugar-network | data-root = /var/lib/sugar-network/db | ||
files-root = /var/lib/sugar-network/files | |||
stats-root = /var/lib/sugar-network/stats | |||
# switch off user credentials check; disabling this option will require | # switch off user credentials check; disabling this option will require | ||
| Line 40: | Line 46: | ||
trust-users = True | trust-users = True | ||
Make sure that all directories in config file are created and current user | Make sure that all directories in the config file are created and the current user has write permissions there. | ||
Run node server: | Run node server: | ||
| Line 50: | Line 56: | ||
=== Synchronization with master node === | === Synchronization with master node === | ||
Note that newly installed Sugar Network node will be empty, its content should be fetched from the master node. | Note that the newly installed Sugar Network node will be empty, its content should be fetched from the master node. | ||
If school server has Internet connectivity, launch {{Code|sugar-network-node}} and start online synchronization: | If school server has Internet connectivity, launch {{Code|sugar-network-node}} and start online synchronization: | ||
| Line 60: | Line 66: | ||
sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES'' | sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES'' | ||
The {{Code|PATH-TO-PLACE-SYNCHRONIZATION-FILES}} path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running the {{Code|sugar-network-sync}} shell script (which will be created by {{Code|offline-sync}} command in targeting path) in environment with Internet connectivity. Then, re-run {{Code|offline-sync}} command specifying path with new file synchronization files. | |||
== Client side == | == Client side == | ||
<big>'''Configuration'''</big> | |||
Clients should be pointed to the Sugar Network node launched on a school server. Populate {{Code|/etc/sweets.conf}} configuration file with the following options: | Clients should be pointed to the Sugar Network node launched on a school server. Populate the {{Code|/etc/sweets.conf}} configuration file with the following options: | ||
[client] | [client] | ||
api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000 | api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000 | ||
<big>'''Run Sugar Network clients'''</big> | |||
Follow the [[Sugar_Network#On_desktop|Try it]] install instructions to setup Sugar Network client. | |||
While working, Sugar Network client logs can be found in the {{Code|~/.sugar/default/logs/sugar-network-client}} file. The logging verbosity level depends on the [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging|global Sugar setting]]. | |||
== Getting involved == | |||
{{:Deployment_Platform/Feedback}} | |||