Merge 4ed5c55 into 94c2950

the-paperless-project · Jan 27, 2019 · 03b8204 · 03b8204
2 parents 94c2950 + 4ed5c55
commit 03b8204
Show file tree

Hide file tree

Showing 10 changed files with 205 additions and 1 deletion.
diff --git a/docs/_static/Screenshot_first_logged.png b/docs/_static/Screenshot_first_logged.png
diff --git a/docs/_static/Screenshot_first_run_login.png b/docs/_static/Screenshot_first_run_login.png
diff --git a/docs/_static/Screenshot_upload_and_scanned.png b/docs/_static/Screenshot_upload_and_scanned.png
diff --git a/docs/_static/lxc-install.svg b/docs/_static/lxc-install.svg
diff --git a/docs/index.rst b/docs/index.rst
@@ -45,4 +45,5 @@ Contents
    troubleshooting
    contributing
    scanners
+   screenshots
    changelog
diff --git a/docs/scanners.rst b/docs/scanners.rst
@@ -17,13 +17,17 @@ that works right for you based on recommentations from other Paperless users.
 +---------+----------------+-----+-----+-----+----------------+
 | Brother | `MFC-J6930DW`_ | yes |     |     | `ayounggun`_   |
 +---------+----------------+-----+-----+-----+----------------+
+| Brother | `MFC-J5910DW`_ | yes |     |     | `bmsleight`_   |
++---------+----------------+-----+-----+-----+----------------+
 | Fujitsu | `ix500`_       | yes |     | yes | `eonist`_      |
 +---------+----------------+-----+-----+-----+----------------+
 
 .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
 .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
+.. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
 .. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
 
 .. _danielquinn: https://github.com/danielquinn
 .. _ayounggun: https://github.com/ayounggun
+.. _bmsleight: https://github.com/bmsleight
 .. _eonist: https://github.com/eonist
diff --git a/docs/screenshots.rst b/docs/screenshots.rst
@@ -0,0 +1,16 @@
+.. _screenshots:
+
+Screenshots
+===========
+
+Once everything is set-up login to paperless using the web front-end
+
+.. image:: ./_static/Screenshot_first_run_login.png 
+
+Nice clean interface
+
+.. image:: ./_static/Screenshot_first_logged.png 
+
+Some documents loaded in via ftp or using the scanners ftp. 
+
+.. image:: ./_static/Screenshot_upload_and_scanned.png 
diff --git a/docs/setup.rst b/docs/setup.rst
@@ -43,6 +43,7 @@ You can go multiple routes with setting up and running Paperless:
 
  * The `bare metal route`_
  * The `docker route`_
+ * The `linux containers route`_
 
 
 The `docker route`_ is quick & easy.
@@ -53,7 +54,7 @@ should you want to contribute some code back.
 .. _docker route: setup-installation-docker_
 .. _bare metal route: setup-installation-bare-metal_
 .. _Docker Machine: https://docs.docker.com/machine/
-
+.. _linux containers route: setup-installation-linux-containers_
 
 .. _setup-installation-bare-metal:
 
@@ -484,3 +485,37 @@ If you're using Docker, you can set a restart-policy_ in the
 Docker daemon.
 
 .. _restart-policy: https://docs.docker.com/engine/reference/commandline/run/#restart-policies-restart
