AS1024
/
itflow
mirror of https://github.com/itflow-org/itflow
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
itflow/README.md

7.8 KiB
Raw Blame History

Contributors Stargazers Issues Commits GPL License

ITFlow

IT documentation, ticketing and accounting system for small MSPs.

View demo
Username: demo@demo | Password: demo

About · Docs · Forum · Report Bug · Request Feature

About

A comprehensive, free & open-source documentation, ticket management, and accounting platform.

ITFlow

The Problem

  • You're a busy MSP with 101 things to do.
  • Information about your clients is unorganised and unstructured: scattered in random tickets or folders - when you do eventually find it, it's out of date.
  • For some issues, you spend longer looking for the relevant documentation than actually working the ticket.
  • 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 (IT Documentation, ticketing and billing) into one system

In Beta

  • This project is in beta with many ongoing changes. Updates may unintentionally introduce bugs/security issues. Writing functional, secure code is very difficult.
  • Whilst we are confident the code is safe, nothing in life is 100% safe or risk-free. Use your best judgement before deciding to store highly confidential information in ITFlow.
  • We are hoping to have a stable 1.0 release by December 2023.

Built With

  • Backend / PHP libs

    • PHP
    • MariaDB
    • PHPMailer
    • HTML Purifier
    • PHP Mime Mail Parser

  • CSS

    • Bootstrap
    • AdminLTE
    • fontawesome

  • JS Libraries

    • chart.js
    • moments.js
    • jQuery
    • pdfmake
    • Select2
    • TinyMCE
    • FullCalendar.io

Getting Started / Installation

ITFlow is self-hosted. There is a full installation guide in the docs, but the main steps are:

  1. Install a LAMP stack (Linux, Apache, MariaDB, PHP) 
    sudo apt install git apache2 php libapache2-mod-php php-intl php-imap php-mailparse php-mysqli php-curl mariadb-server
  2. Clone the repo 
    git clone https://github.com/itflow-org/itflow.git /var/www/html
  3. Create a MariaDB Database
  4. Point your browser to your HTTPS web server to begin setup

Installation via Script (Recommended Method)

Security message This project is currently in Beta with many ongoing changes.

Whilst we're confident the majority of code is safe, nothing in life is 100% safe or risk-free. Writing functional, secure code is very difficult. The current fast pace of development/change may unintentionally introduce bugs/security issues. Use your best judgment before storing highly confidential information in the app. You may wish to consider running ITFlow on it's own server, using a web-app firewall, restricting access (except /portal) to trusted IP addresses, etc. Need to report a security issue? Check the security policy

ITFlow comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law

ITFlow is self-hosted. There is a full installation guide in the docs, but the TLDR is:

Requirements

  • Clean Install of Debian 12 or Ubuntu 22.04
  • A public IP Address
  • Ports 80 (HTTP) and 443 (HTTPS) TCP accessible from the outside in
  • A Fully Qualified Domain Name pointing to the public IP Address – example itflow.example.com, NOT itflow.xyz.example.com

Process

  • Login as root
  • Download Script 
    wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh
  • Read over script to understand purpose and function
  nano itflow.sh
  • Close nano with ctrl + 'X'
  • Run Scipt
  bash itflow_install.sh
  • Follow Instructions
  • Leave us feedback in the forum

Key Features

  • Client documentation - assets, contacts, domains, docs, files, passwords, and more
  • Accounting / Billing - finance dashboard, quotes, invoices, accounting, expenses, etc
  • Client Portal - self service quote/invoice/ticket management for clients
  • Alerting - account balance, invoices, domain/SSL renewals
  • Completely free & open-source alternative to ITGlue and Hudu

Roadmap / Future to-do

  • Comprehensive API to allow custom third party integration
  • CalDAV to integrate with 3rd party calendars
  • CardDAV to integrate with 3rd party Address books
  • Recent caller toast alerts to click and bring up the clients account right away
  • FIDO2 WebAuthn Support for passwordless auth (TPM Fingerprint), (USB Hardware keys such as Yubikey)

See the forum and the open issues for a full list of proposed features & known issues.

Support & Contributions

Forum

For help using ITFlow, feature requests, and general ideas / discussions please use the community forum. For bugs, please raise an issue.

Contributing

If you are able to make a contribution that would make ITFlow better, please fork the repo and create a pull request. Please make sure you're following our code standards. For large changes / new features, please discuss the issue with other contributors first.

Contributors

License

ITFlow is distributed "as is" under the GPL License, WITHOUT WARRANTY OF ANY KIND. See LICENSE for details.