mirror of
https://github.com/itflow-org/itflow
synced 2026-08-17 13:05:12 +00:00
Update readme
This commit is contained in:
31
README.md
31
README.md
@@ -27,7 +27,7 @@
|
|||||||
·
|
·
|
||||||
<a href="https://forum.itflow.org/t/bug">Report Bug</a>
|
<a href="https://forum.itflow.org/t/bug">Report Bug</a>
|
||||||
·
|
·
|
||||||
<a href="https://forum.itflow.org/t/features">Request Feature</a>
|
<a href="https://forum.itflow.org/t/features">Suggest Feature</a>
|
||||||
·
|
·
|
||||||
<a href="https://github.com/itflow-org/itflow/security/policy">Security</a>
|
<a href="https://github.com/itflow-org/itflow/security/policy">Security</a>
|
||||||
</p>
|
</p>
|
||||||
@@ -44,16 +44,16 @@
|
|||||||
### The Problem
|
### 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.
|
- 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.
|
- For some work, you seem to spend longer looking for the relevant documentation than actually working on the issue/project.
|
||||||
- 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.
|
- 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
|
### The Solution: ITFlow
|
||||||
- ITFlow consolidates common MSP needs (documentation, ticketing and billing) into one unified system.
|
- ITFlow consolidates common MSP needs (documentation, ticketing and billing) into one unified, free platform that you control.
|
||||||
|
|
||||||
<!-- GETTING STARTED -->
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Self Hosting
|
### Self Hosting
|
||||||
- The best installation method is to use the [install script](https://docs.itflow.org/installation_script) on Ubuntu/Debian. A video walk through is available [here](https://www.youtube.com/watch?v=kKz9NOU_1XE).
|
- 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
|
wget -O itflow_install.sh https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh
|
||||||
bash itflow_install.sh
|
bash itflow_install.sh
|
||||||
@@ -61,25 +61,25 @@
|
|||||||
- Other manual installation methods are available in the [docs](https://docs.itflow.org/installation).
|
- Other manual installation methods are available in the [docs](https://docs.itflow.org/installation).
|
||||||
|
|
||||||
### Managed Hosting
|
### Managed Hosting
|
||||||
- If you'd prefer, we can [host ITFlow for you](https://services.itflow.org/hosting.php).
|
- If you'd prefer, we can [host ITFlow for you](https://services.itflow.org/hosting.php) (coming soon).
|
||||||
|
|
||||||
<!-- FEATURES -->
|
<!-- FEATURES -->
|
||||||
## Key Features
|
## Key Features
|
||||||
* Client documentation - assets, contacts, domains, docs, files, passwords, and more
|
* Client documentation - assets, contacts, domains, docs/files, passwords, tickets, and more
|
||||||
* Accounting / Billing - finance dashboard, quotes, invoices, accounting, expenses, etc
|
* Billing - quotes, invoices and expenses, with Stripe integration for online payments
|
||||||
* Client Portal - self service quote/invoice/ticket management for clients
|
* Alerting - domain and SSL expiry/renewals
|
||||||
* Alerting - account balance, invoices, domain/SSL renewals
|
* Client Portal - self service quote, invoice, and ticket management for clients
|
||||||
* Completely free & open-source alternative to ITGlue and Hudu
|
|
||||||
|
|
||||||
<!-- ROADMAP -->
|
<!-- ROADMAP -->
|
||||||
## Roadmap / Future to-do
|
## 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 request features or raise bug reports.
|
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 -->
|
<!-- CONTRIBUTING -->
|
||||||
## Support & Contributions
|
## Support & Contributions
|
||||||
|
|
||||||
### Forum
|
### Forum
|
||||||
For help using ITFlow, bugs, feature requests, and general ideas / discussions please use the community [forum](https://forum.itflow.org).
|
For help using ITFlow, bugs, feature suggestions, and other general ideas or discussions, please use the community [forum](https://forum.itflow.org).
|
||||||
|
|
||||||
### Contributing
|
### Contributing
|
||||||
We have temporarily paused PRs from the community.
|
We have temporarily paused PRs from the community.
|
||||||
@@ -90,17 +90,16 @@ We have temporarily paused PRs from the community.
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
### Supporters
|
### Supporters
|
||||||
We’re incredibly grateful to the organizations and individuals who support 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
|
- CompuMatter
|
||||||
- F1 for HELP
|
- F1 for HELP
|
||||||
- digiBandit
|
- digiBandit
|
||||||
- JetBrains (PhpStorm)
|
|
||||||
|
|
||||||
## License
|
## 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.
|
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
|
## Security
|
||||||
* As of 2025, we now have a stable release of the project.
|
* 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.
|
* 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).
|
* If you have a security concern, privately report it [here](https://github.com/itflow-org/itflow/security/policy).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user