Platform Team/Server Kit/sugar-client: Difference between revisions

Created page with "== Summary == A program to run on Sugar clients side to interact with Sugar Server Kit based school server. It implements the Client API f..."
 
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Note/warning|Caution|The '''sugar-client''' application exits only in [[Deployment_Platform/1.1|1.x]] releases of the [[Deployment Platform]] (originally named as Sugar Server Kit).<br>For the planing 2.0 release, '''sugar-client''' functionality is split into several Shell [[Deployment_Platform/Shell_Plugins|plugins]].}}
== Summary ==
== Summary ==


Line 68: Line 70:


It is important to use secure connection with server, specify server's certificate via {{Code|stats-ca-certs}} parameter.
It is important to use secure connection with server, specify server's certificate via {{Code|stats-ca-certs}} parameter.
==== Stats configuration ====
After enabling stats gathering (after the first successful server connection), all stats related configuration will be stored in [[#Configuration|sugar-client.conf]] configuration file in {{Code|[stats]}} section. Enable this configuration manually if you need to enable stats gathering before the first connection to the server.
[stats]
rras = ["RRA:AVERAGE:0.5:1:4320", "RRA:AVERAGE:0.5:5:2016"]
step = 60
enabled = true


== Background operations ==
== Background operations ==
Line 132: Line 143:


== Troubleshooting ==
== Troubleshooting ==
'''Debugging'''
To enable debug logging, add the following lines to [[#Configuration|configuration file]]:
[main]
debug = 3
'''Direct launch'''


In special cases, it is possible to execute sugar-client operations directly, instead of calling DBus service. For that reason, {{Code|-d|--direct}} command-line argument needs to be passed:
In special cases, it is possible to execute sugar-client operations directly, instead of calling DBus service. For that reason, {{Code|-d|--direct}} command-line argument needs to be passed:
Line 144: Line 164:
== Resources ==
== Resources ==


* [http://git.sugarlabs.org/server/client Sources].
* [http://git.sugarlabs.org/desktop/stats/commits/sugar-client-1.2 Sources].
* Current stable binary [http://download.sugarlabs.org/packages/Server:/1/ packages].
* Current stable binary [http://download.sugarlabs.org/packages/Server:/1/ packages].
* Development binary [http://download.sugarlabs.org/packages/Server:/Factory/ packages].
* Development binary [http://download.sugarlabs.org/packages/Server:/Factory/ packages].