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:

• Feature Layer - app features provided by the framework

• 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]
• Feature Layer
  • People
  • Products
  • Purchase Orders
  • POS Transactions
  • Customer Orders
• Base Layer
  • Requirements
  • Virtual Environment
  • Installation
  • App Folder
  • Configuration
  • Commands
  • Writing Scripts
  • Sending Email
  • Scheduled Tasks
  • Supervisor
  • File Monitoring
  • Mail Monitoring
  • App Upgrades
  • Handlers
• Data Layer
  • Rattail Database
  • Trainwreck Database
  • POS and Other Data Stores
  • User Auth
  • Data Import / Export
  • Real-Time Data Sync
  • Data Versioning
  • Data Batch Processing
  • Autocomplete
  • Customer Orders
  • 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 Basics
  • Machine Bundles
• Backup Layer
  • Overview
  • Installation
  • Configuration
  • Running the Command
  • Features
  • Restoring from Backup

Indices and tables

• Index

• Module Index

• Search Page