update the easy install script and documentation

docs/setup.rst

@@ -81,6 +81,7 @@ Installation
 
 You can go multiple routes to setup and run Paperless:
 
+* :ref:`Use the easy install docker script <setup-docker_script>`
 * :ref:`Pull the image from Docker Hub <setup-docker_hub>`
 * :ref:`Build the Docker image yourself <setup-docker_build>`
 * :ref:`Install Paperless directly on your system manually (bare metal) <setup-bare_metal>`
@@ -101,6 +102,24 @@ it includes the same sensible defaults, and it simultaneously provides the flexi
 .. _CLI Basics: https://sehn.tech/post/devops-with-docker/
 .. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency
 
+.. _setup-docker_script:
+
+Install Paperless from Docker Hub using the installation script
+===============================================================
+
+Paperless provides an interactive installation script. This script will ask you
+for a couple configuration options, download and create the necessary configuration files, pull the docker image, start paperless and create your user account. This script essentially
+performs all the steps described in :ref:`setup-docker_hub` automatically.
+
+1.  Make sure that docker and docker-compose are installed.
+2.  Download and run the installation script:
+
+    .. code:: shell-session
+
+        $ wget https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh
+        $ chmod +x install-paperless-ng.sh
+        $ ./install-paperless-ng.sh
+
 .. _setup-docker_hub:
 
 Install Paperless from Docker Hub

install-paperless-ng.sh

@@ -15,7 +15,7 @@ ask() {
 		fi
 		array=$3
 		if [[ -z $3 || " ${array[@]} " =~ " ${result} " ]]; then
-    	ask_result=$result
+			ask_result=$result
 			return
 		else
 			echo "Invalid option: $result"
@@ -23,6 +23,47 @@ ask() {
 	done
 }
 
+ask_docker_folder() {
+	while true ; do
+
+		read -p "$1 [$2]: " result
+
+		if [[ -z $result ]]; then
+			ask_result=$2
+			return
+		fi
+
+		if [[ $result == /* || $result == ./* ]]; then
+			ask_result=$result
+			return
+		else
+			echo "Invalid folder: $result"
+		fi
+
+
+	done
+}
+
+if [[ $(id -u) == "0" ]] ; then
+	echo "Do not run this script as root."
+	exit 1
+fi
+
+if [[ -z $(which wget) ]] ; then
+	echo "wget executable not found. Is wget installed?"
+	exit 1
+fi
+
+if [[ -z $(which docker) ]] ; then
+	echo "docker executable not found. Is docker installed?"
+	exit 1
+fi
+
+if [[ -z $(which docker-compose) ]] ; then
+	echo "docker-compose executable not found. Is docker-compose installed?"
+	exit 1
+fi
+
 echo ""
 echo "############################################"
 echo "###   Paperless-ng docker installation   ###"
@@ -48,14 +89,13 @@ echo "The consume folder is where paperles will search for new documents."
 echo "Point this to a folder where your scanner is able to put your scanned"
 echo "documents."
 echo ""
-echo "HINT: If paperless is unable to pick up any files from this directory after"
+echo "CAUTION: You must specify an absolute path starting with / or a relative "
-echo "installation, you might need to configure PAPERLESS_CONSUMER_POLLING."
+echo "path starting with ./ here. Examples:"
-echo "See the documentation for details."
+echo "  /mnt/consume"
-echo ""
+echo "  ./consume"
-echo "CAUTION: You must specify an absolute path starting with /"
 echo ""
 
-ask "Consume folder" "$TARGET_FOLDER/consume"
+ask_docker_folder "Consume folder" "$TARGET_FOLDER/consume"
 CONSUME_FOLDER=$ask_result
 
 echo ""
@@ -64,9 +104,10 @@ echo "Leave empty and docker will manage this folder for you."
 echo "Docker usually stores managed folders in /var/lib/docker/volumes."
 echo ""
 echo "CAUTION: If specified, you must specify an absolute path starting with /"
+echo "or a relative path starting with ./ here."
 echo ""
 
-ask "Media folder" ""
+ask_docker_folder "Media folder" ""
 MEDIA_FOLDER=$ask_result
 
 echo ""
@@ -74,8 +115,11 @@ echo "The data folder is where paperless stores other data, such as your"
 echo "SQLite database (if used), the search index and other data."
 echo "As with the media folder, leave empty to have this managed by docker."
 echo ""
+echo "CAUTION: If specified, you must specify an absolute path starting with /"
+echo "or a relative path starting with ./ here."
+echo ""
 
-ask "Data folder" ""
+ask_docker_folder "Data folder" ""
 DATA_FOLDER=$ask_result
 
 echo ""
@@ -166,8 +210,36 @@ done
 ask "Email" "$USERNAME@localhost"
 EMAIL=$ask_result
 
-echo "Done collecting data. Press any key to install."
+echo ""
-read
+echo "Summary"
+echo "======="
+echo ""
+
+echo "Target folder: $TARGET_FOLDER"
+echo "Consume folder: $CONSUME_FOLDER"
+if [[ -z $MEDIA_FOLDER ]] ; then
+	echo "Media folder: Managed by docker"
+else
+	echo "Media folder: $MEDIA_FOLDER"
+fi
+if [[ -z $DATA_FOLDER ]] ; then
+	echo "Data folder: Managed by docker"
+else
+	echo "Data folder: $DATA_FOLDER"
+fi
+echo ""
+echo "Port: $PORT"
+echo "Database: $DATABASE_BACKEND"
+echo "Tika enabled: $TIKA_ENABLED"
+echo "OCR language: $OCR_LANGUAGE"
+echo "User id: $USERMAP_UID"
+echo "Group id: $USERMAP_GID"
+echo ""
+echo "Paperless username: $USERNAME"
+echo "Paperless email: $EMAIL"
+
+echo ""
+read -p "Press any key to install."
 
 echo ""
 echo "Installing paperless..."
@@ -209,7 +281,7 @@ sed -i "s/- 8000:8000/- $PORT:8000/g" docker-compose.yml
 sed -i "s#- \./consume:/usr/src/paperless/consume#- $CONSUME_FOLDER:/usr/src/paperless/consume#g" docker-compose.yml
 
 if [[ -n $MEDIA_FOLDER ]] ; then
-	sed -i "s#- data:/usr/src/paperless/media#- $MEDIA_FOLDER:/usr/src/paperless/media#g" docker-compose.yml
+	sed -i "s#- media:/usr/src/paperless/media#- $MEDIA_FOLDER:/usr/src/paperless/media#g" docker-compose.yml
 fi
 
 if [[ -n $DATA_FOLDER ]] ; then