Commit Graph

270 Commits

Author SHA1 Message Date
Jonas Winkler 491bbd571a more documentation 2020-11-14 14:16:57 +01:00
Jonas Winkler b3d0520d37 versioning. 2020-11-14 12:13:46 +01:00
Jonas Winkler afcb23a567 added some screenshots 2020-11-14 01:21:52 +01:00
Jonas Winkler 79262b631d more documentation. 2020-11-13 21:28:08 +01:00
Jonas Winkler a3aa9ca2dc more docs 2020-11-13 21:06:05 +01:00
Jonas Winkler 2ad3087e22 more documentation 2020-11-13 20:52:09 +01:00
Jonas Winkler aebcc2b911 more documentation. 2020-11-13 20:43:16 +01:00
Jonas Winkler 4862ce7674 more documentation. 2020-11-13 20:30:33 +01:00
Jonas Winkler 070f8ee949 docs and readme 2020-11-13 19:27:22 +01:00
Jonas Winkler f2dbb74d44 reworking the documentation. 2020-11-13 18:46:19 +01:00
Jonas Winkler 7d282a4e4e removed unused code, small fixes 2020-11-02 18:20:04 +01:00
Jonas Winkler 9187026c47 removed some stuff 2020-10-25 20:52:39 +01:00
Jonas Winkler 421dab786d Merge branch 'master' into dev 2020-10-16 15:02:57 +02:00
Yannik Böltes @SEMPERCODING f96c3d0216 Update scanners.rst
Added Brother MFC-9142CDN
2020-06-06 10:24:17 +02:00
Frederick Robinson 2a94e3a648 Adjust docker version requirements in doc
The default config uses docker compose version 2.1 

https://docs.docker.com/compose/compose-file/compose-versioning/#version-21
2020-06-02 00:20:58 -07:00
Pit d841a3ee5e Merge pull request #627 from Flameeyes/master
Update unpaper website link.
2020-05-19 19:02:57 +02:00
Pit 5e0a3bd7a7 Merge pull request #643 from Pyromane/patch-1
Update lxc-install.sh
2020-05-19 18:59:38 +02:00
GaryNg 7f28a857ab Fix a small typo 2020-05-09 05:36:31 +08:00
Pyromane c4848e9a22 Update lxc-install.sh 2020-05-05 21:58:21 +02:00
Diego Elio Pettenò 81c6a8abf0 Update unpaper link to point to the GitHub repository.
While I have been "maintaining" unpaper for the past nine years, I have not
spent any time on it for the past seven or so, beside kicking it down the
road. I'm now trying to put it into a position where it can be taken over
by someone who has interest in it.

The first step is clearly to remove references to my own website where
possible.
2020-04-13 12:45:27 +01:00
Uli 91272029ab fix highlighting skipped warning
* refs https://github.com/sphinx-doc/sphinx/issues/4098
2020-01-11 01:14:06 +01:00
Fabian Winter 9c1fcbcc98 Address comments 2019-11-03 20:14:17 +01:00
Fabian Winter 9b2b435c5b Support SSL for web interface
Thanks to @MasterofJOKers, here is basic support for SSL:
You need to create your key and certificate and copy them to the `data`
directory, named `ssl.cert` and `ssl.key`.
Then, set `PAPERLESS_USE_SSL` in `docker-compose.env` to `true`.

Solves #576.
2019-11-03 18:30:43 +01:00
Matthias Brandt 12f0df0f52 fix: Documentation rendering leads to wrong commands #569 2019-10-05 18:08:06 +02:00
Daniel Quinn 1c956652f3 Merge pull request #542 from grembo/master
Allow configuring transformations to be applied to the filename before
2019-09-09 20:53:45 +01:00
Pit ebd9f918d2 Merge pull request #543 from maur/master
lxc installation - small improvements
2019-09-08 19:13:03 +02:00
Daniel Quinn d9350315f5 Merge pull request #552 from diveflo/master
Use whitenoise and brotli for static file compression & caching
2019-09-08 12:18:48 +01:00
Michael Gmelin f0320fb72d Allow configuring transformations to be applied to the filename before
parsing. The motivation was that files produced by a Brother scanner
wouldn't match paperless' expectations. At most one transformation
is applied (first matching). It won't affect the filename on disk.

