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

Line 13:

Provide Sugar users registration on a school server. After being registered, Sugar on users side will setup interaction with a school server, such as:

* jabber sever ~~in {{Code|/desktop/sugar/collaboration/jabber_server}} GConf setting~~,

* Setup jabber sever location,

* backup ~~url in {{Code|/desktop/sugar/backup_url}} GConf setting~~,

* url to backup or restore Journal,

* ~~Package Management System configuration file in {{Code|~/.sugar/''profile''/pms.conf}} to upgrade~~ packages ~~on client side~~.

* update native packages.

~~Later~~, ~~these settings will be used by~~ [[Sugar_Server_Kit/sugar-client|sugar-client]] ~~to process its regular routines~~.

==== Interface ====

Service is listenning {{Code|--id-port}} port on the {{Code|--host}} host to serve XML-RPC requests. There is only one RPC function:

''dict'' '''register'''(''str'' serial, ''str'' nickname, ''str'' uuid, ''str'' pubkey)

Where {{Code|pubkey}} is a SSH DSS public key without the {{Code|ssh-dss }} prefix.

The resulting dictionary on success, contains:

* {{Code|success: OK}};

* Several keys that are 1:1 as configuration options of [[Sugar_Server_Kit/sugar-client|sugar-client]] utility. The particular set of keys are details of implementations and processed only internally;

* [http://wiki.laptop.org/go/School_server OLPC XS] backwards compatibility keys that are not being processed by sugar-client: {{Code|backupurl}}, {{Code|jabberserver}}, {{Code|backuppath}}.

The resulting dictionary on fails, contains:

* {{Code|success: ERR}};

* {{Code|error}} key with error message.

=== backup ===

@@ Line 13: / Line 13: @@
 Provide Sugar users registration on a school server. After being registered, Sugar on users side will setup interaction with a school server, such as:
-* jabber sever in {{Code|/desktop/sugar/collaboration/jabber_server}} GConf setting,
+* Setup jabber sever location,
-* backup url in {{Code|/desktop/sugar/backup_url}} GConf setting,
+* url to backup or restore Journal,
-* Package Management System configuration file in {{Code|~/.sugar/''profile''/pms.conf}} to upgrade packages on client side.
+* update native packages.
-Later, these settings will be used by [[Sugar_Server_Kit/sugar-client|sugar-client]] to process its regular routines.
+==== Interface ====
+Service is listenning {{Code|--id-port}} port on the {{Code|--host}} host to serve XML-RPC requests. There is only one RPC function:
+ ''dict'' '''register'''(''str'' serial, ''str'' nickname, ''str'' uuid, ''str'' pubkey)
+Where {{Code|pubkey}} is a SSH DSS public key without the {{Code|ssh-dss }} prefix.
+The resulting dictionary on success, contains:
+* {{Code|success: OK}};
+* Several keys that are 1:1 as configuration options of [[Sugar_Server_Kit/sugar-client|sugar-client]] utility. The particular set of keys are details of implementations and processed only internally;
+* [http://wiki.laptop.org/go/School_server OLPC XS] backwards compatibility keys that are not being processed by sugar-client: {{Code|backupurl}}, {{Code|jabberserver}}, {{Code|backuppath}}.
+The resulting dictionary on fails, contains:
+* {{Code|success: ERR}};
+* {{Code|error}} key with error message.
 === backup ===