From 58353c4ac60242ff21946e382e7b38c1a2f477d4 Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 8 Nov 2022 00:14:17 +0100 Subject: [PATCH] Update docs for Installer v2 (#387) * Update docs for Installer v2 Fixes #385 * Add more detailed docs regarding performed steps and options --- docs/start/installer.md | 24 ++++++++++++++++++++++-- docs/start/intro.md | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/docs/start/installer.md b/docs/start/installer.md index f5e0539..534bbba 100644 --- a/docs/start/installer.md +++ b/docs/start/installer.md @@ -10,10 +10,30 @@ Supported OSs are Debian 11 and Ubuntu 20.04 LTS. ### Quick Script ```bash -curl https://raw.githubusercontent.com/InvenTree/InvenTree/master/contrib/install.sh | sudo sh +wget -Nq https://raw.githubusercontent.com/InvenTree/InvenTree/master/contrib/install.sh && bash install.sh ``` -This script does all manual steps without any input. The installation might take 5-10 minutes to finish. +This script does all manual steps without any input. The installation might take up to 5-10 minutes to finish. + +#### Performed steps +The install script: +- checks if the current OS is supported +- installs packages needed for getting the packages keys +- executes the manual steps listed below + +#### Script Options +The install script supports pulling packages from different branches and publishers. +Defaults are to use branch `stable` and publisher `inventree`. + +To install from branch master and publisher matmair the install command would be. +```bash +install master matmair +``` + +Furthermore there are several command flags for advanced usage: +`--help` to show all options +`--version` to print the version of the install script +`--dry-run` to print but not execute the commands that would change system files ### Manual Install diff --git a/docs/start/intro.md b/docs/start/intro.md index fdff361..b8c51b3 100644 --- a/docs/start/intro.md +++ b/docs/start/intro.md @@ -5,7 +5,7 @@ title: Setup Introduction !!! info "Fast install" A quick-and-easy install can be done done with the following one-liner. ```bash - curl https://raw.githubusercontent.com/InvenTree/InvenTree/master/contrib/install.sh | sh + wget -Nq https://raw.githubusercontent.com/InvenTree/InvenTree/master/contrib/install.sh && bash install.sh ``` Read more about the [installer](./installer.md).