Deployment Platform/Gateway - Revision history

Alsroot: /* Run Sugar Network node */

2013-08-21T03:06:27Z

Run Sugar Network node

← Older revision		Revision as of 23:06, 20 August 2013
Line 37:		Line 37:
	port = 8000		port = 8000

	# ~~path to a directory~~ to place server data		# 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

FGrose at 13:43, 12 August 2013

2013-08-12T13:43:22Z

← Older revision		Revision as of 09:43, 12 August 2013
Line 1:		Line 1:
	== Background ==		== Background ==

	This is [[Deployment_Platform/Deployment\|one of possible]] deployment scenarios of [[~~Deployment_Platform~~]]. This page is intended to describe procedures for school servers that behave as gateways for school students.		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>		<big>'''Targeting environment'''</big>

	The standard targeting environment~~, final environment might be similar,~~ assumes:		The standard targeting environment assumes:

	* Dedicated hardware for school server;		* 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 43:		Line 44:
	trust-users = True		trust-users = True

	Make sure that all directories in config file are created and current user ~~have~~ write permissions there.		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 53:		Line 54:
	=== 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 78:		Line 79:
	Follow the [[Sugar_Network#On_desktop\|Try it]] install instructions to setup Sugar Network client.		Follow the [[Sugar_Network#On_desktop\|Try it]] install instructions to setup Sugar Network client.

	While working, Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. ~~Logging~~ verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].		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 ==		== Getting involved ==

	{{:Deployment_Platform/Feedback}}		{{:Deployment_Platform/Feedback}}

Alsroot: /* Client side */

2013-06-04T06:20:28Z

Client side

← Older revision		Revision as of 02:20, 4 June 2013
Line 79:		Line 79:

	While working, Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].		While working, Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].

			== Getting involved ==

			{{:Deployment_Platform/Feedback}}

Alsroot at 15:09, 3 June 2013

2013-06-03T15:09:36Z

