From f135ed12b052b7a5cc52381c6594b165802d4e8a Mon Sep 17 00:00:00 2001 From: bmsleight Date: Sun, 27 Jan 2019 15:16:19 +0000 Subject: [PATCH] scripts/lxc into docs/examples/lxc/ and assumption noted --- {scripts => docs/examples}/lxc/lxc-install.sh | 6 ++-- {scripts => docs/examples}/lxc/paperless.conf | 0 docs/setup.rst | 30 +++++++++++++------ 3 files changed, 24 insertions(+), 12 deletions(-) rename {scripts => docs/examples}/lxc/lxc-install.sh (92%) rename {scripts => docs/examples}/lxc/paperless.conf (100%) diff --git a/scripts/lxc/lxc-install.sh b/docs/examples/lxc/lxc-install.sh similarity index 92% rename from scripts/lxc/lxc-install.sh rename to docs/examples/lxc/lxc-install.sh index b6e37b18a..3788aa7e1 100644 --- a/scripts/lxc/lxc-install.sh +++ b/docs/examples/lxc/lxc-install.sh @@ -40,8 +40,8 @@ EOF systemctl restart proftpd -#Get Paperless from git (NB: currently fork) -su -c "cd /home/paperless ; git clone https://github.com/bmsleight/paperless" paperless +#Get Paperless from git +su -c "cd /home/paperless ; git clone https://github.com/danielquinn/paperless" paperless # Install Pip Requirements apt-get -y install python3-pip python3-venv @@ -64,7 +64,7 @@ su -c "cd /home/paperless/paperless/src/ ; ./manage.py createsuperuser" paperles 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/ +cp /home/paperless/paperless/docs/examples/lxc/paperless.conf /etc/apache2/sites-available/ a2dissite 000-default.conf a2ensite paperless.conf systemctl reload apache2 diff --git a/scripts/lxc/paperless.conf b/docs/examples/lxc/paperless.conf similarity index 100% rename from scripts/lxc/paperless.conf rename to docs/examples/lxc/paperless.conf diff --git a/docs/setup.rst b/docs/setup.rst index 543411fef..3b17b12b0 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -43,7 +43,7 @@ You can go multiple routes with setting up and running Paperless: * The `bare metal route`_ * The `docker route`_ - * The `linux containers route`_ + * A suggested `linux containers route`_ The `docker route`_ is quick & easy. @@ -51,6 +51,10 @@ The `docker route`_ is quick & easy. The `bare metal route`_ is a bit more complicated to setup but makes it easier should you want to contribute some code back. +The `linux containers route`_ is quick, but makes alot of assumptions on the +set-up, on the other hand the script could be used to install on a base +debian or ubuntu server. + .. _docker route: setup-installation-docker_ .. _bare metal route: setup-installation-bare-metal_ .. _Docker Machine: https://docs.docker.com/machine/ @@ -489,16 +493,24 @@ Docker daemon. .. _setup-installation-linux-containers: -Linux Container Method -++++++++++++++++++++++ +Suggested way for Linux Container Method +++++++++++++++++++++++++++++++++++++++++ + +This method uses some rigid assumptions, for the best set-up:- + + * Ubuntu lts as the container + * Apache as the webserver + * proftpd as ftp server + * ftpupload as the ftp user + * paperless as the main user for website + * http://paperless.lan is the desired lan url + * LXC set to give ip addresses on your lan + +This could also be used as an install on a base debain/ubuntu server, +if the above assumptions are acceptable. 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 @@ -510,7 +522,7 @@ Linux Container Method .. 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" + $ lxc exec paperless -- sh -c "wget https://raw.githubusercontent.com/danielquinn/paperless/master/docs/examples/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.