XS Community Edition/Features: Difference between revisions

From OLPC
Jump to navigation Jump to search
No edit summary
m (ad kickstart feature)
 
(41 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{xsce}}
{{xsce}}
{{TOCright}}


==Overview==
This is a dynamic list of features for the XS Community Edition ranging from wishlist items to items currently under development. Please add features to this list and/or sign up to implement one of the features listed.

This is a set of dynamic lists of features for [[XS Community Edition]] ranging from items already implemented, to items currently under development, to wishlist items.

The lists reflect the current release, [[../5.0|5.0]], as of February 2014 and make reference to planned releases. They are also meant to be more of a catalog than a full description or documentation of these features, some of which may be found elsewhere within this wiki.

==Features Implemented==

{| border="1" cellpadding="3" cellspacing="0" class="wikitable" style="text-align: left;"
|-
! Feature
! Description
! Notes
|-
|colspan="3" style="background: lightblue;" |'''Network Infrastructure'''
|-
| style="padding-left: 1em"|Network Configuration
|The School Server discovers the network adapters present and configures them automatically. It assigns host and domain names.
|The ability to override this configuration is planned.
|-
| style="padding-left: 1em"|DHCP Server
|The School Server can supply IP addresses to XOs and other machines on the LAN.
|This is an optional feature.
|-
| style="padding-left: 1em"|Gateway Services
|The School Server can act as a firewall and as a gateway to the internet and other machines on the WAN for machines on the LAN.
|This is an optional feature.
|-
| style="padding-left: 1em"|DNS Services
|The School Server can provide name resolution for XOs and other machines on the LAN.
|This is an optional feature.
|-
| style="padding-left: 1em"|Samba Services
|The School Server store and provide files to microsoft clients, requires smb client to be installed on XOs.
|This is an optional feature.
|-
| style="padding-left: 1em"|Open VPN
|Connection to an internet visible Virtual Private Network server is improved.
|This is an optional feature.
|-
|colspan="3" style="background: lightblue;" |'''Internet Content Filtering'''
|-
| style="padding-left: 1em"|Squid
|Squid caches internet content to lessen traffic and filters by destination.
|Installed by default.
|-
| style="padding-left: 1em"|Dansguardian
|Dansguardian filters internet content by keyword.
|Installed by default.
|-
| style="padding-left: 1em"|Wondershaper
|Wondershaper filters internet traffic by bandwidth.
|Installed by default.
|-
|colspan="3" style="background: lightblue;" |'''Services for OLPC XO Clients'''
|-
| style="padding-left: 1em"|Identity Manager
|The School Server supports the OLPC XO functionality to register with the server for backup and collaboration.
|Requires client functionality.
|-
| style="padding-left: 1em"|Collaboration Services
|The School Server has an ejabberd server which controls centralized collaboration.
|Requires client functionality.
|-
| style="padding-left: 1em"|Backup
|The School Server permits XOs to upload journal files as a backup.
|Requires client functionality.
|-
| style="padding-left: 1em"|Download Activities
|The School Server has an option to load sugar activities and a link to download them to an XO.
|Requires client functionality.
|-
|colspan="3" style="background: lightblue;" |'''Content Infrastructure'''
|-
| style="padding-left: 1em"|Apache Web Server
|The Apache Web Server is used by numerous services and is available for html content.
|Installed by default.
|-
| style="padding-left: 1em"|PHP
|PHP is used by numerous services and is available for custom content.
|Installed by default.
|-
| style="padding-left: 1em"|Python
|Python is used by numerous services and is available for custom content.
|Installed by default.
|-
| style="padding-left: 1em"|Authentication Server
|Authentication Server provides centralized authentication for server based applications.
|Installed by default.
|-
|colspan="3" style="background: lightblue;" |'''Content and Educational Applications'''
|-
| style="padding-left: 1em"|Portal
|The portal or home page of the server contains localized links to content on the server.
|Installed by default.
|-
| style="padding-left: 1em"|Moodle
|Moodle is an open source Learning Management System.
|Installed by default.
|-
| style="padding-left: 1em"|Internet-in-a-Box
|Internet-in-a-Box is a copy of some of the most important material on the internet, such as the Wikipedia, stored locally.
|Installed by default.
|-
| style="padding-left: 1em"|Pathagar
|Pathagar is an ebook server which supports a variety of electronic publishing standards.
|Installed by default.
|-
| style="padding-left: 1em"|Custom
|The server contains a library folder in which can be placed custom educational files that will appear on the portal.
|Installed by default.
|-
|colspan="3" style="background: lightblue;" |'''Assessment and Monitoring'''
|-
| style="padding-left: 1em"|Monit
|Monit monitors running services and restarts them if they shut down.
|Installed by default.
|-
| style="padding-left: 1em"|Ajenti
|Ajenti provides a Graphical Interface to administer technical aspects of the School Server.
|Installed by default.
|-
| style="padding-left: 1em"|Munin
|Munin collects performance statistics and generates graphs of them.
|Installed by default.
|-
| style="padding-left: 1em"|Stats Server
|Stats Server collects statistics on usage of the School Server.
|Installed by default.
|-
| style="padding-left: 1em"|XoVis
|Visualization tool installed to analyze the XO client backups stored on the School Server.
|Installed by default.
|-
| style="padding-left: 1em"|VnStat
|Command line statistics collected and available for each of the network interfaces.
|Installed by default, but must be initialized.
|-
|colspan="3" style="background: lightblue;" |'''Developer Tools'''
|-
| style="padding-left: 1em"|Ansible
|As of 5.0 ansible is the install mechanism and means for developers to add to the project.
|An rpm can also be produced.
|-
| style="padding-left: 1em"|Client Test Script
|Beginnings of automated testing of each of the School Server services.
|More tests planned in the future.
|-
|}


