2021-01-06 15:33:56 -06:00
|
|
|
|
2021-01-07 16:48:14 -06:00
|
|
|
Rattail Manual
|
|
|
|
|
==============
|
|
|
|
|
|
2023-12-30 17:14:17 -06:00
|
|
|
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.
|
2021-01-07 16:48:14 -06:00
|
|
|
|
2021-01-07 21:20:31 -06:00
|
|
|
This manual is primarily organized around the possible "layers" of a
|
2021-01-07 16:48:14 -06:00
|
|
|
Poser/Rattail app:
|
|
|
|
|
|
2022-03-11 19:44:07 -06:00
|
|
|
* :doc:`features/index` - app features provided by the framework
|
2021-01-07 16:48:14 -06:00
|
|
|
* :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
|
2021-01-15 15:16:23 -06:00
|
|
|
* :doc:`monitor/index` - keeping an eye out for production issues
|
|
|
|
|
* :doc:`deploy/index` - deploying a production system
|
2021-01-07 16:48:14 -06:00
|
|
|
* :doc:`backup/index` - backing up the production system
|
2021-01-06 15:33:56 -06:00
|
|
|
|
2021-01-15 15:16:23 -06:00
|
|
|
.. 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.
|
|
|
|
|
|
2021-01-07 21:20:31 -06:00
|
|
|
Please see `https://rattailproject.org/docs/rattail-manual/
|
|
|
|
|
<https://rattailproject.org/docs/rattail-manual/>`_ for the latest version of
|
|
|
|
|
this document.
|
|
|
|
|
|
2021-01-06 15:33:56 -06:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Contents:
|
|
|
|
|
|
2021-01-07 16:48:14 -06:00
|
|
|
readfirst
|
2021-01-19 12:50:23 -06:00
|
|
|
quickstart
|
2021-01-07 21:20:31 -06:00
|
|
|
background
|
2022-03-11 19:44:07 -06:00
|
|
|
features/index
|
2021-01-07 16:48:14 -06:00
|
|
|
base/index
|
|
|
|
|
data/index
|
|
|
|
|
web/index
|
2021-01-15 15:16:23 -06:00
|
|
|
monitor/index
|
2021-01-07 16:48:14 -06:00
|
|
|
deploy/index
|
|
|
|
|
backup/index
|
2021-01-06 15:33:56 -06:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
