Rattail Manual
==============

This is "the reference manual" for Rattail.

It is intended for developers and/or system administrators.  It
assumes the reader is involved with the creation or maintenance of a
Poser/Rattail app.

This manual is primarily organized around the possible "layers" of a
Poser/Rattail app:

* :doc:`features/index` - app features provided by the framework
* :doc:`base/index` - general app install, command line, plus filemon etc.
* :doc:`data/index` - when a DB or data import/export come into it
* :doc:`web/index` - all things web
* :doc:`monitor/index` - keeping an eye out for production issues
* :doc:`deploy/index` - deploying a production system
* :doc:`backup/index` - backing up the production system

.. note::
   Please understand, this manual is a work in progress.  We finally have an
   "authoritative home base" for this documentation, but it may take some time
   to fill in all the blanks.

Please see `https://rattailproject.org/docs/rattail-manual/
<https://rattailproject.org/docs/rattail-manual/>`_ for the latest version of
this document.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   readfirst
   quickstart
   background
   features/index
   base/index
   data/index
   web/index
   monitor/index
   deploy/index
   backup/index


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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`