OpenSource/paperless-archive
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adding lxc documentation

Browse Source
This commit is contained in:
bmsleight committed 2019-01-20 21:19:43 +00:00
1 parent af2eae81eb
commit f74313f3ab
8 files changed
+101 -1
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/_static/Screenshot_first_logged.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

docs/_static/Screenshot_first_run_login.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

docs/_static/Screenshot_upload_and_scanned.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 113 KiB

docs/_static/lxc-install.svg
Vendored
+44
View File
@@ -0,0 +1,44 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="terminal" baseProfile="full" viewBox="0 0 1056 733" width="1056" version="1.1">
<defs>
<termtosvg:template_settings xmlns:termtosvg="https://github.com/nbedos/termtosvg">
<termtosvg:screen_geometry columns="132" rows="43"/>
</termtosvg:template_settings>
<style type="text/css" id="generated-style"><![CDATA[:root {
--animation-duration: 218367ms;
}
#screen {
font-family: 'DejaVu Sans Mono', monospace;
font-style: normal;
font-size: 14px;
}
text {
dominant-baseline: text-before-edge;
white-space: pre;
}]]></style>
<style type="text/css" id="user-style">
/* gjm8 color theme (source: https://terminal.sexy/) */
.foreground {fill: #c5c5c5;}
.background {fill: #1c1c1c;}
.color0 {fill: #1c1c1c;}
.color1 {fill: #ff005b;}
.color2 {fill: #cee318;}
.color3 {fill: #ffe755;}
.color4 {fill: #048ac7;}
.color5 {fill: #833c9f;}
.color6 {fill: #0ac1cd;}
.color7 {fill: #e5e5e5;}
.color8 {fill: #1c1c1c;}
.color9 {fill: #ff005b;}
.color10 {fill: #cee318;}
.color11 {fill: #ffe755;}
.color12 {fill: #048ac7;}
.color13 {fill: #833c9f;}
.color14 {fill: #0ac1cd;}
.color15 {fill: #e5e5e5;}
</style>
</defs>
<svg id="screen" width="1056" viewBox="0 0 1056 731" preserveAspectRatio="xMidYMin meet">
<rect class="background" height="100%" width="100%" x="0" y="0"/><g display="none"><rect class="foreground" height="17" width="8" x="0" y="0"/><use y="0" xlink:href="#g1"/><animate attributeName="display" begin="0ms; anim_last.end" dur="47ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="144" y="0"/><use y="0" xlink:href="#g2"/><animate attributeName="display" begin="47ms; anim_last.end+47ms" dur="1580ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="0" y="34"/><use y="34" xlink:href="#g1"/><animate attributeName="display" begin="1627ms; anim_last.end+1627ms" dur="1060ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="0" y="629"/><use y="629" xlink:href="#g1"/><animate attributeName="display" begin="2687ms; anim_last.end+2687ms" dur="68ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="104" y="629"/><use y="629" xlink:href="#g3"/><animate attributeName="display" begin="2755ms; anim_last.end+2755ms" dur="2000ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="328" y="646"/><use y="646" xlink:href="#g4"/><animate attributeName="display" begin="4755ms; anim_last.end+4755ms" dur="1059ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="0" y="663"/><use y="663" xlink:href="#g1"/><animate attributeName="display" begin="5814ms; anim_last.end+5814ms" dur="65ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="0" y="680"/><use y="680" xlink:href="#g1"/><animate attributeName="display" begin="5879ms; anim_last.end+5879ms" dur="2000ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="0" y="697"/><use y="697" xlink:href="#g1"/><animate attributeName="display" begin="7879ms; anim_last.end+7879ms" dur="465ms" from="inline" to="inline"/></g><g display="none"><use y="0" xlink:href="#g5"/><use y="17" xlink:href="#g6"/><animate attributeName="display" begin="1627ms; anim_last.end+1627ms" dur="8717ms" from="inline" to="inline"/></g><g display="none"><use y="34" xlink:href="#g7"/><use y="68" xlink:href="#g8"/><use y="85" xlink:href="#g9"/><use y="102" xlink:href="#g10"/><use y="136" xlink:href="#g11"/><use y="170" xlink:href="#g12"/><use y="187" xlink:href="#g13"/><use y="204" xlink:href="#g14"/><use y="221" xlink:href="#g15"/><use y="238" xlink:href="#g16"/><use y="272" xlink:href="#g17"/><use y="306" xlink:href="#g18"/><use y="323" xlink:href="#g19"/><use y="357" xlink:href="#g20"/><use y="391" xlink:href="#g21"/><use y="425" xlink:href="#g22"/><use y="476" xlink:href="#g23"/><use y="493" xlink:href="#g24"/><use y="510" xlink:href="#g25"/><use y="544" xlink:href="#g26"/><use y="561" xlink:href="#g27"/><use y="612" xlink:href="#g28"/><animate attributeName="display" begin="2687ms; anim_last.end+2687ms" dur="7657ms" from="inline" to="inline"/></g><g display="none"><use y="629" xlink:href="#g29"/><animate attributeName="display" begin="4755ms; anim_last.end+4755ms" dur="5589ms" from="inline" to="inline"/></g><g display="none"><use y="646" xlink:href="#g30"/><animate attributeName="display" begin="5814ms; anim_last.end+5814ms" dur="4530ms" from="inline" to="inline"/></g><g display="none"><use y="663" xlink:href="#g31"/><animate attributeName="display" begin="5879ms; anim_last.end+5879ms" dur="4465ms" from="inline" to="inline"/></g><g display="none"><use y="680" xlink:href="#g32"/><animate attributeName="display" begin="7879ms; anim_last.end+7879ms" dur="2465ms" from="inline" to="inline"/></g><g display="none"><rect class="foreground" height="17" width="8" x="104" y="697"/><use y="697" xlink:href="#g3"/><animate attributeName="display" begin="8344ms; anim_last.end+8344ms" dur="2000ms" from="inline" to="inline"/></g><g display="none"><use y="0" xlink:href="#g6"/><use y="17" xlink:href="#g7"/><use y="51" xlink:href="#g8"/><use y="68" xlink:href="#g9"/><use y="85" xlink:href="#g10"/><use y="119" xlink:href="#g11"/><use y="153" xlink:href="#g12"/><use y="170" xlink:href="#g13"/><use y="187" xlink:href="#g14"/><use y="204" xlink:href="#g15"/><use y="221" xlink:href="#g16"/><use y="255" xlink:href="#g17"/><use y="289" xlink:href="#g18"/><use y="306" xlink:href="#g19"/><use y="340" xlink:href="#g20"/><use y="374" xlink:href="#g21"/><use y="408" xlink:href="#g22"/><use y="459" xlink:href="#g23"/><use y="476" xlink:href="#g24"/><use y="493" xlink:href="#g25"/><use y="527" xlink:href="#g26"/><use y="544" xlink:href="#g27"/><use y="595" xlink:href="#g28"/><use y="612" xlink:href="#g29"/><use y="629" xlink:href="#g30"/><use y="646" xlink:href="#g31"/><use y="663" xlink:href="#g32"/><use y="680" xlink:href="#g33"/><use y="697" xlink:href="#g34"/><rect class="foreground" height="17" width="8" x="248" y="714"/><use y="714" xlink:hreLine truncated
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.9 MiB

docs/index.rst
+1
View File
@@ -45,4 +45,5 @@ Contents
troubleshooting
contributing
scanners
screenshots
changelog
docs/scanners.rst
+4
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
docs/screenshots.rst
+16
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
docs/setup.rst
+36 -1
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>`_.