1.1 About This Documentation

This document is the official user and administrator guide for LoonFlow, a self-hosted, workflow-based ticketing system. It is designed to help you understand, install, configure, and effectively use LoonFlow to manage your team’s requests and processes.

Purpose & Scope

This guide covers all aspects of the system, from initial installation and core concepts to daily operations and advanced administrative configurations. It is intended for:

  • End Users - Who submit and handle tickets in their daily work

  • Administrators & Implementers - Who are responsible for deploying, customizing, and maintaining the LoonFlow instance

  • IT Managers - Who need to understand the system’s capabilities to align it with business processes

Conventions Used

To improve readability, we use the following conventions throughout this guide:

Text Formatting

  • Bold Text - Used to highlight key interface elements, such as buttons (Submit), menu items (Settings), or page titles (My Tickets)

  • Code / Monospace Font - Indicates file names, configuration parameters, database commands, or code snippets (e.g., DEBUG = False, docker-compose up)

Admonitions

Note

Provides additional information or tips that are helpful but not critical.

Important

Highlights crucial information required for a task to succeed.

Warning

Indicates a potential risk of data loss or configuration error.

Feedback and Support

We strive to keep this documentation accurate and helpful. If you find any errors, have suggestions for improvements, or encounter topics that need more clarification, please reach out through our official support channels.

Note

The software and this documentation are subject to continuous improvement. Please refer to the version information at the beginning of this document to ensure you are consulting the correct guide for your installed version of LoonFlow.