+
+
+.. _setup-installation-linux-containers:
+
+Linux Container Method
+++++++++++++++++++++++
+
+1. Install lxc
+
+   .. caution::
+
+      This guide assumes that you use lxc on a ubuntu host, with  
+      networking set-up to get ip addresses on your lan. 
+      However, if this is set-up only two commands are needed.
+
+2. Lanch paperless container
+
+.. code:: bash
+
+    $ lxc launch ubuntu: paperless
+
+3. Run install script within container
+
+.. code:: bash
+
+    $ lxc exec paperless -- sh -c "wget https://raw.githubusercontent.com/danielquinn/paperless/master/scripts/lxc/lxc-install.sh && /bin/bash lxc-install.sh"
+
+The script will ask you for an ftpupload password.  
+As well as the super-user for paperless web front-end. 
+After around 10 mins, http://paperless.lan is ready and
+ftp://paperless.lan with user: ftpupload
+
+See the `Installation recording <_static/lxc-install.svg>`_.
+
diff --git a/scripts/lxc/lxc-install.sh b/scripts/lxc/lxc-install.sh
@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+# Bash script to install paperless in lxc containter
+# paperless.lan
+#
+# Will set-up paperless, apache2 and proftpd
+#
+# lxc launch ubuntu: paperless
+# lxc exec paperless -- sh -c "wget https://raw.githubusercontent.com/danielquinn/paperless/master/scripts/lxc/lxc-install.sh && /bin/bash lxc-install.sh"
+#
+#
+
+# Add paperless user with no password
+adduser --disabled-password --gecos "" paperless
+# Add ftpupload
+adduser --disabled-password --gecos "" ftpupload
+echo "Set ftpupload password: "
+passwd ftpupload
+# Allow paperless group to access
+adduser paperless ftpupload
+chmod g+w /home/ftpupload 
+
+# Get apt up to date
+apt-get update
+
+# Needed for plain Paperless
+apt-get -y install unpaper gnupg libpoppler-cpp-dev python3-pyocr tesseract-ocr imagemagick optipng
+
+# Needed for Apache
+apt-get -y install apache2 libapache2-mod-wsgi-py3
+
+# Install ftp server and make sure all uplaoded files are owned by paperless
+apt-get -y install proftpd
+cat <<EOF >> /etc/proftpd/proftpd.conf
+<Directory /home/ftpupload/>
+  UserOwner   paperless
+  GroupOwner  paperless
+</Directory>
+EOF
+systemctl restart proftpd
+
+
+#Get Paperless from git (NB: currently fork)
+su -c "cd /home/paperless ; git clone https://github.com/bmsleight/paperless" paperless
+
+# Install Pip Requirements
+apt-get -y install python3-pip python3-venv
+cd /home/paperless/paperless
+pip3 install -r requirements.txt
+
+# Take paperless.conf.example and set consumuption dir (ftp dir)
+sed  -e '/PAPERLESS_CONSUMPTION_DIR=/s/=.*/=\"\/home\/ftpupload\/\"/' \
+     /home/paperless/paperless/paperless.conf.example  >/etc/paperless.conf
+
+# Update /etc/paperless.conf with PAPERLESS_SECRET_KEY
+SECRET=$(strings /dev/urandom | grep -o '[[:alnum:]]' | head -n 30 | tr -d '\n'; echo)
+sed  -i "s/#PAPERLESS_SECRET_KEY.*/PAPERLESS_SECRET_KEY=$SECRET/g" /etc/paperless.conf 
+
+#Initialise the SQLite database 
+su -c "cd /home/paperless/paperless/src/ ; ./manage.py migrate" paperless
+#Create a user for your Paperless instance
+su -c "cd /home/paperless/paperless/src/ ; ./manage.py createsuperuser" paperless
+# 167 static files copied to '/home/paperless/paperless/static'.
+su -c "cd /home/paperless/paperless/src/ ; ./manage.py collectstatic" paperless
+
+# Set-up apache
+cp /home/paperless/paperless/scripts/lxc/paperless.conf /etc/apache2/sites-available/
+a2dissite 000-default.conf
+a2ensite paperless.conf
+systemctl reload apache2
+
+sed -e "s/home\/paperless\/project\/virtualenv\/bin\/python/usr\/bin\/python3/" \
+     /home/paperless/paperless/scripts/paperless-consumer.service \
+     >/etc/systemd/system/paperless-consumer.service
+
+sed  -i "s/\/home\/paperless\/project\/src\/manage.py/\/home\/paperless\/paperless\/src\/manage.py/" \
+      /etc/systemd/system/paperless-consumer.service
+
+
+systemctl enable paperless-consumer
+systemctl start paperless-consumer
+
+# convert-im6.q16: not authorized
+# Security risk ?
+# https://stackoverflow.com/questions/42928765/convertnot-authorized-aaaa-error-constitute-c-readimage-453
+mv /etc/ImageMagick-6/policy.xml /etc/ImageMagick-6/policy.xmlout
diff --git a/scripts/lxc/paperless.conf b/scripts/lxc/paperless.conf
@@ -0,0 +1,18 @@
+<VirtualHost *:80>
+    ServerName paperless.lan
+
+    Alias /static/ /home/paperless/paperless/static/
+    <Directory /home/paperless/paperless/static>
+        Require all granted
+    </Directory>
+
+    WSGIScriptAlias / /home/paperless/paperless/src/paperless/wsgi.py
+    WSGIDaemonProcess paperless.lan user=paperless group=paperless threads=5 python-path=/home/paperless/paperless/src 
+    WSGIProcessGroup paperless.lan
+
+    <Directory /home/paperless/paperless/src/paperless>
+        <Files wsgi.py>
+            Require all granted
+        </Files>
+    </Directory>
+</VirtualHost>