From 221a020ec7252549a3cfb0376ddcfaf9f1462cf7 Mon Sep 17 00:00:00 2001 From: Andrew Malsbury Date: Sun, 8 Oct 2023 02:06:54 +0000 Subject: [PATCH 1/5] Update Readme to suggest install script. --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index d08dfe33..08c15859 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,44 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// 3. Create a MariaDB Database 4. Point your browser to your HTTPS web server to begin setup + +## Installation via Script (Recommended Method) + + **Security message** + This project is currently in Beta with many ongoing changes. + + Whilst we're confident the majority of code is safe, nothing in life is 100% safe or risk-free. Writing functional, secure code is very difficult. The current fast pace of development/change may unintentionally introduce bugs/security issues. Use your best judgment before storing highly confidential information in the app. You may wish to consider running ITFlow on it's own server, using a web-app firewall, restricting access (except /portal) to trusted IP addresses, etc. + Need to report a security issue? Check the [security policy](https://github.com/itflow-org/itflow/security/policy) + + ITFlow comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law + + ITFlow is self-hosted. There is a full installation guide in the [docs](https://docs.itflow.org/installation), but the TLDR is: + + + **Requirements** + - Clean Install of Debian 12 or Ubuntu 22.04 + - A public IP Address + - Ports 80 (HTTP) and 443 (HTTPS) TCP accessible from the outside in + - A Fully Qualified Domain Name pointing to the public IP Address – example itflow.example.com, NOT itflow.xyz.example.com + + **Process** + - Login as root + - Download Script + ``` + wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh + ``` + - Read over script to understand purpose and function + ``` + nano itflow.sh + ``` + - Close nano with `ctrl + 'X'` + - Run Scipt + ``` + bash itflow_install.sh + ``` + - Follow Instructions + - Leave us feedback in the [forum](https://forum.itflow.org/d/11-road-map) + ## Key Features * Client documentation - assets, contacts, domains, docs, files, passwords, and more From 605eda879df1112ef9f0ea2bee0ee2ae2ac22fc2 Mon Sep 17 00:00:00 2001 From: Andrew Malsbury Date: Sun, 8 Oct 2023 02:09:26 +0000 Subject: [PATCH 2/5] Updated wording --- README.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 08c15859..127a6414 100644 --- a/README.md +++ b/README.md @@ -83,20 +83,10 @@ * FullCalendar.io -## Getting Started / Installation +## Getting Started -ITFlow is self-hosted. There is a full installation guide in the [docs](https://docs.itflow.org/installation), but the main steps are: +ITFlow is self-hosted. There is a full installation guide in the [docs](https://docs.itflow.org/installation). -1. Install a LAMP stack (Linux, Apache, MariaDB, PHP) - ```sh - 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 - git clone https://github.com/itflow-org/itflow.git /var/www/html - ``` -3. Create a MariaDB Database -4. Point your browser to your HTTPS web server to begin setup ## Installation via Script (Recommended Method) @@ -108,9 +98,6 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// Need to report a security issue? Check the [security policy](https://github.com/itflow-org/itflow/security/policy) ITFlow comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law - - ITFlow is self-hosted. There is a full installation guide in the [docs](https://docs.itflow.org/installation), but the TLDR is: - **Requirements** - Clean Install of Debian 12 or Ubuntu 22.04 From 92eabf1e70c2dee19485d8922590217fbfa3c468 Mon Sep 17 00:00:00 2001 From: wrongecho <32306651+wrongecho@users.noreply.github.com> Date: Sun, 8 Oct 2023 09:02:18 +0100 Subject: [PATCH 3/5] Update README.md / Update readme with install script #737 --- README.md | 30 +++++++----------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 127a6414..fc49952e 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ Report Bug · Request Feature + · + Security

@@ -89,16 +91,8 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// -## Installation via Script (Recommended Method) - - **Security message** - This project is currently in Beta with many ongoing changes. - - Whilst we're confident the majority of code is safe, nothing in life is 100% safe or risk-free. Writing functional, secure code is very difficult. The current fast pace of development/change may unintentionally introduce bugs/security issues. Use your best judgment before storing highly confidential information in the app. You may wish to consider running ITFlow on it's own server, using a web-app firewall, restricting access (except /portal) to trusted IP addresses, etc. - Need to report a security issue? Check the [security policy](https://github.com/itflow-org/itflow/security/policy) - - ITFlow comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law - +### Installation via Script (Recommended Method) + **Requirements** - Clean Install of Debian 12 or Ubuntu 22.04 - A public IP Address @@ -107,20 +101,10 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// **Process** - Login as root - - Download Script + - Download & run install script ``` - wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh - ``` - - Read over script to understand purpose and function - ``` - nano itflow.sh - ``` - - Close nano with `ctrl + 'X'` - - Run Scipt - ``` - bash itflow_install.sh - ``` - - Follow Instructions + wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh && bash itflow_install.sh + - Follow Instructions & navigate to setup URL shown - Leave us feedback in the [forum](https://forum.itflow.org/d/11-road-map) From b9cadd508d1dc0c11227bae0fc01650d310d50d5 Mon Sep 17 00:00:00 2001 From: wrongecho <32306651+wrongecho@users.noreply.github.com> Date: Sun, 8 Oct 2023 09:03:25 +0100 Subject: [PATCH 4/5] Update README.md / Update readme with install script #737 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index fc49952e..0bc47c49 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,7 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// - Download & run install script ``` wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh && bash itflow_install.sh + ``` - Follow Instructions & navigate to setup URL shown - Leave us feedback in the [forum](https://forum.itflow.org/d/11-road-map) From f241d247be82f032a46b23bac0f8f4b59f9ec88c Mon Sep 17 00:00:00 2001 From: Andrew Malsbury Date: Sun, 8 Oct 2023 13:07:56 -0500 Subject: [PATCH 5/5] Update oneliner to not save the install file. Updated oneliner to pipe the script directly to bash. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bc47c49..a9cc5dab 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ ITFlow is self-hosted. There is a full installation guide in the [docs](https:// - Login as root - Download & run install script ``` - wget https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh && bash itflow_install.sh + wget -O - https://github.com/itflow-org/itflow-install-script/raw/main/itflow_install.sh | bash ``` - Follow Instructions & navigate to setup URL shown - Leave us feedback in the [forum](https://forum.itflow.org/d/11-road-map)