Platform Team/Server Kit/sugar-server
Summary
The core Sugar Server Kit component.
The singular program requires only Python, and obvious dependencies like coreutils, to allow all its services to function properly. It provides basic sugar related services, and uses one CLI tool to manage all its functionality.
Services
The list of services that sugar-server provides. Each service has a described interface to understand how it interact with clients. The counterpart for these interfaces is the sugar-client with a Client API it provides for clients, e.g., Sugar Shell.
id
Provide Sugar users registration on a school server. After being registered, Sugar on users side will setup interaction with a school server, such as:
- Setup jabber sever location,
- url to backup or restore Journal,
- update native packages.
Interface
Service is listening --id-port port on the --host host to serve XML-RPC requests. There is only one RPC function:
dict register(str serial, str nickname, str uuid, str pubkey)
Where pubkey is a SSH DSS public key without the ssh-dss prefix.
The resulting dictionary on success, contains:
success: OK;- Several keys that are mapped 1:1 as configuration options of the sugar-client utility. The particular set of keys are details of implementations and processed only internally;
- OLPC XS backwards compatibility keys that are not being processed by sugar-client:
backupurl,jabberserver,backuppath.
The resulting dictionary on fails, contains:
success: ERR;errorkey with error message.
backup
Process backup and restore for students' Journals. The service is listenning for HTTP requests that client send before starting backup. If server accepts requests, clients start Rsync'ing Journal data via SSH.
Note, this backup functionality does not compatible with client tools that work with OLPC XS. The problem is that these tools construct backup url on a client side (using only server host name from backup url given after registration on a server) with relying that every client has its own system user on a server side. That doesn't work with new backup functionality where there is only one system user on a client side and authorisation happens on SSH level (using command option in ~/.ssh/authorized_keys file).
Interface
From --httpd-port on --host host, service is processing HTTP requests for url:
/backup/uuid/available/uuid
As a result, service returns following HTTP codes:
200, if backup can be started;503, if backup cannot be started right now and client needs to retry in some time later;- Various error code on fails with error message as HTML content.
If backup is available, client will start transfering Journal files using Rsync url taht was gotten while registration via Id service. The particular details are not an object of public interface and depends on sugar-client and backup service implementation, but process is fully server driven.
activation
keyring
collector
Collect usage statistics gathered by sugar-client in monitor mode for later analyzing.
Requires
- bios-crypto
bios-crypto client utilities are being used in anti-thief support and should be installed only if sign service is being used. - python-mysql
If the rest of school server applications use MySql, it might be useful to keep sugar-server data in MySql as well. Otherwise plain text file will be used.
Configuration
By default, configuration occurs based on several sources (sorted by applied order):
/etc/sugar-server.confsystem-wide configuration file,~/.local/sugar-server/configuser-wide configuration file,sugar-server's command-line arguments.
Configuration files contain option names equal to command-line arguments. To get the current configuration, call:
sugar-server config
See sugar-server-templates sources for an example.