User:Holt/XS Community Edition/Documentation/Hacking
-- Summary --
This is the Documentation for initial version of the School Server - Community Edition, Version 0.1.
The target audience will be the 7 people working from Adam's home. Experienced Linux users and admin with a strong interest in hacking. Enough interest that they made the trip to Toronto in February. Stage 2, hopefully for version 0.2 will include the larger school server development community. Stage 3, hopefully for version 0.3 will begin the emphasis on end user documentation.
Based on practical experience and this document a hacker should be able to download the XS code, modify the code, build an rpm, and install an RPM. Secondary goals will be to download a RPM and install a fully functioning School Server.
-- Purpose --
The purpose of this iteration of documentation will be to provide a stable enough starting point from which hackers can load and modify it for their individual purposes.
-- Design and architecture --
Conceptually, the school server is a collection of common network services which can be easily installed and configured as necessary. Modularity is important in order to provide a core base of services on top of which extended service modules can be installed. Their is an ongoing discussion about what are core service and what are extended services. Over time this should settle down.
-- Code layout --
scripts/
Currently the code lives in the xs-config/ dir. The configuration consist of a series of scripts which line in the scripts/ dir. The process is kicked off by running xs-setup. xs-setup calls a series of scripts with the naming convention the xs-[ServiceName] each of which set up an individual service.
cfg/etc/
When necessary, the xs-[ServiceName] scripts installs files from under cfg/etc as necessary.
cfg/html/top/
The web based GUI is located under cfg/html/top/
-- Core Services --
- Dynamic Host Configuration Protocol
- Iptables - Network Address Translation (NAT)
- Internet Domain Name Server
- Jabber Server
-- Extended services --
-- Down loading code --
-- building --
-- installing --
