View source for XS Installing Software 0.5

{{translations}}
{{OLPC}}
[[Category:Software]]
[[Category:Developers]]
[[Category:SchoolServer]]

This page describes how to obtain a copy of the [[XS_Server_Software|XS school server software]], load it onto media, and install it onto a system.  A more [[XS Software Repositories|complete description of the software repositories]], [[XS_Configuration_Management|configuration information]], and [[Schoolserver_Testing|testing instructions]] are also available.

This page covers XS 0.5.x . For other releases, see [[XS_Installing_Software]]

=Downloading the System Image=
 
You can obtain 0.5.x image from [http://xs-dev.laptop.org/xs/ http://xs-dev.laptop.org/xs/]

This can be copied onto a '''CD''' or '''DVD''' using your favorite software.

== Optional: Using a USB key/disk for installation ==

'''With version 0.5.x, USB installs are not fully supported, and are reported to fail on a variety of hardware. In case of seeing problems, retry with a normal CD-ROM based installation.'''

Using a USB key to install this version of the XS involves several additional steps.

* First, ensure you have syslinux installed, and that your USB key is both bootable (you can use gparted to make it bootable) and unmounted.
* Then, copy the installation using the 'mkusbinstall' script you can download [http://dev.laptop.org/git/projects/xs-livecd/plain/util/mkusbinstall?id=470bbcfb9fb33416fef0093038b76ba035a997a2 here] (click on the 'plain' link). Assuming your usb key is /dev/sdb, you can invoke it like this:
 mkusbinstall OLPC_XS_LATEST.iso /dev/sdb1
* You may need to configure your machine to boot from USB - see [[XS_Boot_from_USB]] for details.
* Early in the installation , anaconda will say that it cannot find its kickstart file. Change the path from 'cdrom:/ks.cfg' to 'hd:sdb1:/ks.cfg'. You will get prompted again for the path to the ISO - set it to Hard Drive, device: '/dev/sdb1' and directory: 'iso'. If the machine has more than one hard drive, then the device might be sdc1 instead of sdb1.

Mikedawson - I found that installation from USB key would fail just before choosing additional packages unless you change the boot arguments to the Kernel.  When Grub comes hit escape, then edit the line and replace LABEL=XSRepo with dev:sdb1 in the two places it occurs.

This process has worked on Ubuntu and Fedora systems.

=Installing the Software=

'''Please read the [[XS Release Notes|release notes]] for the version you are installing.'''

The install from a '''CD''' or '''USB''' key will eventually be automatic upon booting.   While the install is currently mostly automated (not interactive), it is not performed automatically upon boot.

# Boot from the USB Key or CD-ROM 
# Press enter to start the graphical boot menu.
# Select "Install using kickstart" at the initial boot screen.
## "Install using kickstart" is the last menu item. Do not use the other "Install" options on this menu as they only install Fedora 9 without the olpc scripts. The Anaconda installer will install 537 packages. If it announces it is installing 407 packages, the olpc scripts are missing. Start again.
# '''Note: the default graphical installer can be unstable at times. You can press tab and add 'text' at the end of the line to request the text-based installer.'''
# '''If booting from a USB key please note the following!'''
## Before installing 0.5, put the ISO imaged USB key into a normal computer, and edit the ks.cfg file. You'll need to delete "--driveorder=sda" (otherwise the installer will fail, although I am uncertain of why).
## When it asks for the ks.cfg file with "cdrom:/ks.cfg" and replace with "hd:sdb1/ks.cfg" and it'll work fine.
## When it asks what the media to install from is, choose "HD" and then it'll automatically choose /dev/sdb1 and you need to type "iso" into the folder option.
# Anaconda (the Fedora installer) takes over and you will be prompted for the standard questions - these are preset to the correct defaults for the School Server configuration. You will want to set keyboard type, the time zone, and a root password for your specific system.
# When prompted to add specific packages just leave the default and click next.
# When it has finished installing, you will be prompted to reboot.  Remove the CD-ROM or USB key after power-down, but before the boot process begins.

You should now have a school server! It needs initial configuration before it starts providing services to the laptops.

== Initial Configuration ==

===Setting hostname and domain===
Login as root, with whatever password you assigned during installation.

Right after installation, you '''must'''
* Set the server domain name (the hostname is always 'schoolserver') using:
 /etc/sysconfig/olpc-scripts/domain_config example.org
* <small>(not needed in latest versions - covered by step above)</small> Set the fully qualified hostname of the machine by editing '''/etc/sysconfig/network''' as follows:
 '''HOSTNAME=schoolserver.example.org'''
** Note that the hostname is '''always''' the domain name with "schoolserver." prepended.
* Enable the ejabberd service to automatically start at boot as follows:
 chkconfig --level 345 ejabberd on
* Reboot the machine so the hostname change can take effect:
 shutdown -r now
* When the machine is back online, log in to the console as root again

===Basic ejabberd Configuration===

* Check the status of ejabberd, which should have started on boot, as follows:
 ejabberdctl status
* You should get a report indicating that the node is started and the service is running, like this (If you get an error, see [[#Troubleshooting |Troubleshooting]] for potential help)
 Node ejabberd@schoolserver is started. Status: started
 ejabberd is running
* Create an account on ejabberd for the administrator account:
 ejabberdctl register admin ''' ''schoolserver.example.org'' ''' password

===Setup Shared Roster Groups for ejabberd===

# Go to the web-based administration interface for ejabberd at <tt>http://schoolserver.example.org:5280/admin/</tt>, or <tt>http://172.18.0.1:5280/admin/</tt> (default IP address of XS)
# Login as "admin@schoolserver.example.org" with the password "password" (the administrator username and password you created in the previous section)
# Click on "Virtual Hosts", then your hostname ('''schoolserver.example.org'''), then "Shared Roster Groups". Type "Online" in the text box at the top of the screen and click '''Add New'''.
# Click on the newly created roster group called "Online" and enter "Online" for Name, "@online@" for Members, and "Online" for Displayed Groups. Click Submit. 
## Note: In XS v0.5 and v0.5.1, the @online@ directive does not function properly (see [http://dev.laptop.org/ticket/9272 defect ticket #9272]).  A workaround is given in the referenced ticket report, but it has been fixed in XS v0.5.2+.

===Optional: Enable Squid transparent proxy===

The school server is currently using Squid for web caching.  This is not enabled by default, but may easily be turned on.  As root, type:
 [http://dev.laptop.org/git?p=projects/xs-config;a=blob;f=fsroot.olpc.img/etc/sysconfig/olpc-scripts/TURN_SQUID_ON;hb=HEAD /etc/sysconfig/olpc-scripts/TURN_SQUID_ON]

If you need to make any modifications to the default Squid configuration make sure you make the modifications to the XS squid.conf file (called squid-xs.conf) not the default squid.conf file. To point to an external proxy server or a content filtering service simply add the following lines, inserting the appropriate proxy name:
 cache_peer parentcache.foo.com parent 3128 0 no-query default
 acl all src 0.0.0.0/0.0.0.0
 never_direct allow all

Then restart Squid (or the server) and test.

Note: If user authentication is required for the network through a pop-up browser you may need to use Firefox rather than the default browse activity as it doesn't support popups. Also, if you have a PAC file you need to use you can distribute it by DHCP.

To disable web caching, type:
 [http://dev.laptop.org/git?p=projects/xs-config;a=blob;f=fsroot.olpc.img/etc/sysconfig/olpc-scripts/TURN_SQUID_OFF;hb=HEAD /etc/sysconfig/olpc-scripts/TURN_SQUID_OFF]

This disables caching, but doesn't free up any disk space used by existing cached data.  You can manually delete the cache, located at <tt>/library/cache</tt> to free this disk space.

The configuration files for squid are found in <tt>/etc/squid/</tt>.  OLPC provides a custom configuration file [http://dev.laptop.org/git?p=projects/xs-config;a=blob;f=fsroot.olpc.img/etc/squid/squid.conf;hb=HEAD /etc/squid/squid-xs.conf] through the xs-config package.

=Network Configuration=

The default server setup is to connect to the Internet on the '''first wired ethernet network interface''', using IPv4 DHCP.  Laptops connect to the server over Access Points (APs) connected to the '''second wired ethernet network interface''' or via the wireless mesh using one or more [[Active Antenna]], connected through USB interfaces.  

If your XS has 2 network interfaces and you would like to reverse their (WAN, LAN) roles you can use the xs-swapnics utility. If you get your WAN via some other interface (e.g., ppp0) then you need to change the iptables NAT rule in '''/etc/sysconfig/olpc-scripts/iptables.principal'''

IPv6 is not enabled by default and not needed -- to enable external IPv6 you will have to [[XS_Configuration_Management#IPv6|configure the global address of the machine and setup an IPv6 tunnel]].

The XS runs a fully-fledged DNS server internally, therefore there is no need to enter the DNS servers from your ISP into the configuration.

==Configuring A Static IP Address==

To setup your server with a static IP address on the "first wired ethernet network interface" (eth0):
* The following is noted in '''/etc/sysconfig/network-scripts/ifcfg-eth0''':
<blockquote>
“If this is the main or only school server, then eth0 defaults to looking for a DHCP lease – if you want to set a static address, create a file called ifcfg-eth0-local in this directory – look at the example file provided under /usr/share/doc/xs-config-*/ifcfg-eth0-local.example”
</blockquote>
* Edit the sample file '''/usr/share/doc/xs-config-*/ifcfg-eth0-local.example''' with the network configuration your XS server needs, for example:
 IPADDR=192.168.12.34
 IPV6ADDR=AAAA:BBBB:CCCC:1111:2222:3333/64
 NETMASK=255.255.255.0
 NETWORK=192.168.12.0
 BROADCAST=192.168.12.255
 GATEWAY=192.168.12.1
* Save the file as '''/etc/sysconfig/network-scripts/ifcfg-eth0-local'''
* If the authoritative DNS server for the domain name (example.org) that you have configured returns an accurate record for your hostname (schoolserver.example.org), then you do not need to do anything. However, if this is not the case (e.g. if you made the hostname up), then you will have to modify /etc/hosts, appending your hostname to the 127.0.0.1 entry, e.g.:
 127.0.0.1      localhost.localdomain localhost '''schoolserver.example.org'''
* If you can only resolve hostnames on the schoolserver but not from other computers using the schoolserver as a gateway then you may have to force use of your ISP's DNS servers. [http://www.mail-archive.com/server-devel@lists.laptop.org/msg02381.html Add your ISP's nameservers to /etc/named-xs.conf file as forwarders.] To preserve your configuration changes across upgrades, also '''cd /etc; make -f xs-config.make named-xs.conf'''.

===Troubleshooting===

====ejabberd and your hostname====
For the ejabberd service to run, the name of the ejabberd server (in our case "schoolserver.example.org") must be resolvable to it's IP address (e.g. DNS server alias records).  You will encounter problems if the hostname is not resolved correctly by the upstream authoritative DNS server for your domain, or if it is not resolved at all. See the instructions above about modifying /etc/hosts if that is the case.

====Hostname has been changed after initial configuration====

If you change the hostname of the XS, ejabberd will break. This will be fixed for XS-0.6, but in the mean time, do not change the hostname unless you are willing to handle the breakage yourself.

<!--
If you have started '''ejabberd''' at one point on a server, and changed the fully qualified hostname (including domain), you must reinitialize the Mnesia configuration database that '''ejabberd''' uses.  This database stores all configuration information as well as user data and more, but this means that the old hostname remains in the database even if you change it in the '''ejabberd''' configuration files.  This will cause the '''ejabberd''' server to not run or not run properly when the hostname has been changed.

To change the hostname after '''ejabberd''' has been started initially, use this process:
* Stop ejabberd
 ejabberdctl stop
* Update the fully qualified hostname of the machine by editing '''/etc/sysconfig/network''' as follows:
 '''HOSTNAME=schoolserver.newdomain.org'''
* Configure ejabberd to use the new hostname by editing '''/etc/ejabberd/ejabberd.cfg''' and update the "hosts" entry in the '''SERVED HOSTNAMES''' section:
 {hosts, ["schoolserver.newdomain.org"]}.
* Read the [[#Notes about Hostname|Notes about Hostname]]
* Follow procedure to refresh Mnesia configuration database [[#Reinitialize ejabberd internal configuration database|Reinitialize ejabberd internal configuration database]]
* Reboot machine
* Make sure all DNS settings are correct, as mentioned in [[#Notes about Hostname|Notes about Hostname]], such that the new hostname is resolvable through DNS or other means

====Reinitialize ejabberd internal configuration database====
When using the default setup of XS, '''ejabberd''' uses the internal Mnesia database for, among other things, storing configuration information.  When troubleshooting problems with the intial configuration of '''ejabberd''', this simple "refresh" process will clear out the Mnesia configuration database and when ejabberd starts again it will reinitialize the database based on the configuration files.

'''NOTE:''' This process will erase the entirety of ejabberd's Mnesia configuration database, which seems to include all user data.  This may take care of the issue preventing ejabberd from running, but it may also be undesireable to lose all user information.  It should only be done during the initial configuration of '''ejabberd''' when there are no user accounts added yet.  

'''Potential Alternative:''' It may be possible to erase only a few specific spool files in order to allow reinitialization of the configuration information, but that is unknown at this time by this author.  Please contribute that information here if you have it.


* Stop ejabberd
 ejabberdctl stop
* Empty the '''/var/lib/ejabberd/spool/
 rm /var/lib/ejabberd/spool/*
* Start ejabberd
 ejabberdctl start
-->

== Access Points ==

[[Image:XS_Usage_APNormal.png|600px]]

Most access points are compatible with the XO.  For a list of ones which have been shown to work see [[Wireless Access Point Compatibility]].  Unless a single access point is being used (not recommended for more than forty to fifty laptops), a network switch of some sort will also be needed.

Make sure your AP is configured to act as an Access Point, with no added features or smarts. The AP should not be a DHCP server and should not act as a router. 

Some tips on configuring APs at [[XS_Techniques_and_Configuration]].

== Active Antennae ==
'''Important note: Active Antennae is not supported or available from OLPC at this time'''

If you have active antenna(e) to use, simply plug them in and reboot the XS. It will detect them and allocate them to mshbond0, mshbond1 and mshbond2. It should just work and XOs will see "School server mesh" when they connect to the mesh served by the XS. You may need to manually allocate different frequencies per antenna.

=More configuration options=

For more information on keeping your XS up to date, Internet content filtering, alternative networking/routing setups, and a lot of other advanced configuration topics see [[XS_Techniques_and_Configuration]].

=Upgrading from XS 0.4 or earlier=

If you are upgrading from XS 0.4 or earlier, the process is similar to a new installation, with some minor changes. In the menu shown right after booting, you should choose one of the 'Install or upgrade an existing system' options, press the Tab key, and add 'upgradeany' to the boot configuration line. After adding that line, press enter twice. 

With this extra option, Anaconda will recognise the old installation and will offer to upgrade.

Notes:

* Right after the upgrade, you '''must''' re-run the /etc/sysconfig/olpc-scripts/domain_config script with the appropriate domain name for the machine.
* The new OS may detect your network cards differently -- the roles of WAN and LAN cards may end up swapped from what they were under 0.4. If that happens, use the xs-swapnics script and reboot. 


=Upgrading from XS 0.5 or later=

If you have internet access and you wish to update just the xs-server packages you can use yum:

yum --disablerepo=* --enablerepo=olpcxs update


= See also =
* [[XS Techniques and Configuration]]

[[Category:SchoolServer]]