Platform Team/Server Kit/sugar-server

From Sugar Labs
Jump to navigation Jump to search

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

  • Required services:
    • Student identification
  • Optional services:
    • XO anti-thief support
    • Entire Journal backup/restore

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 happens basing on several sources (sorted by applying order):

  • /etc/sugar-server.conf system-wide configuration file,
  • ~/.local/sugar-server/config user-wide configuration file,
  • sugar-server's command-line arguments.

Configuration files contain options names equal to command-line arguments. To get the current configuration, call:

sugar-server config

See sugar-server-templates sources for an example.

Getting involved

  • Report on bugs.
  • Read the HACKING file to know how to contribute with code.

Resources