Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Rattail Manual documentation

Toggle table of contents sidebar

Rattail Manual documentation

Contents:

Read This First
Quick Start
Background
Feature Layer
Toggle navigation of Feature Layer
- People
  Toggle navigation of People
  - Entry
    Toggle navigation of Entry
    - Overview
    - Importing
    - Editing
    - Exporting
    - Batches
    - Merging
  - Users
  - Employees
  - Customers
  - Members
  - Household / Shared Accounts
- Products
  Toggle navigation of Products
  - Entry
  - Vendors / Catalogs
  - Pricing
  - Labels
  - Inventory
- Purchase Orders
  Toggle navigation of Purchase Orders
  - Ordering
    Toggle navigation of Ordering
  - Receiving
    Toggle navigation of Receiving
  - Accounting
- POS Transactions
  Toggle navigation of POS Transactions
  - Importing
  - Reporting
- Customer Orders
  Toggle navigation of Customer Orders
Base Layer
Toggle navigation of Base Layer
- Requirements
- Virtual Environment
- Installation
  Toggle navigation of Installation
  - Common Install Steps
  - Installing on Windows
    Toggle navigation of Installing on Windows
    - Python
    - Pip
    - Python for Windows Extensions
    - Rattail
    - Windows User
    - File Monitor
      Toggle navigation of File Monitor
      - Overview
      - Configuration
        Toggle navigation of Configuration
        
        Overview
        
        Basic, aka. “Starter Kit”
        
        Other Approaches
      - Registering the Service
      - Starting the Service
- App Folder
- Configuration
  Toggle navigation of Configuration
  - Overview
  - Config File Syntax
  - Typical File Paths
  - Config File Inheritance
  - Generating Config Files
  - Configuring Logging
  - Storing Config in DB
  - memcached
  - Available Settings
    Toggle navigation of Available Settings
- Commands
- Writing Scripts
- Sending Email
  Toggle navigation of Sending Email
- Scheduled Tasks
- Supervisor
  Toggle navigation of Supervisor
  - Overview
  - Setup
- File Monitoring
  Toggle navigation of File Monitoring
  - Overview
- Mail Monitoring
- App Upgrades
- Handlers
  Toggle navigation of Handlers
  - App Handler
  - Batch Handlers
  - Import Handlers
  - Other / Misc. Handlers
    Toggle navigation of Other / Misc. Handlers
Data Layer
Toggle navigation of Data Layer
- Rattail Database
  Toggle navigation of Rattail Database
- Trainwreck Database
- POS and Other Data Stores
- User Auth
- Data Import / Export
  Toggle navigation of Data Import / Export
- Real-Time Data Sync
  Toggle navigation of Real-Time Data Sync
- Data Versioning
- Data Batch Processing
  Toggle navigation of Data Batch Processing
  - Overview
  - Batch Table Schema
  - Batch Handlers
  - Native Batch Types
    Toggle navigation of Native Batch Types
  - Adding a Custom Batch
- Autocomplete
- Customer Orders
  Toggle navigation of Customer Orders
  - Customer Order Overview
  - Customer Order Workflows
- Reports
  Toggle navigation of Reports
- Problem Reports
- Multiple App Nodes
- Temperature Monitoring
- Common Tasks
- Common Patterns
Web Layer
Toggle navigation of Web Layer
- Overview
- Default Web App
  Toggle navigation of Default Web App
  - Overview
  - Development Guide
    Toggle navigation of Development Guide
    - Overview
    - Views
    - Grids
    - Forms
    - Common Patterns
    - Common Tasks
      Toggle navigation of Common Tasks
      - New Master View
- Web API
- Single-Page Apps
Monitoring Layer
Toggle navigation of Monitoring Layer
- Overview
- Shinken
Deployment Layer
Toggle navigation of Deployment Layer
Backup Layer
Toggle navigation of Backup Layer
- Overview
- Installation
- Configuration
- Running the Command
- Features
  Toggle navigation of Features
- Restoring from Backup

Toggle table of contents sidebar

Shinken¶

TODO

Deployment Layer

Copyright © 2021-2023, Lance Edgar

Made with Sphinx and @pradyunsg's Furo