Welcome to Mentat’s documentation!

Note

Please be aware, that this documentation is appropriate for following version:

• version: 2.5.23

• distribution: development (unstable)

• Git revision: 7fb96f756a018f38413b36941375f1b23706a57d

Warning

This documentation was generated from unstable codebase 2.5.23 - 304. You may instead wish to read the documentation for latest production version.

Contents:

• Architecture
  • Overall system architecture
  • Module architecture
• Events
  • Custom data attributes
• Installation
  • Dependencies
  • Installation guide - Prerequisites
  • Installation guide - Manual installation
  • Installation guide - Installation from Git repository
  • Installation guide - Ansible roles
  • Installation guide - Web interface with Apache2
  • Directory layout
  • What is next?
  • Troubleshooting
• Upgrading
  • Upgrading Mentat system
  • Upgrading PostgreSQL from 10.x to 11.x
  • Upgrading PostgreSQL from 11.x to 12.x
  • Upgrading to authenticated version of GeoIP service
  • Upgrading underlying Debian system
  • What is next?
• Migration
  • Migration to remote host
  • Local migration
  • Usefull scripts
  • Cleanup
  • What is next?
• Quickstart
  • Mentat backend
  • Mentat web interface
• Administration
  • Configuration
  • Monitoring
  • Maintenance
• Reporting
  • Event reporting
• Database
  • Database configuration tuning
  • Current database schema
  • Usefull maintenance queries
• System modules
  • Daemon modules (real-time message processing modules)
  • Script modules (message post-processing modules)
  • Utility and management modules
  • User interfaces
• Hawat: Web user interface
  • Plugins
  • Configuration
  • Web API
• Development
  • Key information
  • Getting the code
  • General guidelines
  • Development essentials
  • Database schema migrations
  • Versioning
  • Tagging
  • Building Python packages
  • Building Debian packages
  • Examples
• API documentation
  • Python submodules

Useful links and references

• official project website

• project support and bug tracking system (Redmine)

• primary code repository (Git)

• automated project build system (Alchemist)

Indices and tables

• Index

• Module Index