58 Commits

Author SHA1 Message Date
marph91
1749e00697 Documentation: Fix list indentation (#8050)
---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2024-10-28 00:02:06 +00:00
Trenton H
e3bc680bf1 Chore: Drop Python 3.9 support (#7774) 2024-09-26 12:22:24 -07:00
shamoon
a77f82f2cd Documentation: move usually-unneeded 'mime-support' from bare-metal docs (#7689) 2024-09-11 12:58:53 -07:00
fusselkater
1edfa757f7 Fix: correct nltk data path (#7338) 2024-07-29 07:27:08 -07:00
Trenton H
bd6b6f9fc2 Documentation: Corrections and clarifications for Python support (#6995)
* Clarifies Python version support and a rough policy of what versions are supported
2024-06-13 11:53:34 -07:00
Trenton H
6ab0996441 Fixes up various doc sections (#6883) 2024-06-02 03:18:12 +00:00
martin f. krafft
0bdc23833f Add copy-paste list of Python build dependencies (#6824)
To be consistent, let's provide an easily copy-pastable list of packages
even for the final set of build dependencies.

Signed-off-by: martin f. krafft <madduck@madduck.net>
2024-05-29 09:03:51 -07:00
shamoon
d948459a28 Merge branch 'dev' 2024-05-06 13:41:08 -07:00
Lino
cf314941bc Documentation: add link to list of hosting providers (#6577) 2024-05-06 20:33:13 +00:00
shamoon
86f2d3af27 Documentation: Remove SQLite to Postgres in favor of export/import (#6401) 2024-04-15 11:50:04 -07:00
shamoon
f52ba29baf Chore: add pre-commit hook for codespell (#5324) 2024-01-08 13:03:05 -08:00
shamoon
7594ea7bd6 Merge branch 'dev' 2024-01-05 21:36:01 -08:00
ChrisRBe
6ece49b4fd Fix: correctly format tip admonition (#5229)
format for material admonition requires a line break and another
level of indentation which was not correctly applied on this line.
2024-01-03 14:34:59 -08:00
Christoph Loy
cd106abb70 Document invalid options in rootless containers (#5122)
Specifying `PAPERLESS_OCR_LANGUAGES` in rootless containers is not possible since the extra languages are currently installed with apt which requires root.

Co-authored-by: Trenton H <797416+stumpylog@users.noreply.github.com>
2024-01-01 08:00:05 -08:00
Johannes Schneider
e1ca4b7d69 fix command for Docker version check (#5196) 2023-12-31 14:21:40 -08:00
Trenton H
194e5ac189 Documentation: Update documentation to refer only to Docker Compose v2 command (#4650)
* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command

* Update docs/setup.md

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2023-11-20 20:14:33 -08:00
shamoon
82d28bdb64 Documentation: update docs, screenshots ahead of Paperless-ngx v2.0 (#4542)
* Reformat internal links

* Update screenshots, docs & readme

* Use image lightbox

* Fix nested list on docs index

* Add some visual interest to screenshots layout

* Compress images
2023-11-13 14:56:34 +00:00
Musa Ahmed
aab543d3c0 Change: Install script improvements (#4387)
* (1) Made curl command to download installation script silent while allowing erros to be dispalyed. (2) Made `if ! command -v ${DOCKER_COMPOSE_CMD}` silent as the other checks are as well.

* Made curl options more clear
2023-10-19 02:49:37 +00:00
Trenton H
07f308e317 Remove old information about building the Docker image locally (#4354) 2023-10-11 13:52:28 +00:00
shamoon
6b0914dbec Merge branch 'main' into dev 2023-09-26 13:33:27 -07:00
shamoon
6d0be20ec7 Documentation enhancement: add direct links for all config vars (#4237) 2023-09-22 11:12:47 -07:00
Trenton Holmes
34b80a4d8e Removes support for Python 3.8 and lower from the code base 2023-09-10 11:42:59 -07:00
Trenton H
e6ca6b6f7a Enables Python 3.11 testing 2023-09-08 11:49:16 -07:00
Jens van Almsick
9c8d521f3c docs(bare-metal): add new dependency
mysqlclient 2.2.0 now requires pkg-config during installation via pip see https://github.com/PyMySQL/mysqlclient/discussions/638#discussioncomment-6333394
2023-08-05 07:55:18 -07:00
andstu
16c03c6ee3 fix: spelling 2023-05-25 00:43:31 -04:00
Guillaume Hullin
700c77c175 Adding doc on how to setup Fail2ban (#3414)
* Adding doc on how to setup Fail2ban

* Adding notes concerning log path variable

* Moved Fail2ban to Wiki

* Added "Enhancing security" section to link to wiki

* Update docs/setup.md

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

* Type

---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2023-05-22 06:53:09 -07:00
shamoon
11b057e437 Fix nginx link 2023-05-18 13:45:04 -07:00
shamoon
6ec0b0a809 Move nginx docs to wiki 2023-05-18 08:52:50 -07:00
shamoon
ece23c0465 Add gnu-sed note for macOS 2023-04-25 23:37:22 -07:00
shamoon
cf9cc07432 Merge pull request #2997 from paperless-ngx/beta
[Beta] Paperless-ngx v1.14.0 Release Candidate 1
2023-04-24 12:04:56 -07:00
shamoon
95f0e48c9e Add exec snippet for createsuperuser
Closes #3154
2023-04-23 20:48:08 -07:00
shamoon
fc5c05d0bf Merge branch 'main' into dev 2023-04-01 21:08:33 -07:00
Max Truxa
ee24280533 Fix: Update outdated docs referencing master
The `master` branch is now called `main`.
2023-03-14 10:19:00 +01:00
Illia Grybkov
b639678d04 Fix formatting in "Setup" documentation page 2023-03-13 09:40:24 -05:00
Trenton Holmes
827339bd3f Adds additional note for bare metal suggesting Redis be secured 2023-03-12 20:53:53 -07:00
Natanael Arndt
55ab9206d2 Update docker-compose start steps
As also written in the docker-compose file it is necessary to do the steps in the order:

1. Run 'docker-compose pull'.
2. Run 'docker-compose run --rm webserver createsuperuser' to create a user.
3. Run 'docker-compose up -d'.
2023-03-09 22:30:55 +01:00
Brandon Rothweiler
7d950d9e87 Add PAPERLESS_OCR_SKIP_ARCHIVE_FILE config setting 2023-02-23 22:42:57 -05:00
shamoon
75bfaa57fc Note possible utf8mb3 requirement 2023-02-05 20:17:22 -08:00
clemensrieder
7eb1747596 Minor updates to development documentation (#2474)
* clarify commands by adding paths

* fix trailing space in header

* rerun pre-commit

* one last time :S

* update sections, remove duplicate information

* those pesky pre-commits ;-)

* implement suggestions
2023-01-26 07:45:35 -08:00
Trenton Holmes
d0f42653ff Merge remote-tracking branch 'origin/main' into beta 2023-01-24 17:54:42 -08:00
Michael Shamoon
192a90cdf7 Note rollback need for regenerating thumbnails
[skip ci]
2023-01-24 10:15:52 -08:00
Muli Dayan
a62ef30bcf Fix docker-compose.yml file name 2023-01-20 12:10:25 -05:00
Robert Resch
d71e591c99 fix link 2023-01-17 20:00:24 +01:00
shamoon
135216f2a3 Merge pull request #2420 from paperless-ngx/fix-2405
Documentation: Fix comment re bare metal runserver command
2023-01-16 15:56:12 -08:00
Jan-Jonas Sämann
99786e3fee Update docs nginx reverse proxy example (#2443)
* Update docs nginx reverse proxy example

According to #817 P3P header is mandatory. Otherwise django CSRF breaks login

* Note P3P header optional

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2023-01-15 19:02:44 -08:00
Michael Shamoon
4680bf768e Fix comment re bare metal runserver command 2023-01-13 11:30:47 -08:00
Michael Shamoon
58e873ed68 Add note re PAPERLESS_DEBUG for dev server 2023-01-08 13:41:23 -08:00
Trenton Holmes
f2ad8155ee Fixes up the slightly behind docs 2023-01-07 16:45:48 -08:00
Stefan
2fa6b16f03 Update bare metall install documentation
Added some info to the baremetal installation and changed it up a bit for easier installation

Co-Authored-By: shamoon <4887959+shamoon@users.noreply.github.com>
2022-12-31 08:26:30 -08:00
tooomm
ab7b09df16 doc fixes
This reverts commit e015babdc102a65a3cce0cc71812d3eb730da92e.

link fix

fix escaping, spacing, profile links, typo

revert

~~add~~ at fixes

Revert "~~add~~ at fixes"

This reverts commit ce0192b733c19614048de81ea917660e25bb35f2.
2022-12-17 19:55:22 -08:00