mirror of https://github.com/itflow-org/itflow
Updated Readme
This commit is contained in:
parent
991264d3ba
commit
d0c0ca0a2c
49
README.md
49
README.md
|
|
@ -8,35 +8,35 @@
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
* Client Documentation
|
* Client Documentation
|
||||||
* Contacts
|
* Contacts - Keep track of important individuals
|
||||||
* Locations (Head Quarters, Satellite locations)
|
* Locations (Head Quarters, Satellite locations)
|
||||||
* Vendors (ISP, WebHost, MailHost etc)
|
* Vendors (ISP, WebHost, MailHost, Software Company, VOIP company etc)
|
||||||
* Assets (Laptop, Workstations, Routers, Switches, Access Points, phones, etc)
|
* Assets (Laptop, Workstations, Routers, Switches, Access Points, phones, etc)
|
||||||
* Password Manager (AES Encrypted in DB)
|
* Password Manager (AES Encrypted in DB)
|
||||||
* Domain Names
|
* Domain Names
|
||||||
* Software (Manage Applications Licenses)
|
* Software (Manage Applications Licenses, Renewals etc)
|
||||||
* Networks
|
* Networks
|
||||||
* Files (PDF Contracts, Manuals, Router Backup Configs, etc)
|
* Files (PDF Contracts, Manuals, Firewall Backup Configs, etc)
|
||||||
* Documents (Tech Docs, How-tos, Notes, etc)
|
* Documents (Tech Docs, How-tos, Processes, Procedures, Notes, etc)
|
||||||
* Tickets
|
* Tickets
|
||||||
* Client Documentation (Single Downloadable PDF of all documentation for a client)
|
* Client Documentation (Single Downloadable IT Documentation for a client)
|
||||||
* Client Portal
|
* Client Portal
|
||||||
* Invoice, Quotes and Payment information
|
* Invoice, Quotes and Payment information
|
||||||
* More to come soon...
|
* More to come soon...
|
||||||
* Invoicing
|
* Invoicing
|
||||||
* Automatically Emails Past Due Invoices to clients
|
* Automatically Emails Past Due Invoices to clients
|
||||||
* Auto Email Receipts upon receiving payments
|
* Automatically Email Receipts upon marking invoices paid
|
||||||
* Automatic Recurring Invoices
|
* Automatic Recurring Invoices
|
||||||
* Quotes
|
* Quotes
|
||||||
* Automated customer approval process using a link that sent via email
|
* Automated customer approval process using a link that is sent via email to the primary contact
|
||||||
* Turn Quotes into invoices with a signle click
|
* One Click turn Quotes into Invoices
|
||||||
* Accounting
|
* Accounting
|
||||||
* Expense Tracking (Track Internal Business Expenses such as Office Supplies, Professional Services, Equipment etc)
|
* Expense Tracking (Track internal business expenses such as Office Supplies, Professional Services, Equipment, etc)
|
||||||
* Profit and Loss Reports
|
* Profit and Loss Reports
|
||||||
* Income/Expense Summaries
|
* Income/Expense Summaries
|
||||||
* Travel Mileage Tracking (Track your mileage to and from clients and other points of business)
|
* Travel Mileage Tracking
|
||||||
* Account Transfers / Deposits (Keep track of money transfers from account to account)
|
* Accounts (Manage several accounts including cash on hand, bank accounts, etc)
|
||||||
* Accounts
|
* Account Transfers (Keep track of money transfers from account to account inclusing deposits)
|
||||||
* Alerting/Notifications
|
* Alerting/Notifications
|
||||||
* Low Account Balances
|
* Low Account Balances
|
||||||
* Domains to expire
|
* Domains to expire
|
||||||
|
|
@ -45,11 +45,12 @@
|
||||||
* Software License Expiration
|
* Software License Expiration
|
||||||
* Calendar
|
* Calendar
|
||||||
* Schedule Jobs
|
* Schedule Jobs
|
||||||
* Overview of Invoices, Domains that are expiring, etc
|
* Overview of Invoices, Domains, asset Warranty Expiry, etc
|
||||||
* Schedule Events
|
* Schedule Events
|
||||||
* Automatic Email Reminders of upcoming calendar events to customers
|
* Automatic Email Reminders of upcoming calendar events to customers
|
||||||
* Dashboard
|
* Dashboard
|
||||||
* Overview of business financials
|
* Overview of business financials
|
||||||
|
* Mailing List - Notify users of upcoming change controls, marketing etc
|
||||||
|
|
||||||
* API
|
* API
|
||||||
* XML Phonebook download for VOIP Phones
|
* XML Phonebook download for VOIP Phones
|
||||||
|
|
@ -58,15 +59,16 @@
|
||||||
* Check account Balances using FreePBX IVR
|
* Check account Balances using FreePBX IVR
|
||||||
|
|
||||||
* Multi-Tenant - One Instance Multiple Companies and Users
|
* Multi-Tenant - One Instance Multiple Companies and Users
|
||||||
* Audit Logging - Logs actions of users on the system
|
* Audit Logging - Logs detailed actions of users and events
|
||||||
* Permission / Roles
|
* Permissions / Roles
|
||||||
* 2FA Login Support (TOTP)
|
* 2FA Login Support (TOTP)
|
||||||
|
|
||||||
|
|
||||||
### Installation Instructions
|
### Installation Instructions
|
||||||
|
|
||||||
* Change directory to your webroot
|
* Change directory to your webroot
|
||||||
* git clone https://github.com/johnnyq/itflow.git .
|
* git clone https://github.com/johnnyq/itflow.git .
|
||||||
* Create a MySQL/MariaDB database
|
* Create a MariaDB database (Note MySQL is broken)
|
||||||
* Point your browser to your Web Server
|
* Point your browser to your Web Server
|
||||||
* Go through the Setup Process
|
* Go through the Setup Process
|
||||||
* Login
|
* Login
|
||||||
|
|
@ -75,12 +77,12 @@
|
||||||
#### Requirements
|
#### Requirements
|
||||||
* Webserver (Apache, NGINX)
|
* Webserver (Apache, NGINX)
|
||||||
* PHP7+
|
* PHP7+
|
||||||
* MariaDB / MySQL
|
* MariaDB (MySQL is broke)
|
||||||
|
|
||||||
### Technologies Used
|
### Technologies Used
|
||||||
* Backend / PHP libs
|
* Backend / PHP libs
|
||||||
* PHP
|
* PHP
|
||||||
* MariaDB / MySQL
|
* MariaDB
|
||||||
* PHPmailer
|
* PHPmailer
|
||||||
|
|
||||||
* CSS
|
* CSS
|
||||||
|
|
@ -98,17 +100,16 @@
|
||||||
* FullCalendar.io
|
* FullCalendar.io
|
||||||
|
|
||||||
### API Calls
|
### API Calls
|
||||||
* Caller ID lookup (Great for integrating with your phone system like FreePBX, and having your VOIP phone return the client thats calling) - /api.php?api_key=[API_KEY]&cid=[PHONE_NUMBER] - Returns a name
|
* 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 (Great for using with VOIP Phones so phpnes have an up to date directory) - /api.php?api_key=[API_KEY]&phonebook
|
* 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
|
* 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 blanace is) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance
|
* 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 blanace is) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance
|
||||||
NOTE: [API_KEY] - is auto generated when a company is created and shows up in General Settings, this can also be changed manually.
|
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
|
### Future Todo
|
||||||
* MeshCentral / TacticalRMM Integation to assign devices to assets and easily access remote desktop within the app, as well as pull vital information such as asset make, model, serial, hostname, Operating System,
|
* MeshCentral / TacticalRMM (Export Assets Info to ITFlow, Exports common software applications to Software)
|
||||||
* CalDAV to integrate with 3rd party calendars
|
* CalDAV to integrate with 3rd party calendars
|
||||||
* CardDAV to integrate with 3rd party Address books
|
* CardDAV to integrate with 3rd party Address books
|
||||||
* Stripe Integration for online payments
|
* 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.
|
* 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.
|
||||||
* Built-in mailing list used for alerts and marketing
|
* FIDO2 WebAuthn Support for passwordless auth (TPM Fingerprint), (USB Hardware keys such as Yubikey)
|
||||||
* WebAuthn Support for passwordless auth (TPM Fingerprint), (USB Hardware keys such as Yubikey)
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue