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

Update readme

This commit is contained in:
Marcus Hill 2022-01-29 20:08:07 +00:00
parent c3b7f28057
commit 450fc4c332
3 changed files with 170 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/dash.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 73 KiB

227
README.md
View File

@ -1,30 +1,126 @@
## IT Documentation, Accounting and Invoicing System for Small MSPs.
<div id="top"></div>
### Online Demo
<!-- PROJECT SHIELDS -->
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Commits][commit-shield]][commit-url]
[![GPL License][license-shield]][license-url]
* https://demo.itflow.org
* USERNAME: demo@demo
* PASSWORD: demo
<!-- PROJECT LOGO -->
<div align="center">
<!-- <a href="https://github.com/johnnyq/itflow">
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a> -->
### Notice
* This project is still in early Beta stages and is considered a **work in progress**. Many changes are being performed and may cause breakage upon updates.
<h3 align="center">ITFlow</h3>
<p align="center">
IT Documentation, Accounting and Invoicing System for Small MSPs.
<br />
<br />
<a href="https://demo.itflow.org"><strong>View demo</strong></a>
<br />
Username: <b>demo@demo</b> | Password: <b>demo</b>
<br />
<br />
<a href="https://github.com/johnnyq/itflow">Docs</a>
·
<a href="https://forum.itflow.org/">Forum</a>
·
<a href="https://github.com/johnnyq/itflow/issues">Report Bug</a>
·
<a href="https://github.com/johnnyq/itflow/issues">Request Feature</a>
</p>
</div>
<!-- ABOUT THE PROJECT -->
## About
[![ITFlow][product-screenshot]]()
<b>ITFlow is a free & open-source solution for IT service management, documentation, and accounting & invoicing.</b>
- ITFlow consolidates common MSP requirements (ticketing, wiki/docs, CMDB and accounting) into one tool.
- ITFlow is primarily targeted towards Managed Service Providers but may also be suitable for internal IT departments.
### In Beta
* This project is still in early beta and is considered a **work in progress**. Many changes are being performed and may cause breakage upon updates.
* We strongly recommend against storing confidential information like passwords in ITFlow at this time.
* We are hoping to have a stable 1.0 release by July 2022.
### Features
<!-- BUILT WITH -->
### Built With
* Backend / PHP libs
* PHP
* MariaDB
* PHPMailer
* CSS
* Bootstrap
* AdminLTE
* fontawesome
* JS Libraries
* chart.js
* moments.js
* jQuery
* pdfmake
* Select2
* SummerNote
* FullCalendar.io
<!-- GETTING STARTED -->
## Getting Started
ITFlow is self-hosted. There is a full installation guide in the [docs](https://itflow.org/docs.php?doc_id=1), but the main steps are:
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* Git
```sh
sudo apt install git
```
* Apache
```sh
sudo apt install apache2
```
* PHP
```sh
sudo apt install php libapache2-mod-php
```
* MariaDB
```sh
sudo apt install mariadb-server
```
### Installation
1. Login to your server, change directory to your web root
2. Clone the repo
```sh
git clone https://github.com/johnnyq/itflow.git .
```
3. Create a MariaDB Database
4. Point your browser to your HTTPS web server to begin setup
<!-- FEATURES -->
## Features
* Client Documentation
* Contacts - Keep track of important individuals
* Locations (Head Quarters, Satellite locations)
* Vendors (ISP, WebHost, MailHost, Software Company, VOIP company, etc.)
* Assets (Laptop, Workstations, Routers, Switches, Access Points, phones, etc.)
* Password Manager (AES Encrypted in database)
* Domain Names & SSL Certificates
* Software (Manage Applications Licenses, Renewals etc.)
* Networks
* Files (PDF Contracts, Manuals, Firewall Backup Configs, etc.)
* Documents (Tech Docs, How-tos, Processes, Procedures, Notes, etc.)
* Tickets
* Client Documentation (Single Downloadable IT Documentation for a client)
* <b>Contacts</b> - Keep track of important individuals
* <b>Locations</b> (Head Quarters, Satellite locations)
* <b>Vendors</b> (ISP, WebHost, MailHost, Software Company, VOIP company, etc.)
* <b>Assets</b> (Laptop, Workstations, Routers, Switches, Access Points, phones, etc.)
* <b>Password Manager</b> (AES Encrypted in database)
* <b>Domain Names & SSL Certificates</b>
* <b>Software</b> (Manage Applications Licenses, Renewals etc.)
* <b>Networks</b>
* <b>Files</b> (PDF Contracts, Manuals, Firewall Backup Configs, etc.)
* <b>Documents</b> (Tech Docs, How-tos, Processes, Procedures, Notes, etc.)
* <b>Services</b> (Relate all of the above together, e.g. Active Directory, a web app, etc.)
* <b>Tickets</b>
* Single Downloadable IT Documentation for a client
* Client Portal
* Invoice, Quotes and Payment information
* More to come soon...
@ -69,42 +165,7 @@
* 2FA Login Support (TOTP)
### Installation Instructions
* Change directory to your webroot
* git clone https://github.com/johnnyq/itflow.git .
* Create a MariaDB database (Note MySQL is broken)
* Point your browser to your Web Server
* Go through the Setup Process
* Login
* Start inputting some data
#### Requirements
* Webserver (Apache, NGINX)
* PHP7+
* MariaDB (MySQL is broken)
### Technologies Used
* Backend / PHP libs
* PHP
* MariaDB
* PHPMailer
* CSS
* Bootstrap
* AdminLTE
* fontawesome
* JS Libraries
* chart.js
* moments.js
* jQuery
* pdfmake
* Select2
* SummerNote
* FullCalendar.io
### API Calls
## API
* Caller ID lookup (Great for integrating with your phone system like FreePBX, and having your VOIP phone return the client's name thats calling in) - /api.php?api_key=[API_KEY]&cid=[PHONE_NUMBER] - Returns a name
* XML Phonebook Download - /api.php?api_key=[API_KEY]&phonebook
* Client Email (great for mailing lists) - /api.php?api_key=[API_KEY]&client_emails - Returns Client Name - Email Address
@ -113,10 +174,62 @@
* Required: api_key, client_id, add_asset (name)
* NOTE: [API_KEY] - is auto generated when a company is created and shows up in General Settings, this can also be changed manually.
### Future Todo
<!-- ROADMAP -->
## Roadmap / Future to-do
* MeshCentral / TacticalRMM (Export Assets Info to ITFlow, Exports common software applications to Software)
* CalDAV to integrate with 3rd party calendars
* CardDAV to integrate with 3rd party Address books
* Stripe Integration for online payments
* Toast Alerts with recent caller that matches caller ID in database which allows you to click on the toast alerts 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](https://forum.itflow.org) and the [open issues](https://github.com/johnnyq/itflow/issues) for a full list of proposed features & known issues.
<!-- CONTRIBUTING -->
## Support & Contributions
### Forum
For assistance using ITFlow, general discussions, and feature requests please use the community <a href="https://forum.itflow.org">forum</a>.
For bugs, please raise an [issue](https://github.com/johnnyq/itflow/issues).
### Contributing
If you are able to make a contribution that would make ITFlow better, please fork the repo and create a pull request.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature`)
3. Commit your Changes (`git commit -m 'Add some'`)
4. Push to the Branch (`git push origin feature`)
5. Open a Pull Request
#### Contributors
<a href="https://github.com/johnnyq/itflow/graphs/contributors">
<img src="https://contrib.rocks/image?repo=johnnyq/itflow" />
</a>
<!-- LICENSE -->
## License
ITFlow is distributed under the GPL License in the hope that it will be useful, but WITHOUT ANY WARRANTY. See `LICENSE.txt` for details.
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/johnnyq/itflow.svg?style=for-the-badge
[contributors-url]: https://github.com/johnnyq/itflow/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/johnnyq/itflow.svg?style=for-the-badge
[forks-url]: https://github.com/johnnyq/itflow/network/members
[stars-shield]: https://img.shields.io/github/stars/johnnyq/itflow.svg?style=for-the-badge
[stars-url]: https://github.com/johnnyq/itflow/stargazers
[issues-shield]: https://img.shields.io/github/issues/johnnyq/itflow.svg?style=for-the-badge
[issues-url]: https://github.com/johnnyq/itflow/issues
[license-shield]: https://img.shields.io/github/license/johnnyq/itflow.svg?style=for-the-badge
[license-url]: https://github.com/johnnyq/itflow/blob/master/LICENSE.txt
[commit-shield]: https://img.shields.io/github/last-commit/johnnyq/itflow?style=for-the-badge
[commit-url]: https://github.com/johnnyq/itflow/commits/master
[product-screenshot]: .github/dash.png
<!-- https://github.com/othneildrew/Best-README-Template -->

0
README2.md Normal file
View File