.. Xronos Scheduler documentation master file, created by
   sphinx-quickstart on Thu Nov 17 11:45:33 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Index
=====

.. image:: public.png
   :scale: 35%
   :align: right

Xronos Scheduler - installation instructions.

Xronos Scheduler is a web application, written using the
`Ruby on Rails <http://rubyonrails.org>`_ web application framework.
As such, it can be deployed to any of the many hosting services which
provide support for such applications.

These instructions are intended for those who want instead to set up
a suitable hosting platform for themselves - either a dedicated
physical machine, or some kind of virtual server.

In these circumstances, the recommended operating system is
`Debian GNU/Linux <https://www.debian.org>`_.
It should be relatively straightforward to use any other version
of Linux, or MacOS.

You may already have your own web application infrastructure, in which
case you should be able to slot Scheduler into it.

These instructions assume you are going to use a fresh, blank installation
of Debian GNU/Linux, with just the bare operating system installed.

Download this guide as a
`PDF <https://xronos.uk/pdfs/SchedulerInstallationGuide.pdf>`_

.. toctree::

   hardware
   operatingsystem
   ruby
   scheduler
   nextsteps
   productionmode
   https
   realdata
   cronjobs


Available documents
-------------------

- `Scheduler Admin Guide <https://xronos.uk/admin/>`_
- `Scheduler Advanced User Guide <https://xronos.uk/advanced/>`_
- `Scheduler API Guide <https://xronos.uk/api/>`_
- `Scheduler Installation Guide <https://xronos.uk/install/>`_
- `Scheduler User Guide <https://xronos.uk/>`_

Scheduler is licensed under the GNU General Public Licence, version 2.


Indices and tables
==================

* :ref:`search`