inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 21:26:43 +00:00
Code

Update docs for Installer v2 (#387)

Browse Source 
* Update docs for Installer v2
Fixes #385

* Add more detailed docs regarding performed steps and options
This commit is contained in:
Matthias Mair 2022-11-08 00:14:17 +01:00 committed by GitHub
parent d506d9572e
commit 58353c4ac6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/start/installer.md
View File

@ -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

2
docs/start/intro.md
View File

@ -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).