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] 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)