Rattail Manual

This is “the reference manual” for Rattail, intended for developers and system administrators. It assumes the reader is involved with the creation or maintenance of a Poser/Rattail app. It tries to explain the concepts involved and hopefully tie them all together.

If you prefer step-by-step instructions for creating your own app then see also the Rattail Tutorial.

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

• Base Layer - general app install, command line, plus filemon etc.
• Data Layer - when a DB or data import/export come into it
• Web Layer - all things web
• Monitoring Layer - keeping an eye out for production issues
• Deployment Layer - deploying a production system
• Backup Layer - 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/ for the latest version of this document.

Contents:

• Read This First
• Quick Start
• Background
  • What Rattail Is [Not]
• Base Layer
  • Requirements
  • Virtual Environment
  • Installation
  • App Folder
  • Configuration
  • Commands
  • Writing Scripts
  • Sending Email
  • Scheduled Tasks
  • Supervisord
  • File Monitoring
  • App Upgrades
  • App Handlers
• Data Layer
  • Rattail Database
  • Trainwreck Database
  • POS and Other Data Stores
  • Data Import / Export
  • Data Real-Time Sync
  • Data Versioning
  • Data Batch Processing
  • Reports
  • Problem Reports
  • Multiple App Nodes
  • Temperature Monitoring
  • Common Tasks
  • Common Patterns
• Web Layer
  • Overview
  • Default Web App
  • Web API
  • Single-Page Apps
• Monitoring Layer
  • Overview
  • Shinken
• Deployment Layer
  • Overview
  • Fabric
• Backup Layer
  • Overview
  • Borg

Indices and tables

• Index
• Module Index
• Search Page