Platform Team/Sugar Network/Implementation - Revision history

Alsroot at 00:12, 5 June 2013

2013-06-05T00:12:38Z

← Older revision		Revision as of 20:12, 4 June 2013
Line 24:		Line 24:
	The configuration occurs based on several sources (sorted by applied order):		The configuration occurs based on several sources (sorted by applied order):

			* {{Code\|/etc/sugar-network.conf}} system-wide configuration file,
			* {{Code\|/etc/sugar-network.d}} directory with system-wide configuration files,
			* {{Code\|~/.config/sugar-network/config}} user-wide configuration file.
	* Command-line arguments (configuration names equal to command-line arguments),		* 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:		To get the current configuration, call:
Line 86:		Line 87:
	* Command-line arguments (configuration names equal to command-line arguments),		* Command-line arguments (configuration names equal to command-line arguments),
	* {{Code\|/etc/sweets.conf}} system-wide configuration file,		* {{Code\|/etc/sweets.conf}} system-wide configuration file,
			* {{Code\|/etc/sweets.d}} directory with system-wide configuration files,
	* {{Code\|~/.config/sweets/config}} user-wide configuration file,		* {{Code\|~/.config/sweets/config}} user-wide configuration file,
	* {{Code\|~/.sugar/''current-profile''/sweets.conf}} configuration specific to a Sugar profile, this configuration file is being created by Sugar Integration code in Sugar and better to avoid setting these options directly.		* {{Code\|~/.sugar/''current-profile''/sweets.conf}} configuration specific to a Sugar profile, this configuration file is being created by Sugar Integration code in Sugar and better to avoid setting these options directly.

Alsroot: /* sugar-network-client */

2013-03-19T16:47:31Z

sugar-network-client

← Older revision		Revision as of 12:47, 19 March 2013
Line 87:		Line 87:
	* {{Code\|/etc/sweets.conf}} system-wide configuration file,		* {{Code\|/etc/sweets.conf}} system-wide configuration file,
	* {{Code\|~/.config/sweets/config}} user-wide configuration file,		* {{Code\|~/.config/sweets/config}} user-wide configuration file,
	* {{Code\|~/.sugar/''current-profile''/sweets.conf}} configuration specific to a Sugar profile.		* {{Code\|~/.sugar/''current-profile''/sweets.conf}} configuration specific to a Sugar profile, this configuration file is being created by Sugar Integration code in Sugar and better to avoid setting these options directly.

	To get the current configuration, call:		To get the current configuration, call:

Alsroot: /* Usage */

2013-03-13T11:00:11Z

Usage

@@ Line 122: / Line 122: @@
 == Usage ==
