diff --git a/README.md b/README.md index 0c2bb67f..47c48c18 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ ## About -[![ITFlow][product-screenshot]]() +[![ITFlow][product-screenshot]](https://itflow.org) ITFlow is a free & open-source solution for IT service management, documentation, and accounting. @@ -78,110 +78,28 @@ * FullCalendar.io -## 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 -* 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.) - * Services (Relate all of the above together, e.g. Active Directory, a web app, etc.) - * Tickets - * 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 / 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. ## Support & Contributions ### Forum -For assistance using ITFlow, feature requests, and general ideas/discussions please use the community forum. +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