Adding lxc documentation

This commit is contained in:
bmsleight 2019-01-20 21:19:43 +00:00
parent af2eae81eb
commit f74313f3ab
8 changed files with 101 additions and 1 deletions

BIN
docs/_static/Screenshot_first_logged.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

44
docs/_static/lxc-install.svg vendored Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 1.9 MiB

View File

@ -45,4 +45,5 @@ Contents
troubleshooting
contributing
scanners
screenshots
changelog

View File

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

16
docs/screenshots.rst Normal file
View File

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

View File

@ -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:
@ -471,3 +472,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>`_.