|
| 1 | +# MultiFlexi Documentation |
| 2 | + |
| 3 | +[](https://multiflexi.readthedocs.io/en/latest/) |
| 4 | +[](https://jenkins.vitexsoftware.cz/job/multiflexi-doc-en/) |
| 5 | + |
| 6 | +English documentation for [MultiFlexi](https://multiflexi.eu) — a PHP-based task scheduling and automation framework for accounting and business system integrations. |
| 7 | + |
| 8 | +**Read online:** https://multiflexi.readthedocs.io/en/latest/ |
| 9 | + |
| 10 | +## Contents |
| 11 | + |
| 12 | +- **Getting Started** — quickstart, installation, first-run setup |
| 13 | +- **Core Concepts** — system overview, data model, job lifecycle, credential management, execution architecture |
| 14 | +- **How-To Guides** — adding companies, installing applications, creating run templates, scheduling jobs, assigning credentials, debugging |
| 15 | +- **Integration Guides** — AbraFlexi, Pohoda, Zabbix, OpenTelemetry, Ansible, Kubernetes |
| 16 | +- **Reference** — REST API, CLI commands, configuration, application schema, executors, actions |
| 17 | +- **System Administration** — Docker deployment, systemd services, database maintenance, backup, upgrading |
| 18 | +- **Development** — architecture, project structure, application development, testing, contributing |
| 19 | + |
| 20 | +## Building Locally |
| 21 | + |
| 22 | +### Prerequisites |
| 23 | + |
| 24 | +```bash |
| 25 | +sudo apt install python3-sphinx python3-shibuya-sphinx-theme |
| 26 | +``` |
| 27 | + |
| 28 | +Or with pip: |
| 29 | + |
| 30 | +```bash |
| 31 | +pip install -r requirements.txt |
| 32 | +``` |
| 33 | + |
| 34 | +### Build HTML |
| 35 | + |
| 36 | +```bash |
| 37 | +make html |
| 38 | +# Output: build/html/index.html |
| 39 | +``` |
| 40 | + |
| 41 | +### Build other formats |
| 42 | + |
| 43 | +```bash |
| 44 | +make epub # EPUB e-book |
| 45 | +make latex # LaTeX (requires texlive) |
| 46 | +make text # Plain text |
| 47 | +``` |
| 48 | + |
| 49 | +## Automatic Publishing |
| 50 | + |
| 51 | +Every push to `main` triggers a rebuild on [ReadTheDocs](https://multiflexi.readthedocs.io/) via GitHub Actions. |
| 52 | + |
| 53 | +## Debian Package |
| 54 | + |
| 55 | +The documentation is also distributed as a Debian package (`multiflexi-doc`) that installs the built HTML to `/usr/share/doc/multiflexi/html/`. |
| 56 | + |
| 57 | +```bash |
| 58 | +# Build the .deb |
| 59 | +dpkg-buildpackage -b --no-sign |
| 60 | + |
| 61 | +# Install |
| 62 | +sudo apt install ./multiflexi-doc_*.deb |
| 63 | +# Browse at http://localhost/multiflexi-doc/ (requires Apache or Nginx) |
| 64 | +``` |
| 65 | + |
| 66 | +Apache configuration is enabled automatically on install. |
| 67 | +Nginx snippet is installed to `/usr/share/doc/multiflexi/multiflexi-doc.nginx`. |
| 68 | + |
| 69 | +## Documentation Standards |
| 70 | + |
| 71 | +See [AGENTS.md](AGENTS.md) for language, formatting, and content rules that apply to all contributions. |
| 72 | + |
| 73 | +Key rules: |
| 74 | +- English only; active voice; second person ("you") |
| 75 | +- reStructuredText (`.rst`) for all source files |
| 76 | +- Always specify language in code blocks |
| 77 | +- Provide working, copy-paste-ready examples |
| 78 | +- Only document released, implemented behaviour |
| 79 | +- Cross-check app/credential-type field docs against the [canonical JSON schemas](https://github.com/VitexSoftware/php-vitexsoftware-multiflexi-core) |
| 80 | + |
| 81 | +## Contributing |
| 82 | + |
| 83 | +1. Edit the relevant `.rst` file under `source/` |
| 84 | +2. Build locally and verify: `make html` |
| 85 | +3. Commit and push — ReadTheDocs rebuilds automatically |
| 86 | + |
| 87 | +## Related Projects |
| 88 | + |
| 89 | +| Project | Description | |
| 90 | +|---|---| |
| 91 | +| [MultiFlexi](https://github.com/VitexSoftware/MultiFlexi) | Main web application | |
| 92 | +| [multiflexi-cli](https://github.com/VitexSoftware/multiflexi-cli) | Command-line interface | |
| 93 | +| [multiflexi-tui](https://github.com/VitexSoftware/multiflexi-tui) | Terminal UI | |
| 94 | +| [php-vitexsoftware-multiflexi-core](https://github.com/VitexSoftware/php-vitexsoftware-multiflexi-core) | Core PHP library | |
| 95 | +| [multiflexi-api](https://github.com/VitexSoftware/multiflexi-api) | REST API server | |
0 commit comments