README: rewrite for 26.11 with the ITFlow logo, a dashboard screenshot that follows GitHub's light or dark mode, a grid of eight screenshots from the demo (tickets board, ticket, client overview, assets, contract, invoices, calendar and client portal), a short why and what's new in 26.11, features grouped by service desk, client documentation, contracts and billing, client portal and team, requirements, the install script and both ways to update, and the community, contributing, supporters, security and license sections brought up to date; screenshots and logo in .github/readme

This commit is contained in:
johnnyq
2026-10-29 14:58:47 -04:00
parent 3ff116f0d3
commit 74497de30a
13 changed files with 170 additions and 79 deletions

BIN
.github/readme/assets.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

BIN
.github/readme/board.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

BIN
.github/readme/calendar.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

BIN
.github/readme/client.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

BIN
.github/readme/contract.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

BIN
.github/readme/dashboard-dark.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

BIN
.github/readme/dashboard.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

BIN
.github/readme/invoices.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

1
.github/readme/logo-dark.svg vendored Normal file
View File

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 140" width="320" height="70" role="img" aria-label="ITFlow"><!-- Paper plane: Font Awesome Free, CC BY 4.0 --><g transform="translate(4 8) scale(0.242)"><path fill="#0d6efd" d="M498.1 5.6c10.1 7 15.4 19.1 13.5 31.2l-64 416c-1.5 9.7-7.4 18.2-16 23s-18.9 5.4-28 1.6L284 427.7l-68.5 74.1c-8.9 9.7-22.9 12.9-35.2 8.1S160 493.2 160 480V396.4c0-4 1.5-7.8 4.2-10.7L331.8 202.8c5.8-6.3 5.6-16-.4-22s-15.7-6.4-22-.7L106 360.8 17.7 316.6C7.1 311.3 .3 300.7 0 288.9s5.9-22.8 16.1-28.7l448-256c10.7-6.1 23.9-5.5 34 1.4z"/></g><text x="150" y="112" font-family="Segoe UI, Helvetica Neue, Helvetica, Arial, sans-serif" font-size="118" font-weight="700" letter-spacing="-2"><tspan fill="#0d6efd">IT</tspan><tspan fill="#ffffff">Flow</tspan></text></svg>

After

Width:  |  Height:  |  Size: 796 B

1
.github/readme/logo-light.svg vendored Normal file
View File

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 140" width="320" height="70" role="img" aria-label="ITFlow"><!-- Paper plane: Font Awesome Free, CC BY 4.0 --><g transform="translate(4 8) scale(0.242)"><path fill="#0d6efd" d="M498.1 5.6c10.1 7 15.4 19.1 13.5 31.2l-64 416c-1.5 9.7-7.4 18.2-16 23s-18.9 5.4-28 1.6L284 427.7l-68.5 74.1c-8.9 9.7-22.9 12.9-35.2 8.1S160 493.2 160 480V396.4c0-4 1.5-7.8 4.2-10.7L331.8 202.8c5.8-6.3 5.6-16-.4-22s-15.7-6.4-22-.7L106 360.8 17.7 316.6C7.1 311.3 .3 300.7 0 288.9s5.9-22.8 16.1-28.7l448-256c10.7-6.1 23.9-5.5 34 1.4z"/></g><text x="150" y="112" font-family="Segoe UI, Helvetica Neue, Helvetica, Arial, sans-serif" font-size="118" font-weight="700" letter-spacing="-2"><tspan fill="#0d6efd">IT</tspan><tspan fill="#212529">Flow</tspan></text></svg>

After

Width:  |  Height:  |  Size: 796 B

BIN
.github/readme/portal.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

BIN
.github/readme/ticket.webp vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

247
README.md
View File