This is generic enough so that it is useful for various purposes.
In my case it allows me to use the different hardware buttons on
the scanner to use different profiles, feeding one instance of
paperless with documents of multiple entities and tagging them
accordingly.

Example:

PAPERLESS_FILENAME_PARSE_TRANSFORMS=[{"pattern":"^([a-z]+)_(\\d{8})_(\\d{6})_([0-9]+)\\.", "repl":"\\2\\3Z - \\4 - \\1."},{"pattern":"^([a-z]+)_([0-9]+)\\.", "repl":" - \\2 - \\1."}]
2019-08-31 15:01:25 +02:00
Daniel Barlow d0b513c18f fix title underline length 2019-08-30 12:52:03 +01:00
Daniel Barlow 712e904133 Describe usage of manage.py document_correspondents
Relates to  #347, without which I'd never have known it existed.
2019-08-30 12:37:04 +01:00
Florian Gabsteiger 82855f9d43 Adjust path in setup docs to python 3.6 as 3.4 is deprecated 2019-08-10 17:25:52 +02:00
Florian Gabsteiger 7e77c5ec31 Add static file collection instruction to bare-metal setup guide as it is necessary for whitenoise static file serving 2019-07-25 00:55:20 +02:00
Piotr Cichosz fb15d897b3 Merge branch 'master' into master 2019-05-27 00:28:22 +02:00
Piotr Cichosz 0eb073b6d2 change urls to the-paperless-project repo 2019-05-27 00:18:37 +02:00
Piotr Cichosz 467bb013e2 check if lxc-install executed as root 2019-05-27 00:04:57 +02:00
Piotr Cichosz cd3e8f7f8a allow to set email and password as lxc-install.sh parameter 2019-05-26 23:24:27 +02:00
Piotr Cichosz 1f1a23d19f changed urls for my fork - for easier testing
changed sed separator as suggested in https://github.com/the-paperless-project/paperless/pull/500#discussion_r257806300
2019-05-25 19:02:34 +02:00
Jonas Winkler 32f3876590 Merge branch 'master' into dev 2019-05-21 13:06:16 +02:00
ahyear 0cc5d8b891 Merge pull request #521 from JensPfeifle/update_github_links
Update links to reflect move from danielquinn to the-paperless-project
2019-04-04 11:16:05 +02:00
ahyear a066ad246f Merge pull request #510 from stgarf/patch-1
* Docs: Add docs about enabling and disabling encryption
2019-03-07 13:44:16 +01:00
jenspfeifle 19045f3667 revert docker hub link to danielquinn 2019-03-05 22:24:35 +01:00
jenspfeifle 882b6a93bb update links to reflect move to the-paperless-project 2019-03-05 22:05:44 +01:00
jenspfeifle 362570ca0d update links to reflect move to the-paperless-project 2019-03-05 21:54:59 +01:00
Pit 3db98faf5c Merge pull request #499 from bmsleight/screenshots
* Docs: Add web interface screenshots
2019-03-03 19:57:57 +01:00
Pit 8d4057e396 Merge pull request #502 from bmsleight/scanner_new
* Docs: Add MFC-J5910DW to recommended scanners
2019-03-03 19:54:03 +01:00
Pit 7bf1d2883c Update docs/utilities.rst
Co-Authored-By: stgarf <stgarf@users.noreply.github.com>
2019-03-03 10:46:43 -08:00
Pit 44878f28fa Update docs/utilities.rst
Co-Authored-By: stgarf <stgarf@users.noreply.github.com>
2019-03-03 10:46:06 -08:00
Pit 14d7adbd0a Update docs/utilities.rst
Co-Authored-By: stgarf <stgarf@users.noreply.github.com>
2019-03-03 10:45:58 -08:00
Steve Garf aed8d6ae41 Fix missing . in underline 2019-03-03 10:31:50 -08:00
stgarf 76a9827958 Add docs about enabling and disabling encryption
Adding docs outlining basic syntax of enabling and disabling encryption of your paperless document installation.
2019-02-16 23:25:40 -08:00