Add Document LIst and improve `build` folder (#261)

* Rename generateList to generateAppList
* Add DocumenList with Generator
* Rename Template files
* Use template file for AppList.md
* Ignore case when sorting AppList
* Organize build folder
* Add dependencies check to pre-commit script
* Add wget install collumn to tools/README.md and sort by title
* Remove Document table from README and add a link to DocumentList.md
* Remove tools table from README and add a link to the list
* Hightlight AppList on Readme

.gitignore

@@ -1,5 +1,5 @@
 
 .DS_Store
 
-# Ignore latest.run file from build hoook
-build/lastrun.sha256
+# Ignore tmp file in build directory
+build/tmp/

build/env.sh

@@ -6,20 +6,23 @@ pt64="${homedir}template/portainer-v2-arm64.json"
 
 # README Files with templates
 README="${homedir}docs/README.md"
-README_TEMPLATE="${homedir}build/README_Template.md"
+README_TEMPLATE="${homedir}build/templates/template_README.md"
 TOOLSREADME="${homedir}tools/README.md"
-TOOLSREADME_TEMPLATE="${homedir}build/tools_README_Template.md"
+TOOLSREADME_TEMPLATE="${homedir}build/templates/template_tools_README.md"
 
-# AppList Document
+# Lists Documents
 AppList="${homedir}docs/AppList.md"
+AppList_TEMPLATE="${homedir}build/templates/template_AppList.md"
+DocList="${homedir}docs/DocumentList.md"
+DocList_TEMPLATE="${homedir}build/templates/template_DocumentList.md"
 
 # appinfo file
 appinfo="${homedir}build/appinfo.json"
 
 # Internal folders
-Scripts="${homedir}tools/"
-Extras="${homedir}tools/"
-Docs="${homedir}docs/"
+Scripts="../tools/"
+Extras="../tools/"
+Docs="../docs/"
 
 # Verification file
-verificationFile="${homedir}build/lastrun.sha256"
+verificationFile="${homedir}build/tmp/lastrun.sha256"

build/generateREADME.sh

@@ -1,129 +0,0 @@
-#!/bin/bash
-
-# start script from it's folder
-cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || exit
-
-# Standard file locations
-homedir='../'
-. env.sh
-
-# Temp Files
-tmpreadme1=$(mktemp)
-tmpreadme2=$(mktemp)
-
-# Delete TempFiles on exit
-CleanExit () {
-	rm -f "$tmpreadme1"
-	rm -f "$tmpreadme2"
-}
-trap CleanExit 0 1
-
-insertTable () {
-	searchstr="$1"
-	basefile="$2"
-
-	tableline=$( grep -n "$searchstr" "$basefile" | cut -d: -f1)
-	head -n $(( tableline - 1 )) "$basefile" > "$tmpreadme1"
-	echo -e "$table" >> "$tmpreadme1"
-	tail -n +$(( tableline + 1 )) "$basefile" >> "$tmpreadme1"
-	mv "$tmpreadme1" "$tmpreadme2"
-}
-
-## Generate YouTube Video Table
-unset table
-nVideos=$( jq '.youtube | length' "$appinfo")
-for vid in $(seq 0 $(( nVideos - 1 ))); do
-	info=$( jq ".youtube[$vid]" "$appinfo" )
-
-	# Get Video ID
-	ID=$( echo "$info" | jq '.ID' | tr -d '"' )
-
-	# Get Video URL
-	URL=$( echo "$info" | jq '.URL' | tr -d '"' )
-
-	# Get Video Title
-	TITLE=$( echo "$info" | jq '.Title' | tr -d '"' )
-
-	# Get Video Documentation
-	DocID=$( echo "$info" | jq '.DocID' )
-	if [ "$DocID" != "null" ] ; then
-		DocFile=$( jq ".docs[] | select(.ID==$DocID) | .File" "$appinfo" | tr -d '"' )
-		DocMD="[Install Doc]($Docs$DocFile)"
-	else
-		unset DocMD
-	fi
-
-	line="|$ID|[$TITLE]($URL)|$DocMD|"
-	if [ "$vid" == "0" ] ; then
-		table=$line
-	else
-		table=$( echo -e "$table\n$line")
-	fi
-done
-insertTable '<<<<< YOUTUBE TABLE HERE >>>>>' "$README_TEMPLATE"
-
-## Generate Doc Table
-unset table
-nDocs=$( jq '.docs | length' "$appinfo")
-for doc in $(seq 0 $(( nDocs - 1 ))); do
-	info=$( jq ".docs[$doc]" "$appinfo" )
-
-	# Get Doc Path
-	FILE=$( echo "$info" | jq '.File' | tr -d '"' )
-
-	# Get Doc Description
-	DESC=$( echo "$info" | jq '.Description' | tr -d '"' )
-
-	line="|[$DESC]($Docs$FILE)|"
-	if [ "$doc" == "0" ] ; then
-		table=$line
-	else
-		table=$( echo -e "$table\n$line")
-	fi
-done
-insertTable '<<<<< DOCS TABLE HERE >>>>>' "$tmpreadme2"
-
-## Generate Tools Table
-unset table
-nTools=$( jq '.tools | length' "$appinfo")
-for tool in $(seq 0 $(( nTools - 1 ))); do
-	info=$( jq ".tools[$tool]" "$appinfo" )
-
-	# Get Tool Path
-	FILE=$( echo "$info" | jq '.File' | tr -d '"' )
-	FILE="[$FILE]($Scripts$FILE)"
-
-	# Get Tool Description
-	DESC=$( echo "$info" | jq '.Description' | tr -d '"' )
-
-	# Get Tool runner
-	EXEC=$( echo "$info" | jq '.Exec' | tr -d '"' )
-	[ "$EXEC" == "null" ] && EXEC="bash"
-
-	# Get Tool wget link
-	WGET=$( echo "$info" | jq '.wget' | tr -d '"' )
-	if [ "$WGET" != "null" ]; then
-		WGET="wget -qO- $WGET \| $EXEC"
-	else
-		unset WGET
-	fi
-
-	# Get Tool Installation Doc
-	DocID=$( echo "$info" | jq '.DocID')
-	if [ "$DocID" != "null" ]; then
-		DocFile=$(jq ".docs[] | select(.ID==$DocID) | .File" "$appinfo" | tr -d '"')
-		DocLink="<br>[Installation Document]($Docs$DocFile)"
-	else
-		unset DocLink
-	fi
-
-	line="|$FILE|$DESC$DocLink|$WGET|"
-	if [ "$tool" == "0" ] ; then
-		table=$line
-	else
-		table=$( echo -e "$table\n$line")
-	fi
-done
-insertTable '<<<<< TOOLS TABLE HERE >>>>>' "$tmpreadme2"
-
-cp -f "$tmpreadme2" "$README"

build/generateList.sh → build/generators/generateAppList.sh

@@ -4,10 +4,10 @@
 cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || exit
 
 # Standard file locations
-homedir='../'
-. env.sh
-docIcon="![](${homedir}build/images/doc_icon.png)"
-scriptIcon="![](${homedir}build/images/script_icon.png)"
+homedir='../../'
+. ../env.sh
+docIcon="![](../build/images/doc_icon.png)"
+scriptIcon="![](../build/images/script_icon.png)"
 
 # Temp helper files
 TempList=$(mktemp)
@@ -31,20 +31,15 @@ trap CleanExit 0 1
 # Apps Title for both Templates
 jq '.templates[].title' "$pt32" | tr -d '"' > "$App32"
 jq '.templates[].title' "$pt64" | tr -d '"' > "$App64"
-cat "$App32" "$App64" | sort -u > "$AppTitle"
+cat "$App32" "$App64" | sort -uf > "$AppTitle"
 
 # Apps Type for both Templates
 jq '.templates[].type' "$pt32" | paste -d'|' "$App32" - > "$TempList"
 jq '.templates[].type' "$pt64" | paste -d'|' "$App64" - >> "$TempList"
-sort -u "$TempList" > "$AppType"
+sort -uf "$TempList" > "$AppType"
 
 # Create AppList title
-{
-	echo "# Template List"
-	echo
-	echo "|App Title|System|Type | Doc |Install Script|Extra Scripts|Youtube Video|"
-	echo "|:--------|:----:|:---:|:---:|:------------:|:------------|:-----------:|"
-} > "$AppList"
+cp -f "$AppList_TEMPLATE" "$AppList"
 
 # Generate App Table
 while IFS="" read -u 9 -r App || [ -n "$App" ]

build/generators/generateDocList.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+# start script from it's folder
+cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || exit
+
+# Standard file locations
+homedir='../../'
+. ../env.sh
+
+## Generate Doc Table
+unset table
+nDocs=$( jq '.docs | length' "$appinfo")
+for doc in $(seq 0 $(( nDocs - 1 ))); do
+	info=$( jq ".docs | sort_by(.File) | .[$doc]" "$appinfo" )
+
+	# Get Doc ID
+	ID=$( echo "$info" | jq '.ID' | tr -d '"' )
+
+	# Get Doc Path
+	FILE=$( echo "$info" | jq '.File' | tr -d '"' )
+
+	# Get Doc Description
+	DESC=$( echo "$info" | jq '.Description' | tr -d '"' )
+
+	# YouTube Video
+	YT=$( jq ".youtube[] | select(.DocID==$ID) | .URL" "$appinfo" )
+	[ "$YT" != "" ] && YT="[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)]($YT)"
+
+	# Apps
+	APPS=$( jq ".apps[] | select(.DocID==$ID) | .Title" "$appinfo" | tr -d '"' )
+	if [ "$APPS" != "" ] && [ "$( echo "$APPS" | wc -l)" -gt "1" ] ; then
+		unset temp_app
+		while IFS="" read -r app || [ -n "$app" ]
+		do
+			if [ -z "$temp_app" ] ; then
+				temp_app="$app"
+			else
+				temp_app="$temp_app<br>$app"
+			fi
+		done < <( echo "$APPS" )
+		APPS="$temp_app"
+	fi
+
+	line="|[$FILE]($Docs$FILE)|$DESC|$APPS|$YT|"
+	if [ "$doc" == "0" ] ; then
+		table=$line
+	else
+		table=$( echo -e "$table\n$line")
+	fi
+done
+cp -f "$DocList_TEMPLATE" "$DocList"
+echo -e "$table" >> "$DocList"

build/generators/generateREADME.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+
+# start script from it's folder
+cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || exit
+
+# Standard file locations
+homedir='../../'
+. ../env.sh
+
+# Temp Files
+tmpreadme1=$(mktemp)
+tmpreadme2=$(mktemp)
+
+# Delete TempFiles on exit
+CleanExit () {
+	rm -f "$tmpreadme1"
+	rm -f "$tmpreadme2"
+}
+trap CleanExit 0 1
+
+insertTable () {
+	searchstr="$1"
+	basefile="$2"
+
+	tableline=$( grep -n "$searchstr" "$basefile" | cut -d: -f1)
+	head -n $(( tableline - 1 )) "$basefile" > "$tmpreadme1"
+	echo -e "$table" >> "$tmpreadme1"
+	tail -n +$(( tableline + 1 )) "$basefile" >> "$tmpreadme1"
+	mv "$tmpreadme1" "$tmpreadme2"
+}
+
+## Generate YouTube Video Table
+unset table
+nVideos=$( jq '.youtube | length' "$appinfo")
+for vid in $(seq 0 $(( nVideos - 1 ))); do
+	info=$( jq ".youtube[$vid]" "$appinfo" )
+
+	# Get Video ID
+	ID=$( echo "$info" | jq '.ID' | tr -d '"' )
+
+	# Get Video URL
+	URL=$( echo "$info" | jq '.URL' | tr -d '"' )
+
+	# Get Video Title
+	TITLE=$( echo "$info" | jq '.Title' | tr -d '"' )
+
+	# Get Video Documentation
+	DocID=$( echo "$info" | jq '.DocID' )
+	if [ "$DocID" != "null" ] ; then
+		DocFile=$( jq ".docs[] | select(.ID==$DocID) | .File" "$appinfo" | tr -d '"' )
+		DocMD="[Install Doc]($Docs$DocFile)"
+	else
+		unset DocMD
+	fi
+
+	line="|$ID|[$TITLE]($URL)|$DocMD|"
+	if [ "$vid" == "0" ] ; then
+		table=$line
+	else
+		table=$( echo -e "$table\n$line")
+	fi
+done
+insertTable '<<<<< YOUTUBE TABLE HERE >>>>>' "$README_TEMPLATE"
+
+cp -f "$tmpreadme2" "$README"

build/generateToolsREADME.sh → build/generators/generateToolsREADME.sh

@@ -4,14 +4,14 @@
 cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || exit
 
 # Standard file locations
-homedir='../'
-. env.sh
+homedir='../../'
+. ../env.sh
 
 ## Generate Tools Table
 unset table
 nTools=$( jq '.tools | length' "$appinfo")
 for tool in $(seq 0 $(( nTools - 1 ))); do
-	info=$( jq ".tools[$tool]" "$appinfo" )
+	info=$( jq ".tools | sort_by(.File) | .[$tool]" "$appinfo" )
 
 	# Get Tool Path
 	FILE=$( echo "$info" | jq '.File' | tr -d '"' )
@@ -24,6 +24,18 @@ for tool in $(seq 0 $(( nTools - 1 ))); do
 	TYPE=$( echo "$info" | jq '.Type' | tr -d '"' )
 	[ "$TYPE" == "null" ] && TYPE="Install"
 
+	# Get Tool runner
+	EXEC=$( echo "$info" | jq '.Exec' | tr -d '"' )
+	[ "$EXEC" == "null" ] && EXEC="bash"
+
+	# Get Tool wget link
+	WGET=$( echo "$info" | jq '.wget' | tr -d '"' )
+	if [ "$WGET" != "null" ]; then
+		WGET="wget -qO- $WGET \| $EXEC"
+	else
+		unset WGET
+	fi
+
 	# Get Tool Installation Doc
 	DocID=$( echo "$info" | jq '.DocID')
 	if [ "$DocID" != "null" ]; then
@@ -33,7 +45,7 @@ for tool in $(seq 0 $(( nTools - 1 ))); do
 		unset DocLink
 	fi
 
-	line="|$FILE|$DocLink|$TYPE|$DESC|"
+	line="|$FILE|$DocLink|$TYPE|$DESC|$WGET|"
 	if [ "$tool" == "0" ] ; then
 		table=$line
 	else

build/pre-commit

@@ -1,5 +1,15 @@
 #!/bin/bash
 
+function error {
+  echo -e "\\e[91m$1\\e[39m"
+  exit 1
+}
+
+# Check dependencies
+jq --version &> /dev/null || error "jq is required, please install it with 'sudo apt install jq'"
+git --version &> /dev/null || error "git is required, please install it with 'sudo apt install git'"
+sha256sum --version &> /dev/null || error "sha256sum is required, please install it with 'sudo apt install coreutils'"
+
 # Check if script from build or script from hook and cd into build folder
 scriptDir="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null || pwd )"
 if [ "$( echo "$scriptDir" | rev | cut -d/ -f1 | rev )" == "build" ]; then
@@ -14,11 +24,15 @@ homedir='../'
 
 # Check if Template or appinfo has changed
 if ! sha256sum -c --quiet "$verificationFile" &> /dev/null ; then
+	# Make sure tmp folder exists
+	mkdir -p "$( dirname -- "$verificationFile" )"
+
 	echo "Updating documentation..."
 	# Run all scripts
-	./generateList.sh
-	./generateREADME.sh
-	./generateToolsREADME.sh
+	./generators/generateAppList.sh
+	./generators/generateDocList.sh
+	./generators/generateREADME.sh
+	./generators/generateToolsREADME.sh
 	echo "Update finished"
 
 	# Update lastrun.sha256
@@ -28,4 +42,5 @@ if ! sha256sum -c --quiet "$verificationFile" &> /dev/null ; then
 	git add -- "$README"
 	git add -- "$TOOLSREADME"
 	git add -- "$AppList"
+	git add -- "$DocList"
 fi

build/templates/template_AppList.md

@@ -0,0 +1,8 @@
+# List of Apps
+
+List of all apps included in this project with info related to it.
+
+---
+
+|App Title|System|Type | Doc |Install Script|Extra Scripts|Youtube Video|
+|:--------|:----:|:---:|:---:|:------------:|:------------|:-----------:|

build/templates/template_DocumentList.md

@@ -0,0 +1,9 @@
+# List of Documentation files
+
+
+List of all Documents used within this project with related Apps and Videos.
+
+---
+
+| File Name | Description | Related Apps | YouTube |
+| --------- | ----------- | ------------ |:-------:|

build/README_Template.md → build/templates/template_README.md

@@ -4,11 +4,13 @@
 
 This repository is a collection of tutorials for hosting a variety of server applications using Docker and [Portainer](https://github.com/portainer/portainer).
 
-See the list of Apps included in this template [here](AppList.md).
-
 ### App Template for Portainer
 ![alt text](https://github.com/novaspirit/pi-hosted/blob/master/apptemplate.png?raw=true)
 
+### Apps List
+
+See the list of Apps included in this template [here](AppList.md).
+
 ### Installation
 Run `install-docker.sh`, to install docker, and add the current user to the docker usergroup.
 ```
@@ -61,18 +63,13 @@ You're done! Now just click App Templates and deploy applications!
 |---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
 <<<<< YOUTUBE TABLE HERE >>>>>
 
-=======
-
-| Additional Documentation |
-|------------------------|
-<<<<< DOCS TABLE HERE >>>>>
+### Aditional Documentation
 
-=======
+You can find more tutorials and useful information in our [GitHub Docs](DocumentList.md) folder.
 
-| Additional Tools | Description | wget install |
-|----------------|--------------|--------------|
-<<<<< TOOLS TABLE HERE >>>>>
+### Included Scripts
 
+Install, Update, Pre-Install and extra scripts can be found in our [GitHub Tools](../tools) folder.
 
 ### Contributors
 

build/tools_README_Template.md → build/templates/template_tools_README.md

@@ -5,5 +5,5 @@ Most of the follwing scripts are only needed if you are trying to load one of th
 
 ---
 
-| Script Name  | Additional Doc | Type | Description |
-| ------------ | -------------- | ---- | ----------- |
+| Script Name  | Additional Doc | Type | Description | wget install |
+| ------------ | -------------- | ---- | ----------- | ------------ |

docs/AppList.md

@@ -1,4 +1,8 @@
-# Template List
+# List of Apps
+
+List of all apps included in this project with info related to it.
+
+---
 
 |App Title|System|Type | Doc |Install Script|Extra Scripts|Youtube Video|
 |:--------|:----:|:---:|:---:|:------------:|:------------|:-----------:|

docs/DocumentList.md

@@ -0,0 +1,17 @@
+# List of Documentation files
+
+
+List of all Documents used within this project with related Apps and Videos.
+
+---
+
+| File Name | Description | Related Apps | YouTube |
+| --------- | ----------- | ------------ |:-------:|
+|[UnPoller-Monitor.md](../docs/UnPoller-Monitor.md)|Install and setup instructions for the RPI Unifi (UnPoller) Monitor|UnPoller Monitor||
+|[macvlan_setup.md](../docs/macvlan_setup.md)|Attach a container directly to local network (macvlan)|||
+|[nginx_proxy_manager.md](../docs/nginx_proxy_manager.md)|Install and setup instructions for Nginx Proxy Manager (NPM)|Nginx Proxy Manager|[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)]("https://www.youtube.com/watch?v=yl2Laxbqvo8&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=10")|
+|[pi-hole.md](../docs/pi-hole.md)|Install and Setup Pi-Hole for Network-Wide Ad Block|Pi-Hole<br>Pi-Hole DoH/DoT<br>Pi-Hole-Unbound||
+|[rpi_docker_monitor.md](../docs/rpi_docker_monitor.md)|Install and setup instructions for the RPI Docker Monitor|Raspberry Pi Docker Monitor|[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=plastic&logo=youtube&logoColor=white)]("https://www.youtube.com/watch?v=IoD3vFuep64&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=8")|
+|[throttled.md](../docs/throttled.md)|Install and Setup Instructions for the Throttled Script|||
+|[wireguard-install.md](../docs/wireguard-install.md)|Install and setup instructions for the WireGuard VPN Server|Wireguard Server||
+|[wordpress_installation.md](../docs/wordpress_installation.md)|WORDPRESS + SSL SETUP|Wordpress||

docs/README.md

@@ -4,11 +4,13 @@
 
 This repository is a collection of tutorials for hosting a variety of server applications using Docker and [Portainer](https://github.com/portainer/portainer).
 
-See the list of Apps included in this template [here](AppList.md).
-
 ### App Template for Portainer
 ![alt text](https://github.com/novaspirit/pi-hosted/blob/master/apptemplate.png?raw=true)
 
+### Apps List
+
+See the list of Apps included in this template [here](AppList.md).
+
 ### Installation
 Run `install-docker.sh`, to install docker, and add the current user to the docker usergroup.
 ```
@@ -73,37 +75,13 @@ You're done! Now just click App Templates and deploy applications!
 |11|[How to Install Whoogle to replace using Google and repo notes](https://www.youtube.com/watch?v=j3ZGxo3ibUs&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=12)||
 |12|[Checking out Windows 2000 Docker](https://www.youtube.com/watch?v=57Gnp0424Qc&list=PL846hFPMqg3jwkxcScD1xw2bKXrJVvarc&index=13)||
 
-=======
-
-| Additional Documentation |
-|------------------------|
-|[Install and setup instructions for the RPI Unifi (UnPoller) Monitor](../docs/UnPoller-Monitor.md)|
-|[Install and setup instructions for Nginx Proxy Manager (NPM)](../docs/nginx_proxy_manager.md)|
-|[Install and setup instructions for the RPI Docker Monitor](../docs/rpi_docker_monitor.md)|
-|[Install and setup instructions for the WireGuard VPN Server](../docs/wireguard-install.md)|
-|[WORDPRESS + SSL SETUP](../docs/wordpress_installation.md)|
-|[Install and Setup Instructions for the Throttled Script](../docs/throttled.md)|
-|[Install and Setup Pi-Hole for Network-Wide Ad Block](../docs/pi-hole.md)|
-|[Attach a container directly to local network (macvlan)](../docs/macvlan_setup.md)|
-
-=======
-
-| Additional Tools | Description | wget install |
-|----------------|--------------|--------------|
-|[install_caddy.sh](../tools/install_caddy.sh)|Preinstall Setup for Caddy|wget -qO- https://git.io/JMsEe \| bash|
-|[install_drupal.sh](../tools/install_drupal.sh)|Preinstall Setup for Drupal|wget -qO- https://git.io/JMsEj \| bash|
-|[install_portainer_agent.sh](../tools/install_portainer_agent.sh)|Install Portainer Agent<br>Portainer agent is used for remote management of the host you install it on.||
-|[update_portainer_agent.sh](../tools/update_portainer_agent.sh)|Upgrade Portainer Agent||
-|[install_throttled.sh](../tools/install_throttled.sh)|Preinstall Setup for the Throttled Script<br>[Installation Document](../docs/throttled.md)|wget -qO- https://git.io/JXzw0 \| bash|
-|[install_vikunja.sh](../tools/install_vikunja.sh)|Preinstall Setup for Vikunja|wget -qO- https://git.io/JMsuZ \| bash|
-|[nginx-proxy-manager.sh](../tools/nginx-proxy-manager.sh)|Preinstall Setup for NPM<br>[Installation Document](../docs/nginx_proxy_manager.md)|wget -qO- https://git.io/JPXF5 \| bash|
-|[reset_premissions_nextcloud.sh](../tools/reset_premissions_nextcloud.sh)|Basic Script to reset the premissions of NextcloudPi|wget -qO- https://git.io/JDklN \| bash|
-|[rpi_docker_monitor.sh](../tools/rpi_docker_monitor.sh)|Preinstall Setup for Docker Monitor<br>[Installation Document](../docs/rpi_docker_monitor.md)|wget -qO- https://git.io/JPXba \| bash|
-|[traefik.sh](../tools/traefik.sh)|Preinstall Setup for Traefik|wget -qO- https://git.io/JMsuA \| bash|
-|[unpoller-install.sh](../tools/unpoller-install.sh)|Preinstall Setup for UnPoller<br>[Installation Document](../docs/UnPoller-Monitor.md)|wget -qO- https://git.io/JMszE \| bash|
-|[install_photoprism.sh](../tools/install_photoprism.sh)|Install Photo Prism|wget -qO- https://git.io/JM5Tr \| bash|
-|[update_libseccomp2.sh](../tools/update_libseccomp2.sh)|PI OS 32 libseccomp2 Repair utility|wget -qO- https://git.io/JPXdj \| bash|
+### Aditional Documentation
+
+You can find more tutorials and useful information in our [GitHub Docs](DocumentList.md) folder.
+
+### Included Scripts
 
+Install, Update, Pre-Install and extra scripts can be found in our [GitHub Tools](../tools) folder.
 
 ### Contributors
 

tools/README.md

@@ -5,18 +5,18 @@ Most of the follwing scripts are only needed if you are trying to load one of th
 
 ---
 
-| Script Name  | Additional Doc | Type | Description |
-| ------------ | -------------- | ---- | ----------- |
-|[install_caddy.sh](../tools/install_caddy.sh)||Preinstall|Preinstall Setup for Caddy|
-|[install_drupal.sh](../tools/install_drupal.sh)||Preinstall|Preinstall Setup for Drupal|
-|[install_portainer_agent.sh](../tools/install_portainer_agent.sh)||Preinstall|Install Portainer Agent<br>Portainer agent is used for remote management of the host you install it on.|
-|[update_portainer_agent.sh](../tools/update_portainer_agent.sh)||Update|Upgrade Portainer Agent|
-|[install_throttled.sh](../tools/install_throttled.sh)|[Documentation](../docs/throttled.md)|Install|Preinstall Setup for the Throttled Script|
-|[install_vikunja.sh](../tools/install_vikunja.sh)||Preinstall|Preinstall Setup for Vikunja|
-|[nginx-proxy-manager.sh](../tools/nginx-proxy-manager.sh)|[Documentation](../docs/nginx_proxy_manager.md)|Preinstall|Preinstall Setup for NPM|
-|[reset_premissions_nextcloud.sh](../tools/reset_premissions_nextcloud.sh)||Extra|Basic Script to reset the premissions of NextcloudPi|
-|[rpi_docker_monitor.sh](../tools/rpi_docker_monitor.sh)|[Documentation](../docs/rpi_docker_monitor.md)|Preinstall|Preinstall Setup for Docker Monitor|
-|[traefik.sh](../tools/traefik.sh)||Preinstall|Preinstall Setup for Traefik|
-|[unpoller-install.sh](../tools/unpoller-install.sh)|[Documentation](../docs/UnPoller-Monitor.md)|Preinstall|Preinstall Setup for UnPoller|
-|[install_photoprism.sh](../tools/install_photoprism.sh)||Preinstall|Install Photo Prism|
-|[update_libseccomp2.sh](../tools/update_libseccomp2.sh)||Update|PI OS 32 libseccomp2 Repair utility|
+| Script Name  | Additional Doc | Type | Description | wget install |
+| ------------ | -------------- | ---- | ----------- | ------------ |
+|[install_caddy.sh](../tools/install_caddy.sh)||Preinstall|Preinstall Setup for Caddy|wget -qO- https://git.io/JMsEe \| bash|
+|[install_drupal.sh](../tools/install_drupal.sh)||Preinstall|Preinstall Setup for Drupal|wget -qO- https://git.io/JMsEj \| bash|
+|[install_photoprism.sh](../tools/install_photoprism.sh)||Preinstall|Install Photo Prism|wget -qO- https://git.io/JM5Tr \| bash|
+|[install_portainer_agent.sh](../tools/install_portainer_agent.sh)||Preinstall|Install Portainer Agent<br>Portainer agent is used for remote management of the host you install it on.||
+|[install_throttled.sh](../tools/install_throttled.sh)|[Documentation](../docs/throttled.md)|Install|Preinstall Setup for the Throttled Script|wget -qO- https://git.io/JXzw0 \| bash|
+|[install_vikunja.sh](../tools/install_vikunja.sh)||Preinstall|Preinstall Setup for Vikunja|wget -qO- https://git.io/JMsuZ \| bash|
+|[nginx-proxy-manager.sh](../tools/nginx-proxy-manager.sh)|[Documentation](../docs/nginx_proxy_manager.md)|Preinstall|Preinstall Setup for NPM|wget -qO- https://git.io/JPXF5 \| bash|
+|[reset_premissions_nextcloud.sh](../tools/reset_premissions_nextcloud.sh)||Extra|Basic Script to reset the premissions of NextcloudPi|wget -qO- https://git.io/JDklN \| bash|
+|[rpi_docker_monitor.sh](../tools/rpi_docker_monitor.sh)|[Documentation](../docs/rpi_docker_monitor.md)|Preinstall|Preinstall Setup for Docker Monitor|wget -qO- https://git.io/JPXba \| bash|
+|[traefik.sh](../tools/traefik.sh)||Preinstall|Preinstall Setup for Traefik|wget -qO- https://git.io/JMsuA \| bash|
+|[unpoller-install.sh](../tools/unpoller-install.sh)|[Documentation](../docs/UnPoller-Monitor.md)|Preinstall|Preinstall Setup for UnPoller|wget -qO- https://git.io/JMszE \| bash|
+|[update_libseccomp2.sh](../tools/update_libseccomp2.sh)||Update|PI OS 32 libseccomp2 Repair utility|wget -qO- https://git.io/JPXdj \| bash|
+|[update_portainer_agent.sh](../tools/update_portainer_agent.sh)||Update|Upgrade Portainer Agent||