@@ -1,122 +1,211 @@
<div id="top"></div>
<!-- PROJECT SHIELDS -->
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Commits][commit-shield]][commit-url]
[![GPL License][license-shield]][license-url]
<div align="center">
<h3 align="center">ITFlow</h3>
<a href="https://itflow.org">
<picture>
<source media="(prefers-color-scheme: dark)" srcset=".github/readme/logo-dark.svg">
<img src=".github/readme/logo-light.svg" alt="ITFlow" width="300">
</picture>
</a>
### The free, open-source PSA for MSPs
Ticketing, client documentation, contracts and billing - with a client portal - in one place that you host and control.
[![Release][release-shield]][release-url]
[![Stargazers][stars-shield]][stars-url]
[![Contributors][contributors-shield]][contributors-url]
[![Commits][commit-shield]][commit-url]
[![GPL License][license-shield]][license-url]
[**Live demo**](https://demo.itflow.org) &nbsp;·&nbsp; [Website](https://itflow.org) &nbsp;·&nbsp; [Docs](https://docs.itflow.org) &nbsp;·&nbsp; [Forum](https://forum.itflow.org) &nbsp;·&nbsp; [What's new](CHANGELOG.md)
Demo sign in: `demo@demo.com` / `demo`
<p align="center">
IT documentation, ticketing and accounting system for small MSPs.
<br />
<br />
<a href="https://demo.itflow.org"><strong>View demo</strong></a>
<br />
Username: <b>demo@demo.com</b> | Password: <b>demo</b>
<br />
<br />
<a href="https://itflow.org/#about">About</a>
·
<a href="https://docs.itflow.org">Docs</a>
·
<a href="https://forum.itflow.org/">Forum</a>
·
<a href="https://forum.itflow.org/t/bug">Report Bug</a>
·
<a href="https://forum.itflow.org/t/features">Suggest Feature</a>
·
<a href="https://github.com/itflow-org/itflow/security/policy">Security</a>
</p>
</div>
<!-- ABOUT THE PROJECT -->
## About
<br>
<b>A comprehensive, free & open-source documentation, ticket management, and accounting platform.</b>
<picture>
<source media="(prefers-color-scheme: dark)" srcset=".github/readme/dashboard-dark.webp">
<img src=".github/readme/dashboard.webp" alt="The ITFlow dashboard: what needs attention today, your open tickets and your schedule">
</picture>
[![ITFlow][product-screenshot]](https://itflow.org)
## Why ITFlow
Small and growing MSPs juggle a lot: tickets coming in from every direction, client information scattered across spreadsheets and old notes, contracts nobody can find, and billing that eats into evenings. The usual answer is a stack of subscriptions that costs more every year.
### The Problem
- You're a small but busy managed service provider with 101 things to do. Information about your clients is unorganised, unstructured and outdated.
- For some work, you seem to spend longer looking for the relevant documentation than actually working on the issue/project.
- MSP tools can be expensive, with recurring licensing costs adding up quickly.
- On top of the technical day-to-day, you also have to take care of the financial side of the business - consistent pricing, quotes/invoicing, and accounting.
ITFlow brings the core of running an MSP into one app: the service desk, everything you know about each client's IT, the agreements you look after them on, and the invoicing that pays for it all - plus a portal where clients raise tickets, pay invoices and look up their own IT. It's free, it's open source, and it runs on your own server, so your clients' data stays with you.
### The Solution: ITFlow
- ITFlow consolidates common MSP needs (documentation, ticketing and billing) into one unified, free platform that you control.
## New in 26.11
## Getting Started
26.11 is the biggest release yet - nearly every page has been rebuilt. Highlights:
### Self Hosting
- The best installation method is to use the [install script](https://docs.itflow.org/installation_script) on Ubuntu/Debian. See the [video](https://www.youtube.com/watch?v=kKz9NOU_1XE) walk through.
- **Contracts** - every agreement with a client, sent to sign online and countersigned in ITFlow, with prepaid hours and the SLAs, rates and payment terms that apply while it's in force
- **Client onboarding** - take a new client on a step at a time, from their sites and people to their agreement, billing, domains and kickoff project
- **A new client portal** - a fresh look, requests clients can raise in a click, online payments and autopay, their devices and licenses, and contracts to sign
- **Rebuilt service desk** - list and board views, SLA timers with business hours, canned responses, ticket templates and @mentions in internal notes
- **Everywhere** - search everything with <kbd>Ctrl</kbd>+<kbd>K</kbd>, a dashboard that shows what needs attention, and dark mode throughout
- **Your team** - invite agents by email, set what each role can open and which clients each agent sees, and keep an audit log of every change
See the [changelog](CHANGELOG.md) for everything in this release, and back up before you update.
## Features
<table>
<tr>
<td width="50%" valign="top">
<img src=".github/readme/board.webp" alt="The tickets board">
<br><b>Tickets</b> - a list or a board, with SLA timers, views for whose move it is, and schedules for onsite visits.
</td>
<td width="50%" valign="top">
<img src=".github/readme/ticket.webp" alt="A ticket">
<br><b>Working a ticket</b> - reply by email or note, @mention a colleague, log time, work through tasks and book a visit.
</td>
</tr>
<tr>
<td width="50%" valign="top">
<img src=".github/readme/client.webp" alt="A client's overview">
<br><b>Client overview</b> - what needs attention, their contacts and sites, open tickets and the contract they're on.
</td>
<td width="50%" valign="top">
<img src=".github/readme/assets.webp" alt="A client's assets">
<br><b>Assets</b> - every device you look after, with its details, network, warranty and who uses it.
</td>
</tr>
<tr>
<td width="50%" valign="top">
<img src=".github/readme/contract.webp" alt="A contract">
<br><b>Contracts</b> - terms, renewals and notice dates, signing, prepaid hours and what each contract covers.
</td>
<td width="50%" valign="top">
<img src=".github/readme/invoices.webp" alt="The invoices list">
<br><b>Billing</b> - quotes, invoices and recurring invoices, unbilled time, payments and reminders.
</td>
</tr>
<tr>
<td width="50%" valign="top">
<img src=".github/readme/calendar.webp" alt="The calendar">
<br><b>Calendar</b> - booked tickets, project dates, service reviews and renewals, on your phone too.
</td>
<td width="50%" valign="top">
<img src=".github/readme/portal.webp" alt="The client portal">
<br><b>Client portal</b> - clients raise tickets and requests, pay invoices and look up their own IT.
</td>
</tr>
</table>
### Service desk
- Tickets by email, from the client portal or raised by you, from scratch or from a template
- SLAs per priority with business hours and closure days, and views for whose move it is
- Recurring tickets for routine work, projects with due dates and hour budgets, and canned responses
- A shared calendar that agents can subscribe to on their phone or in Outlook
### Client documentation
- Assets, contacts, locations, vendors, licenses, domains and services for every client
- Client logins with encrypted usernames and passwords, 2FA codes, and every look at a password recorded
- SSL/TLS certificates and domains checked daily, with expiry warnings
- Networks with an IP address plan, racks drawn to scale, and documents and files with versions and templates
- Expiring share links for logins, documents and secure notes
### Contracts and billing
- Contracts with online signing, renewals, notice reminders and prepaid hours drawn down by ticket time
- Quotes clients accept online, invoices they pay online by card through Stripe, and recurring invoices that bill per user, device or license seat
- Unbilled time, expenses and trips turned into invoices in a few clicks
- Payment reminders, late fees and monthly statements
- Expenses, income, accounts, bank statement import and reconciliation, and reports from profit and loss to SLA performance
### Client portal
- Clients raise tickets and requests, follow them and approve tasks
- Billing contacts see their invoices, pay by card, save a card for autopay, accept quotes and sign contracts
- Technical contacts look up their devices, licenses, domains, certificates and shared documents
- Invite people by email, or let a client's staff sign up with their company email address
### Built for your team
- Roles that set what each agent can open, and limits on which clients they can see
- Two-factor sign in, agent invites and an audit log of every change
- A REST API, optional AI help with replies and summaries using the provider of your choice, encrypted backups and one-click updates
## Get started
### Self hosting
ITFlow is a PHP web app with a MariaDB database. You run it on your own Linux server: a small VM with 2 CPU cores and 2 GB of memory is plenty for most MSPs.
| Part | What it needs |
|---|---|
| **Server** | Linux - Debian 13 for the install script; Debian 12 or Ubuntu 24.04 by hand |
| **PHP** | 8.2 or later, with mysqli, intl, curl, mbstring, gd, xml, openssl and fileinfo |
| **Database** | MariaDB or MySQL |
| **Web server** | Apache with mod_php, or nginx with PHP-FPM |
| **Also** | git (ITFlow updates itself with it), a cron entry that runs every minute, and a domain name with HTTPS |
The quickest way in is the [install script](https://github.com/itflow-org/itflow-install-script). On a fresh Debian 13 server, run it as root and answer four questions. It sets up Apache, MariaDB and PHP, gets a Let's Encrypt certificate, and leaves you at the setup wizard:
```bash
wget -O itflow_install.sh https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh
bash itflow_install.sh
```
wget -O itflow_install.sh https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh
bash itflow_install.sh
To install by hand, on a server you already run, or with a control panel, see the [docs](https://docs.itflow.org).
### Updating
Go to **Admin > Update** and click **Queue Update** - cron picks it up within a minute. Or run the updater from the command line, as the user that owns ITFlow's files:
```bash
sudo -u www-data php scripts/update_cli.php
```
- Other manual installation methods are available in the [docs](https://docs.itflow.org/installation).
### Managed Hosting
- If you'd prefer, we can [host ITFlow for you](https://services.itflow.org/hosting.php) (coming soon).
Either way, ITFlow updates its files to the latest release and then applies the database changes. Read the [changelog](CHANGELOG.md) and take a backup first.
<!-- FEATURES -->
## Key Features
* Client documentation - assets, contacts, domains, docs/files, passwords, tickets, and more
* Billing - quotes, invoices and expenses, with Stripe integration for online payments
* Alerting - domain and SSL expiry/renewals
* Client Portal - self service quote, invoice, and ticket management for clients
### Managed hosting
<!-- ROADMAP -->
## Roadmap / Future to-do
We track the implementation of confirmed features and bugs via [TaskFlow](https://tasks.dev.itflow.org/tasks.php). Use the [forum](https://forum.itflow.org) to suggest new features or report bugs.
If you'd rather not run a server, we can [host ITFlow for you](https://services.itflow.org/hosting.php) (coming soon).
<!-- CONTRIBUTING -->
## Support & Contributions
## Community and support
### Forum
For help using ITFlow, bugs, feature suggestions, and other general ideas or discussions, please use the community [forum](https://forum.itflow.org).
- **Help and discussion** - the community [forum](https://forum.itflow.org) is the place for questions, ideas and general discussion.
- **Bugs** - report them on the forum under [Bugs](https://forum.itflow.org/t/bug).
- **Feature ideas** - suggest them under [Features](https://forum.itflow.org/t/features). Confirmed work is tracked on [TaskFlow](https://tasks.dev.itflow.org/tasks.php).
### Contributing
We have temporarily paused PRs from the community.
#### Contributors
We have temporarily paused pull requests from the community. See [CONTRIBUTING.md](CONTRIBUTING.md).
<a href="https://github.com/itflow-org/itflow/graphs/contributors">
<img src="https://contrib.rocks/image?repo=itflow-org/itflow" />
<img src="https://contrib.rocks/image?repo=itflow-org/itflow" alt="Contributors">
</a>
### Supporters
We’re incredibly grateful to the organizations and individuals who [sponsor](https://services.itflow.org) the project - a big thank you to:
We're incredibly grateful to the organizations and individuals who [sponsor](https://services.itflow.org) the project - a big thank you to:
- CompuMatter
- F1 for HELP
- digiBandit
## License
ITFlow is distributed "as is" under the GPL License, WITHOUT WARRANTY OF ANY KIND. See [`LICENSE`](https://github.com/itflow-org/itflow/blob/master/LICENSE) for details.
## Security
* We've had a stable release of the project since Jan 2025.
* Whilst we are confident in the safety of the code, no system is risk-free. Nearly all software has bugs. Use your best judgement before storing highly confidential information in ITFlow.
* If you have a security concern, privately report it [here](https://github.com/itflow-org/itflow/security/policy).
ITFlow has had stable releases since January 2025. We take security reports seriously, but no system is risk-free - use your best judgement before storing highly confidential information in it.
If you find a security issue, please report it privately through our [security policy](https://github.com/itflow-org/itflow/security/policy) rather than in a public issue or on the forum.
## License
ITFlow is distributed "as is" under the GPL-3.0 license, WITHOUT WARRANTY OF ANY KIND. See [`LICENSE`](LICENSE) for details.
<p align="right"><a href="#top">Back to top</a></p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[release-shield]: https://img.shields.io/github/v/release/itflow-org/itflow?style=for-the-badge
[release-url]: https://github.com/itflow-org/itflow/releases
[contributors-shield]: https://img.shields.io/github/contributors/itflow-org/itflow.svg?style=for-the-badge
[contributors-url]: https://github.com/itflow-org/itflow/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/itflow-org/itflow.svg?style=for-the-badge
[forks-url]: https://github.com/itflow-org/itflow/network/members
[stars-shield]: https://img.shields.io/github/stars/itflow-org/itflow.svg?style=for-the-badge
[stars-url]: https://github.com/itflow-org/itflow/stargazers
[issues-shield]: https://img.shields.io/github/issues/itflow-org/itflow.svg?style=for-the-badge
[issues-url]: https://github.com/itflow-org/itflow/issues
[license-shield]: https://img.shields.io/github/license/itflow-org/itflow.svg?style=for-the-badge
[license-url]: https://github.com/itflow-org/itflow/blob/master/LICENSE
[commit-shield]: https://img.shields.io/github/last-commit/itflow-org/itflow?style=for-the-badge
[commit-url]: https://github.com/itflow-org/itflow/commits/master
[product-screenshot]: .github/readme.gif
<!-- https://github.com/othneildrew/Best-README-Template -->