==Features Planned==

Please add features to this list and/or sign up to implement one of the features listed.

These features have detailed subpages. If you add a feature, you should also create a similar page to describe it and track progress on its implementation.

{| border="1" cellpadding="3" cellspacing="0" class="wikitable" style="text-align: center;"
! style="background: white;" | Legend
|-
| style="background: green;" | Done
|-
| style="background: lightgreen;" | Nearing completion
|-
| style="background: yellow;" | In progress
|-
| style="background: orange;" | Early stage
|-
| style="background: lightgrey;" | No details
|-
|}

<br />


{| border="1" cellpadding="3" cellspacing="0" class="wikitable sortable" style="text-align: left;"
{| border="1" cellpadding="3" cellspacing="0" class="wikitable sortable" style="text-align: left;"
Line 7: Line 180:
! align="left"| Owner
! align="left"| Owner
! align="left"| Target Release
! align="left"| Target Release
! align="left"| Description Link
! align="left"| Status
! align="left"| Status
|- style="background: auto;"
|- style="background: auto;"
|Refactor Networking
|3G Support
|Santi
|Basanta Shrestha
|0.6
|5.5
|style="background: lightgreen" | PR Expected. Soft code IP addresses, hostname, etc.
|[[ /3G support ]]
|Ongoing Development
|- style="background: auto;"
|Authorization Framework
|George Hunt
|0.6
|[[ /authorization framework ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Automatic Network Configuration
|[[/automatic network configuration|Automatic Network Configuration]]
|Jerry Vonau
|Jerry Vonau
|0.6
|5.5
|style="background: lightgreen" | Testing network role changes and console interaction
|[[ /automatic network configuration ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Local Variable Override
|Better Arm Support
|Jon Nettleton
|Tim
|0.6
|5.5
|style="background: lightgreen" | Create override_vars.yml to hold custom values for IP, etc.
|[[ /better arm support ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Management Console Gui
|Email Server
|NO ONE
|Tim
|0.6
|5.5
|style="background: lightgreen" | Ongoing Testing
|[[ /email server ]]
|Needs an Implementer
|- style="background: auto;"
|- style="background: auto;"
|[[/user portal|User Portal Localization]]
|Management Gui
|Tim Moody, Tony Anderson
|Miguel González Álvarez
|0.5
|6.0
|style="background: lightgreen" | Server side framework done, needs additional translations and client side
|[[ /management gui ]]
|50% done
|- style="background: auto;"
|- style="background: auto;"
|Command Line Scripts
|Port to Ansible
|George/Tim
|Anish, Miguel, Santi
|0.5
|5.5
|style="background: orange" | Implement xs-setup, xs-network-setup, xs-runtag, etc.
|[[ /port-to-ansible ]]
|Nearing completion
|- style="background: auto;"
|- style="background: auto;"
|Offline Install
|Power Management
|George
|Jon Nettleton
|0.6
|5.5
|style="background: lightgreen" | Download offline install for NUC, rpi 2
|[[ /power management ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Install on CentOS7
|Printer Gui
|George
|NO ONE
|0.6
|5.5
|style="background: lightgreen" | Perhaps, with reduced non-essential function
|[[ /printer gui ]]
|Needs an Implementer
|- style="background: auto;"
|- style="background: auto;"
|MySQL
|School Information Network
|George
|Martin Dluhos
|0.6
|5.5
|style="background: lightgreen" | Required for elgg
|[[ /school information network ]]
|- style="background: auto;"
|Needs an Implementer
|elgg
|George
|5.5
|style="background: lightgreen" | A social networkiing platform with many plugins
|- style="background: auto;"
|Owncloud
|Tim
|5.5
|style="background: lightgreen" | A social networkiing centralized repository
|- style="background: auto;"
|Kiwix
|Tim
|5.5
|style="background: lightgreen" | Indexed access to Wikimedia documents
|- style="background: auto;"
|Kalite
|Tim
|5.5
|style="background: lightgreen" | The Khan Tree of exercises, shields, summarizing (in English)
|- style="background: auto;"
|RACHEL on Server
|Tim
|5.5
|style="background: lightgreen" | RACHEL selectable in console
|- style="background: auto;"
|[[/authorization framework|Authorization Framework]]
|Tim
|5.5
|style="background: lightgreen" | Comes with console
|- style="background: auto;"
|Add Ability to Turn Off Service in Ansible
|Tim, George, Jerry
|5.5
|style="background: lightgreen" | Coupled with Console testing
|- style="background: auto;"
|- style="background: auto;"
|Screen Sharing
|[[/screensharing|Screen Sharing]]
|George Hunt
|George Hunt
|0.6
|5.5
|style="background: orange" | Perhaps as javascript proxy link from console
|[[ /screensharing ]]
|Experiments
|- style="background: auto;"
|- style="background: auto;"
|SDcard formating
|SD Card Registration
|George
|5.5
|style="background: yellow" | If a blank SD card is present, format it, install it at /library
|- style="background: auto;"
|[[/sd card registration with unique id|SD Card Registration]]
|TK Kang
|TK Kang
|0.6
|5.5
|style="background: orange" | Ongoing Development
|[[ /sd card registration with unique id ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|[[ /user management framework|User Management Framework]]
|Startup Sound
|Tony Anderson
|6.0
|style="background: orange" | His ds-backup includes multiple identities per XO
|- style="background: auto;"
|Modify Munin Graphs to On Demand
|Tim
|6.0 or later
|style="background: orange" | Change config to use cgi; may not be needed
|- style="background: auto;"
|[[/3G support|3G Support]]
|Basanta Shrestha
|6.0
|style="background: lightgray" | Ongoing Development
|- style="background: auto;"
|[[/better arm support|Better ARM Support]]
|Jon Nettleton
|6.0
|style="background: lightgray" | Ongoing Development
|- style="background: auto;"
|[[/email server|Email Server]]
|NO ONE
|6.0
|style="background: lightgray" | Needs an Implementer and a Design
|- style="background: auto;"
|[[/power management|Power Management]]
|Jon Nettleton
|6.0
|style="background: lightgray" | Ongoing Development
|- style="background: auto;"
|[[/printer gui|Printer Gui]]
|NO ONE
|6.0
|style="background: lightgray" | Needs an Implementer
|- style="background: auto;"
|[[/school information network|School Information Network]]
|Martin Dluhos
|6.0
|style="background: lightgray" | Needs an Implementer
|- style="background: auto;"
|[[/Startup sound|Startup Sound]]
|?
|?
|0.6
|6.0
|style="background: lightgrey" | Not Clear
|[[ /Startup sound ]]
|-
|Not Clear
|[[/Audience response system|Audience response system]]
|Santi
|6.0
|style="background: lightgray" | Ongoing Development
|-
|[[/Online_editor | Online editor]]
|Santi
|6.0
|style="background: lightgray" | Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Refactor Networking II
|User Management Framework
|Tony Anderson
|Santi
|6.0 or later
|0.6
|style="background: lightgray" | Substitute dnsmasq for bind/dhcpd
|[[ /user management framework ]]
|Ongoing Development
|- style="background: auto;"
|- style="background: auto;"
|Sugarizer on Server
|User Portal
|NO ONE
|Tim Moody, Tony Anderson
|0.6
|6.0
|style="background: lightgray" | Needs an Implementer
|[[ /user portal ]]
|- style="background: auto;"
|Server side framework done, needs translations and client side
|Webmaker.org Toolkit on Server
|NO ONE
|6.0
|style="background: lightgray" | Needs an Implementer
|-
|-
|[[/Kickstart|Kickstart]]
|Jerry Vonau
|6.0
|style="background: lightgreen" | Kickstart based installer
|- style="background: auto;"
|}
|}


==Wish List==


There have been a variety of Wish Lists produced over the years in the wiki, via documents, and over email. Here are some references. Ideally we will get to a consolidated list.
==Subpages==


* [[Deployment_wishlist|Deployment Wishlist]]
These features have detailed pages. If you add a feature, you should also create a similar page to describe it and track progress on its implementation.


* [[Nepal_Wish_List|Nepal Wish List]]
{{Special:PrefixIndex/{{PAGENAMEE}}/}}

Latest revision as of 00:58, 22 November 2015

This IIAB XSCE content does not reflect the opinion of OLPC. These pages were created by members of a volunteer community supporting OLPC and deployments.

Overview

This is a set of dynamic lists of features for XS Community Edition ranging from items already implemented, to items currently under development, to wishlist items.

The lists reflect the current release, 5.0, as of February 2014 and make reference to planned releases. They are also meant to be more of a catalog than a full description or documentation of these features, some of which may be found elsewhere within this wiki.

Features Implemented

Feature Description Notes
Network Infrastructure
Network Configuration The School Server discovers the network adapters present and configures them automatically. It assigns host and domain names. The ability to override this configuration is planned.
DHCP Server The School Server can supply IP addresses to XOs and other machines on the LAN. This is an optional feature.
Gateway Services The School Server can act as a firewall and as a gateway to the internet and other machines on the WAN for machines on the LAN. This is an optional feature.
DNS Services The School Server can provide name resolution for XOs and other machines on the LAN. This is an optional feature.
Samba Services The School Server store and provide files to microsoft clients, requires smb client to be installed on XOs. This is an optional feature.
Open VPN Connection to an internet visible Virtual Private Network server is improved. This is an optional feature.
Internet Content Filtering
Squid Squid caches internet content to lessen traffic and filters by destination. Installed by default.
Dansguardian Dansguardian filters internet content by keyword. Installed by default.
Wondershaper Wondershaper filters internet traffic by bandwidth. Installed by default.
Services for OLPC XO Clients
Identity Manager The School Server supports the OLPC XO functionality to register with the server for backup and collaboration. Requires client functionality.
Collaboration Services The School Server has an ejabberd server which controls centralized collaboration. Requires client functionality.
Backup The School Server permits XOs to upload journal files as a backup. Requires client functionality.
Download Activities The School Server has an option to load sugar activities and a link to download them to an XO. Requires client functionality.
Content Infrastructure
Apache Web Server The Apache Web Server is used by numerous services and is available for html content. Installed by default.
PHP PHP is used by numerous services and is available for custom content. Installed by default.
Python Python is used by numerous services and is available for custom content. Installed by default.
Authentication Server Authentication Server provides centralized authentication for server based applications. Installed by default.
Content and Educational Applications
Portal The portal or home page of the server contains localized links to content on the server. Installed by default.
Moodle Moodle is an open source Learning Management System. Installed by default.
Internet-in-a-Box Internet-in-a-Box is a copy of some of the most important material on the internet, such as the Wikipedia, stored locally. Installed by default.
Pathagar Pathagar is an ebook server which supports a variety of electronic publishing standards. Installed by default.
Custom The server contains a library folder in which can be placed custom educational files that will appear on the portal. Installed by default.
Assessment and Monitoring
Monit Monit monitors running services and restarts them if they shut down. Installed by default.
Ajenti Ajenti provides a Graphical Interface to administer technical aspects of the School Server. Installed by default.
Munin Munin collects performance statistics and generates graphs of them. Installed by default.
Stats Server Stats Server collects statistics on usage of the School Server. Installed by default.
XoVis Visualization tool installed to analyze the XO client backups stored on the School Server. Installed by default.
VnStat Command line statistics collected and available for each of the network interfaces. Installed by default, but must be initialized.
Developer Tools
Ansible As of 5.0 ansible is the install mechanism and means for developers to add to the project. An rpm can also be produced.
Client Test Script Beginnings of automated testing of each of the School Server services. More tests planned in the future.


Features Planned

Please add features to this list and/or sign up to implement one of the features listed.

These features have detailed subpages. If you add a feature, you should also create a similar page to describe it and track progress on its implementation.

Legend
Done
Nearing completion
In progress
Early stage
No details


Feature Owner Target Release Status
Refactor Networking Santi 5.5 PR Expected. Soft code IP addresses, hostname, etc.
Automatic Network Configuration Jerry Vonau 5.5 Testing network role changes and console interaction
Local Variable Override Tim 5.5 Create override_vars.yml to hold custom values for IP, etc.
Management Console Gui Tim 5.5 Ongoing Testing
User Portal Localization Tim Moody, Tony Anderson 6.0 Server side framework done, needs additional translations and client side
Command Line Scripts George/Tim 5.5 Implement xs-setup, xs-network-setup, xs-runtag, etc.
Offline Install George 5.5 Download offline install for NUC, rpi 2
Install on CentOS7 George 5.5 Perhaps, with reduced non-essential function
MySQL George 5.5 Required for elgg
elgg George 5.5 A social networkiing platform with many plugins
Owncloud Tim 5.5 A social networkiing centralized repository
Kiwix Tim 5.5 Indexed access to Wikimedia documents
Kalite Tim 5.5 The Khan Tree of exercises, shields, summarizing (in English)
RACHEL on Server Tim 5.5 RACHEL selectable in console
Authorization Framework Tim 5.5 Comes with console
Add Ability to Turn Off Service in Ansible Tim, George, Jerry 5.5 Coupled with Console testing
Screen Sharing George Hunt 5.5 Perhaps as javascript proxy link from console
SDcard formating George 5.5 If a blank SD card is present, format it, install it at /library
SD Card Registration TK Kang 5.5 Ongoing Development
User Management Framework Tony Anderson 6.0 His ds-backup includes multiple identities per XO
Modify Munin Graphs to On Demand Tim 6.0 or later Change config to use cgi; may not be needed
3G Support Basanta Shrestha 6.0 Ongoing Development
Better ARM Support Jon Nettleton 6.0 Ongoing Development
Email Server NO ONE 6.0 Needs an Implementer and a Design
Power Management Jon Nettleton 6.0 Ongoing Development
Printer Gui NO ONE 6.0 Needs an Implementer
School Information Network Martin Dluhos 6.0 Needs an Implementer
Startup Sound ? 6.0 Not Clear
Audience response system Santi 6.0 Ongoing Development
Online editor Santi 6.0 Ongoing Development
Refactor Networking II Santi 6.0 or later Substitute dnsmasq for bind/dhcpd
Sugarizer on Server NO ONE 6.0 Needs an Implementer
Webmaker.org Toolkit on Server NO ONE 6.0 Needs an Implementer
Kickstart Jerry Vonau 6.0 Kickstart based installer

Wish List

There have been a variety of Wish Lists produced over the years in the wiki, via documents, and over email. Here are some references. Ideally we will get to a consolidated list.