diff --git a/.github/dash.png b/.github/dash.png index 3cc5a503..8fb611fa 100644 Binary files a/.github/dash.png and b/.github/dash.png differ diff --git a/.github/readme.gif b/.github/readme.gif new file mode 100644 index 00000000..5d3e85fb Binary files /dev/null and b/.github/readme.gif differ diff --git a/.github/workflows/first-interaction.yml b/.github/workflows/first-interaction.yml new file mode 100644 index 00000000..141baa2f --- /dev/null +++ b/.github/workflows/first-interaction.yml @@ -0,0 +1,27 @@ +name: Welcome New Contributor + +on: + issues: + types: [opened] + pull_request_target: + types: [opened] + +jobs: + run: + runs-on: ubuntu-latest + steps: + - uses: actions/first-interaction@v1.1.1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: | + Hello & Welcome! :) + + Thanks for taking the time to get in touch. We'll review this issue shortly. + + Whilst you're waiting, please feel free to check out the [forum](https://forum.itflow.org). + pr-message: | + Hello & Welcome! :) + + Thanks for taking the time to help improve ITFlow. We're excited to review your contributions - we'll review this PR as soon as we can! + + Whilst you're waiting, please feel free to check out the [forum](https://forum.itflow.org). diff --git a/README.md b/README.md index 2b6f273d..560dce2e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Username: demo@demo | Password: demo

- About + About · Docs · @@ -39,7 +39,7 @@ ## About -A free ITGlue alternative, with additional ticketing / accounting features. +A comprehensive, free & open-source documentation, ticket management, and accounting platform. [![ITFlow][product-screenshot]](https://itflow.org) @@ -54,8 +54,8 @@ - ITFlow consolidates common MSP needs (documentation, ticketing, and accounting) into one system ### 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. -* Currently, we strongly recommend against storing confidential information in ITFlow; ITFlow has not undergone a third-party security assessment. +* This project is in beta with many ongoing changes. Updates may unintentionally introduce bugs/security issues. +* 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 April/May 2023. @@ -66,6 +66,7 @@ * MariaDB * PHPMailer * HTML Purifier + * PHP Mime Mail Parser * CSS * Bootstrap @@ -84,11 +85,11 @@ ## 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: +ITFlow is self-hosted. There is a full installation guide in the [docs](https://wiki.itflow.org/doku.php?id=wiki:installation), but the main steps are: 1. Install a LAMP stack (Linux, Apache, MariaDB, PHP) ```sh - sudo apt install git apache2 php libapache2-mod-php php-intl php-imap php-mysqli php-curl mariadb-server + 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 ```sh @@ -103,14 +104,13 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// * 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 - -* MeshCentral (Export common software applications to Software) +* Comprehensive API to allow custom third party integration * CalDAV to integrate with 3rd party calendars * CardDAV to integrate with 3rd party Address books -* Stripe Integration for online payments * 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) @@ -125,7 +125,7 @@ For help using ITFlow, feature requests, and general ideas / discussions please For bugs, please raise an [issue](https://github.com/itflow-org/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. Please make sure you're following our [code standards](https://itflow.org/docs.php?doc=coding-standards). +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://wiki.itflow.org/doku.php?id=wiki:code_standards). For large changes / new features, please discuss the issue with other contributors first. #### Contributors @@ -136,7 +136,7 @@ For large changes / new features, please discuss the issue with other contributo ## License -ITFlow is distributed "as is" under the GPL License, WITHOUT WARRANTY OF ANY KIND. See `LICENSE` for details. +ITFlow is distributed "as is" under the GPL License, WITHOUT WARRANTY OF ANY KIND. See [`LICENSE`](https://github.com/itflow-org/itflow/blob/master/LICENSE) for details. @@ -153,6 +153,6 @@ ITFlow is distributed "as is" under the GPL License, WITHOUT WARRANTY OF ANY KIN [license-url]: https://github.com/itflow-org/itflow/blob/master/LICENSE [commit-shield]: https://img.shields.io/github/last-commit/itflow-org/itflow?style=for-the-badge [commit-url]: https://github.com/itflow-org/itflow/commits/master -[product-screenshot]: .github/dash.png +[product-screenshot]: .github/readme.gif diff --git a/SECURITY.md b/SECURITY.md index a5e58297..e18a4433 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,26 +2,22 @@ ## In Beta -ITFlow is currently in early beta and is a work in progress. -We currently advise against storing confidential data in ITFlow for this reason. +ITFlow is currently in beta and is a work in progress. + +**We take security seriously.** Whilst we are confident the code is safe, nothing in life is 100% safe or risk-free. You should use your best judgment before entering confidential information into the app. -That said, in order to eventually be useful, ITFlow **must** be secure and take security seriously. We attempt to follow security best practices where possible, including [automated code scanning](https://sonarcloud.io/component_measures?id=itflow-org_itflow&metric=security_rating&view=list). ## Supported Versions -ITFlow is in Beta. - | Version | Supported | | ------- | ------------------ | | Beta | :white_check_mark: | ## Reporting a Vulnerability -**Please do not report security vulnerabilities through public GitHub issues.** +**Please do not report security vulnerabilities through public GitHub issues.** -If you have discovered a security issue, please report it to us in as much detail as possible, so we can fix it. -You should expect to receive an initial acknowledgement within 72 hours. If you do not, please get in touch discretely via GitHub issues/Forum/Discord to ensure we received your e-mail. +If you have discovered a security issue, please [report it](https://github.com/itflow-org/itflow/security/advisories/new) to us in as much detail as possible, so we can fix it. You should expect to receive an initial acknowledgement within 72 hours. -Security contact: -![image](https://user-images.githubusercontent.com/32306651/160704188-763e6763-429e-41b9-9007-6a09bcfdba2b.png) +**Security contact: [GitHub Security Advisories](https://github.com/itflow-org/itflow/security/advisories/new)** diff --git a/account_add_modal.php b/account_add_modal.php index 9e728716..7663d926 100644 --- a/account_add_modal.php +++ b/account_add_modal.php @@ -1,61 +1,61 @@