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

Summarise/consolidate README main points - we have the docs for documentation now

This commit is contained in:
Marcus Hill 2022-02-26 16:14:24 +00:00
parent d7855c2a53
commit c847dd65cc
1 changed files with 17 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
README.md
View File

@ -37,7 +37,7 @@
<!-- ABOUT THE PROJECT -->
## About
[![ITFlow][product-screenshot]]()
[![ITFlow][product-screenshot]](https://itflow.org)
<b>ITFlow is a free & open-source solution for IT service management, documentation, and accounting.</b>
@ -78,110 +78,28 @@
* FullCalendar.io
<!-- GETTING STARTED -->
## Getting Started
## Getting Started / Installation
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
* Git
```sh
sudo apt install git
```
* Apache
```sh
sudo apt install apache2
```
* PHP
```sh
sudo apt install php libapache2-mod-php php-intl
```
* MariaDB
```sh
sudo apt install mariadb-server
```
### Installation
1. Login to your server, change directory to your web root
1. Install a a LAMP stack (Linux, Apache, MariaDB, PHP)
```sh
sudo apt install git apache2 php libapache2-mod-php php-intl mariadb-server
```
2. Clone the repo
```sh
git clone https://github.com/johnnyq/itflow.git .
git clone https://github.com/johnnyq/itflow.git /var/www/html
```
3. Create a MariaDB Database
4. Point your browser to your HTTPS web server to begin setup
<!-- FEATURES -->
## Features
* Client Documentation
* <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...
* Invoicing
* Automatically Emails Past Due Invoices to clients
* Automatically Email Receipts upon marking invoices paid
* Automatic Recurring Invoices
* Quotes
* Automated customer approval process using a link that is sent via email to the primary contact
* One Click turn Quotes into Invoices
* Accounting
* Expense Tracking (Track internal business expenses such as Office Supplies, Professional Services, Equipment, etc.)
* Profit and Loss Reports
* Income/Expense Summaries
* Travel Mileage Tracking
* Accounts (Manage several accounts including cash on hand, bank accounts, etc.)
* Account Transfers (Keep track of money transfers from account to account including deposits)
* Alerting/Notifications
* Low Account Balances
* Domains to expire
* Password reset reminder for customers
* Past Due Invoices
* Software License Expiration
* Calendar
* Schedule Jobs
* Overview of Invoices, Domains, Asset Warranty Expiry, etc.
* Schedule Events
* Automatic Email Reminders of upcoming calendar events to customers
* Dashboard
* Overview of business financials
* Mailing List - Notify users of upcoming change controls, marketing, etc.
* API
* XML Phonebook download for VOIP Phones
* FreePBX Integrated called ID (When call comes in it queries the Database and displays the company name on your caller ID as well as alerts you in the CRM)
* Pull Emails for Mailing list Integration
* Check account Balances using FreePBX IVR
* Multi-Tenant - One Instance Multiple Companies and Users
* Audit Logging - Logs detailed actions of users and events
* Permissions / Roles
* 2FA Login Support (TOTP)
## 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
* Account Balance for Client (can be integrated into multiple places for example in FreePBX Press 3 to check account balance, please enter your client ID your balance is) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance
* Add new asset for a client - /api.php?api_key=[API_KEY]&client_id=ClientID&add_asset=Name&type=[Desktop|Laptop|Server]&make=Make&model=Model&serial=Serial&os=OS
* 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.
## Key Features
* Client documentation - assets, contacts, domains, files, passwords, and more
* Accounting/Billing - finance dashboard, quotes, invoices, accounting, expenses, etc
* Client Portal - self service quotes/invoices management for clients (more features to come soon!)
* Alerting - account balance, invoices, domain/SSL renewals
<!-- ROADMAP -->
## Roadmap / Future to-do
@ -192,24 +110,19 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https://
* 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.
See the [forum](https://forum.itflow.org/d/11-road-map) 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, feature requests, and general ideas/discussions please use the community <a href="https://forum.itflow.org">forum</a>.
For assistance using ITFlow, feature requests, and general ideas/discussions please use the community [forum](https://forum.itflow.org).
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
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](https://itflow.org/docs.php?doc=coding-standards).
For large changes/new features, please discuss the issue with other contributors first.
#### Contributors
<a href="https://github.com/johnnyq/itflow/graphs/contributors">