-Assume we have two hosts, ''Node'' and ''Client'' (it might be the same real host though). ''Node'' host will be a Sugar Network server. The ''Client'' side will run Sugar Network integrated Sugar session to connect to the ''Node''. [[Sweets_Distribution#Add_repository|Attach]] ''Factory'' [[Sweets Distribution]] repository on both hosts.
+Depending on use-case, follow one of existing [[Deployment_Platform#Deployment_scenarios|usage scenarios]].
 == Sources ==

Alsroot: /* Usage */

2013-02-28T13:50:59Z

Usage

← Older revision		Revision as of 09:50, 28 February 2013
Line 137:		Line 137:
	# path to a directory to place pid files		# path to a directory to place pid files
	rundir = /var/run/sugar-network		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]		[node]

Alsroot: /* Usage */

2013-02-22T12:29:52Z

Usage

← Older revision		Revision as of 08:29, 22 February 2013
Line 149:		Line 149:
	trust-users = True		trust-users = True

	* Make sure that all ~~directory~~ in config file are created and current user have write permissions;		* Make sure that all directories in config file are created and current user have write permissions there;

	* Run node server using the {{Code\|sugar-network-node start}} command;		* Run node server using the {{Code\|sugar-network-node start}} command;

Alsroot: /* Usage */

2013-02-22T12:28:44Z

Usage

← Older revision		Revision as of 08:28, 22 February 2013
Line 131:		Line 131:
	[main]		[main]
	debug = 3		debug = 3

			# 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

	[node]		[node]
	host = 0.0.0.0		host = 0.0.0.0
	port = 8000		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		# switch off user credentials check; disabling this option will require
Line 140:		Line 149:
	trust-users = True		trust-users = True

	* Run node server using the {{Code\|sugar-network-node start}} command~~; if you called run command from a non-root user, see output errors to create/chown all required directories and files~~;		* Make sure that all directory in config file are created and current user have write permissions;

			* Run node server using the {{Code\|sugar-network-node start}} command;

	* Find log files in the {{Code\|/var/log/sugar-network-node.log}} file.		* Find log files in the {{Code\|/var/log/sugar-network-node.log}} file.

Alsroot: /* Usage */

2013-02-22T12:19:27Z

Usage

← Older revision		Revision as of 08:19, 22 February 2013
Line 140:		Line 140:
	trust-users = True		trust-users = True

	* Run node server using the {{Code\|sugar-network-node start}} command; if you called run command from a non-root user, see output errors to create all required directories and files;		* Run node server using the {{Code\|sugar-network-node start}} command; if you called run command from a non-root user, see output errors to create/chown all required directories and files;

	* Find log files in the {{Code\|/var/log/sugar-network-node.log}} file.		* Find log files in the {{Code\|/var/log/sugar-network-node.log}} file.

Alsroot: /* sugar-network-client */

2013-02-22T09:27:28Z

sugar-network-client

← Older revision		Revision as of 05:27, 22 February 2013
Line 76:		Line 76:
	This is a client side application. The reasons to have such client application (instead of direct using of server API) are the following:		This is a client side application. The reasons to have such client application (instead of direct using of server API) are the following:

	* Provide access to local Sugar Network data (providing [[Platform_Team/Sugar_Network/API\|API]] from the localhost), ~~it is useful if~~ server ~~is not accessible~~;		* Provide access to local Sugar Network data (providing [[Platform_Team/Sugar_Network/API\|API]] from the localhost), e.g., from remote devices;
			* Being not connected to a server, users might create postponed changes in Sugar Network content, they will be applied to a server right after getting connected;
	* Having locally provided API as a proxy to a server, it is the only way (for now) to be authenticated on the server;		* Having locally provided API as a proxy to a server, it is the only way (for now) to be authenticated on the server;
	* Provide features that can't served from a servers, e.g., launching activities;		* Provide features that can't served from a servers, e.g., launching activities;

Alsroot: /* Usage */

2013-02-21T14:48:24Z

Usage

← Older revision		Revision as of 10:48, 21 February 2013
Line 128:		Line 128:
	* Populate the {{Code\|/etc/sugar-network/config}} configuration file with the following content:		* Populate the {{Code\|/etc/sugar-network/config}} configuration file with the following content:

			[main]
			debug = 3

	[node]		[node]
	host = 0.0.0.0		host = 0.0.0.0
	port = 8000		port = 8000

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

	* Run node server using the {{Code\|sugar-network-node start}} command;		* Run node server using the {{Code\|sugar-network-node start}} command; if you called run command from a non-root user, see output errors to create all required directories and files;

			* Find log files in the {{Code\|/var/log/sugar-network-node.log}} file.

	On the ''Client'' side:		On the ''Client'' side:
Line 140:		Line 149:
	* Point ''Client'' to the newly launched ''Node'' (you all time can use one of [[Platform_Team/Sugar_Network/API#API_servers\|public servers]]) in the {{Code\|/etc/sweets.conf}} configuration file:		* Point ''Client'' to the newly launched ''Node'' (you all time can use one of [[Platform_Team/Sugar_Network/API#API_servers\|public servers]]) in the {{Code\|/etc/sweets.conf}} configuration file:

			[main]
			debug = 3

	[client]		[client]
	api-url = http://''NODE-HOST-HERE'':8000		api-url = http://''NODE-HOST-HERE'':8000
Line 149:		Line 161:
	* Open [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] by pressing ''F8'' key;		* Open [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] by pressing ''F8'' key;

	* Find [[Sugar_Network/Contributor_Hub\|Contributor Hub]] in the Web UI and launch it.		* Find [[Sugar_Network/Contributor_Hub\|Contributor Hub]] in the Web UI and launch it;

			* Find log file in the standard {{Code\|~/.sugar/default/logs}} directory.

	Note that newly installed ''Node'' will be empty, the process of populating it with public data will be implemented in upcoming release.		Note that newly installed ''Node'' will be empty, the process of populating it with public data will be implemented in upcoming release.

Alsroot: /* Usage */

2013-02-21T12:30:44Z

Usage

← Older revision		Revision as of 08:30, 21 February 2013
Line 121:		Line 121:
	== Usage ==		== Usage ==

	Assume we have two hosts, ''Node'' and ''Client'' (it might be the same real host though). ''Node'' host will be a Sugar Network ~~node~~ server. ''Client'' will ~~be user's side with running~~ Sugar Network ~~ready~~ Sugar ~~Shell~~ to connect to the ''Node''. [[Sweets_Distribution#Add_repository\|Attach]] ''Factory'' [[Sweets Distribution]] repository on both hosts.		Assume we have two hosts, ''Node'' and ''Client'' (it might be the same real host though). ''Node'' host will be a Sugar Network server. The ''Client'' side will run Sugar Network integrated Sugar session to connect to the ''Node''. [[Sweets_Distribution#Add_repository\|Attach]] ''Factory'' [[Sweets Distribution]] repository on both hosts.

	On the ''Node'' side:		On the ''Node'' side:

	* Install {{Code\|sugar-network}} package;		* Install {{Code\|sugar-network}} package;
	* Populate {{Code\|/etc/sugar-network/config}} configuration file with the following content:		* Populate the {{Code\|/etc/sugar-network/config}} configuration file with the following content:

	[node]		[node]
Line 138:		Line 138:
	* Install {{Code\|sweets-desktop}} package;		* Install {{Code\|sweets-desktop}} package;

	* Point ''Client'' to newly launched ''Node'' (you all time can ~~point ''Client'' to~~ [[Platform_Team/Sugar_Network/API#API_servers\|public servers]]) in the {{Code\|/etc/sweets.conf}} configuration file:		* Point ''Client'' to the newly launched ''Node'' (you all time can use one of [[Platform_Team/Sugar_Network/API#API_servers\|public servers]]) in the {{Code\|/etc/sweets.conf}} configuration file:

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

	* Choose ''Sweets Distribution'' ~~login~~ session or run Sugar in a window using the {{Code\|sweets-sugar-emulator}} command;		* Choose ''Sweets Distribution'' desktop session, or, run Sugar in a window using the {{Code\|sweets-sugar-emulator}} command;

	* [[Platform_Team/Sweets_Distribution/Factory/Features#Sugar_Network_integration\|Enable]] Sugar Network integration in the Shell;		* [[Platform_Team/Sweets_Distribution/Factory/Features#Sugar_Network_integration\|Enable]] Sugar Network integration in the Sugar Shell;

	* Open [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] by pressing ''F8'' key;		* Open [[Platform_Team/Sugar_Network/Web_UI\|Web UI]] by pressing ''F8'' key;