← Older revision		Revision as of 11:09, 3 June 2013
Line 3:		Line 3:
	This is [[Deployment_Platform/Deployment\|one of possible]] deployment scenarios of [[Deployment_Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students.		This is [[Deployment_Platform/Deployment\|one of possible]] deployment scenarios of [[Deployment_Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students.

	~~===~~ Targeting environment ~~===~~		<big>'''Targeting environment'''</big>

	The standard targeting environment, final environment might be similar, assumes:		The standard targeting environment, final environment might be similar, assumes:

	* ~~School~~ server;		* Dedicated hardware for school server;
	* Client machines connected via Intranet to the server.		* Client machines connected via Intranet to the server.

Line 14:		Line 14:
	=== Run Sugar Network node ===		=== Run Sugar Network node ===

	[[Sweets_Distribution#Add_repository\|Attach]] ~~''Factory''~~ [[Sweets Distribution]] repository and install {{Code\|sugar-network}} package.		[[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]
Line 63:		Line 63:
	sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES''		sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES''

	~~Last command~~ path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running {{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.		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 ==

	~~===~~ Configuration ~~===~~		<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

	~~===~~ Run Sugar Network clients ~~===~~		<big>'''Run Sugar Network clients'''</big>

	~~Right now,~~ the ~~easiest way~~ to ~~get working~~ Sugar Network ~~clients is using Sugar Shell with embedded Sugar Network support~~.		Follow the [[Sugar_Network#On_desktop\|Try it]] install instructions to setup Sugar Network client.

	~~On XO laptops~~, use [[Deployment_Platform/XO_reference_distribution#Try_reference_implementation\|one of reference images]] or final deployment ones like from [http://pe.sugarlabs.org/go/Proyecto_Piloto_Hexoquinasa Hexoquinasa] project.		While working, Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].

	~~On regular desktops:~~

	* [[Sweets_Distribution#Add_repository\|Attach]] ''Factory'' [[Sweets Distribution]] repository;
	* [[Sweets_Distribution#Installation\|Install]] {{Code\|sweets-desktop}} package;
	* [[Sweets_Distribution#Usage\|Run]] newly installed Sugar Shell;
	* By default, Sugar Shell looks the same as in pristine Glucose. To start using Sugar Network related improvements in the Shell UI, go to the Sweets Distribution component in the Control Panel, enable the integration checkbox, and restart Sugar. After restarting, [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] client will be available from the Activities tray and the F8 shortcut key. [[Sugar_Network/Contributor_Hub\|Contributor Hub]] client can be launched from F8 as regular Sugar Network application.

	Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].

Alsroot: /* Run Sugar Network node */

2013-03-14T09:40:47Z

Run Sugar Network node

← Older revision		Revision as of 05:40, 14 March 2013
Line 19:		Line 19:

	[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

Alsroot: /* Run Sugar Network clients */

2013-03-13T11:23:29Z

Run Sugar Network clients

← Older revision		Revision as of 07:23, 13 March 2013
Line 74:		Line 74:

	Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.		Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.

			On XO laptops, use [[Deployment_Platform/XO_reference_distribution#Try_reference_implementation\|one of reference images]] or final deployment ones like from [http://pe.sugarlabs.org/go/Proyecto_Piloto_Hexoquinasa Hexoquinasa] project.

	On regular desktops:		On regular desktops:

Alsroot: /* Synchronization with master node */

2013-03-13T11:14:10Z

Synchronization with master node

← Older revision		Revision as of 07:14, 13 March 2013
Line 49:		Line 49:

	=== 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.

			If school server has Internet connectivity, launch {{Code\|sugar-network-node}} and start online synchronization:

			sugar-network-node online-sync

			If only [[wikipedia:Sneakernet\|sneakernet]] is available:

			sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES''

			Last command path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running {{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 ==

Alsroot: /* Install Sugar Network clients */

2013-03-13T10:57:43Z

Install Sugar Network clients

← Older revision		Revision as of 06:57, 13 March 2013
Line 59:		Line 59:
	api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000		api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000

	=== ~~Install~~ Sugar Network clients ===		=== Run Sugar Network clients ===

	Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.		Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.
Line 69:		Line 69:
	* [[Sweets_Distribution#Usage\|Run]] newly installed Sugar Shell;		* [[Sweets_Distribution#Usage\|Run]] newly installed Sugar Shell;
	* By default, Sugar Shell looks the same as in pristine Glucose. To start using Sugar Network related improvements in the Shell UI, go to the Sweets Distribution component in the Control Panel, enable the integration checkbox, and restart Sugar. After restarting, [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] client will be available from the Activities tray and the F8 shortcut key. [[Sugar_Network/Contributor_Hub\|Contributor Hub]] client can be launched from F8 as regular Sugar Network application.		* By default, Sugar Shell looks the same as in pristine Glucose. To start using Sugar Network related improvements in the Shell UI, go to the Sweets Distribution component in the Control Panel, enable the integration checkbox, and restart Sugar. After restarting, [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] client will be available from the Activities tray and the F8 shortcut key. [[Sugar_Network/Contributor_Hub\|Contributor Hub]] client can be launched from F8 as regular Sugar Network application.

			Sugar Network client logs can be found {{Code\|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging\|global Sugar setting]].

Alsroot: Created page with "== Background == This is one of possible deployment scenarios of Deployment_Platform. This page is intended to describe procedures for ..."

2013-03-13T10:50:41Z

Created page with "== Background == This is one of possible deployment scenarios of Deployment_Platform. This page is intended to describe procedures for ..."

New page

== Background ==

This is [[Deployment_Platform/Deployment|one of possible]] deployment scenarios of [[Deployment_Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students.

=== Targeting environment ===

The standard targeting environment, final environment might be similar, assumes:

* School server;
* Client machines connected via Intranet to the server.

== Server side ==

=== Run Sugar Network node ===

[[Sweets_Distribution#Add_repository|Attach]] ''Factory'' [[Sweets Distribution]] repository and install {{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):

[main]
# path to a directory to place log files
logdir = /var/log/sugar-network

# path to a directory to place pid files
rundir = /var/run/sugar-network

# if specified, use this directory for cached files; such files might take
# considerable number of bytes
cachedir = /var/cache/sugar-network

[node]
host = 0.0.0.0
port = 8000

# path to a directory to place server data
data-root = /var/lib/sugar-network

# switch off user credentials check; disabling this option will require
# OpenSSH-5.6 or later
trust-users = True

Make sure that all directories in config file are created and current user have write permissions there.

Run node server:

sugar-network-node start

Server will start serving Sugar Network [[Platform_Team/Sugar_Network/API|API]] for clients from {{Code|host}}:{{Code|port}} specified in configuration file.

=== Synchronization with master node ===

== Client side ==

=== Configuration ===

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:

[client]
api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000

=== Install Sugar Network clients ===

Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.

On regular desktops:

* [[Sweets_Distribution#Add_repository|Attach]] ''Factory'' [[Sweets Distribution]] repository;
* [[Sweets_Distribution#Installation|Install]] {{Code|sweets-desktop}} package;
* [[Sweets_Distribution#Usage|Run]] newly installed Sugar Shell;
* By default, Sugar Shell looks the same as in pristine Glucose. To start using Sugar Network related improvements in the Shell UI, go to the Sweets Distribution component in the Control Panel, enable the integration checkbox, and restart Sugar. After restarting, [[Platform_Team/Sugar_Network/Web_UI|Web UI]] client will be available from the Activities tray and the F8 shortcut key. [[Sugar_Network/Contributor_Hub|Contributor Hub]] client can be launched from F8 as regular Sugar Network application.