mirror of
https://github.com/itflow-org/itflow
synced 2026-08-25 17:05:15 +00:00
123 lines
5.3 KiB
Markdown
123 lines
5.3 KiB
Markdown
<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>
|
||
|
||
<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
|
||
|
||
<b>A comprehensive, free & open-source documentation, ticket management, and accounting platform.</b>
|
||
|
||
[![ITFlow][product-screenshot]](https://itflow.org)
|
||
|
||
|
||
### 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.
|
||
|
||
### The Solution: ITFlow
|
||
- ITFlow consolidates common MSP needs (documentation, ticketing and billing) into one unified, free platform that you control.
|
||
|
||
## Getting Started
|
||
|
||
### 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.
|
||
```
|
||
wget -O itflow_install.sh https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh
|
||
bash itflow_install.sh
|
||
```
|
||
- 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).
|
||
|
||
<!-- 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
|
||
|
||
|
||
<!-- 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.
|
||
|
||
<!-- CONTRIBUTING -->
|
||
## Support & Contributions
|
||
|
||
### Forum
|
||
For help using ITFlow, bugs, feature suggestions, and other general ideas or discussions, please use the community [forum](https://forum.itflow.org).
|
||
|
||
### Contributing
|
||
We have temporarily paused PRs from the community.
|
||
|
||
#### Contributors
|
||
<a href="https://github.com/itflow-org/itflow/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=itflow-org/itflow" />
|
||
</a>
|
||
|
||
### Supporters
|
||
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).
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES -->
|
||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||
[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 -->
|