44 Commits

Author SHA1 Message Date
NoR8quoh1r
8dbc76ef7d Documentation: setup: Add notes regarding podman and SELinux
The setup instructions are wrong for (rootless) podman.
Add notes helping with getting paperless-ngx setup with podman.
For rootless podman the process inside the container should be running as root (uid 0), which corresponds to the user running the container.
The setup as described may lead to SELinux preventing access to consume and export which prevents the container from accessing those.
2023-12-17 20:27:46 +01:00
Trenton H
c8ee35692c
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
55f26c9c4c
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
f893ba929a
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
01af725d79
Remove old information about building the Docker image locally (#4354) 2023-10-11 13:52:28 +00:00
shamoon
d9abb745a9 Merge branch 'main' into dev 2023-09-26 13:33:27 -07:00
shamoon
379b4f8cd3
Documentation enhancement: add direct links for all config vars (#4237) 2023-09-22 11:12:47 -07:00
Trenton Holmes
650c816a7b Removes support for Python 3.8 and lower from the code base 2023-09-10 11:42:59 -07:00
Trenton H
0ef3a141a8 Enables Python 3.11 testing 2023-09-08 11:49:16 -07:00
Jens van Almsick
3d552c3112 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
a05dbd2e5a fix: spelling 2023-05-25 00:43:31 -04:00
Guillaume Hullin
b8afb22902
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
45d666ff2d Fix nginx link 2023-05-18 13:45:04 -07:00
shamoon
8be8a310d7 Move nginx docs to wiki 2023-05-18 08:52:50 -07:00
shamoon
1898f9b183 Add gnu-sed note for macOS 2023-04-25 23:37:22 -07:00
shamoon
65064a6934
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
47682bc143 Add exec snippet for createsuperuser
Closes #3154
2023-04-23 20:48:08 -07:00
shamoon
de155a753d Merge branch 'main' into dev 2023-04-01 21:08:33 -07:00
Max Truxa
8161316c01
Fix: Update outdated docs referencing master
The `master` branch is now called `main`.
2023-03-14 10:19:00 +01:00
Illia Grybkov
7912f4a22a
Fix formatting in "Setup" documentation page 2023-03-13 09:40:24 -05:00
Trenton Holmes
851b23fb09 Adds additional note for bare metal suggesting Redis be secured 2023-03-12 20:53:53 -07:00
Natanael Arndt
283a2ab648
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
ca412e0184 Add PAPERLESS_OCR_SKIP_ARCHIVE_FILE config setting 2023-02-23 22:42:57 -05:00
shamoon
cc971a4569 Note possible utf8mb3 requirement 2023-02-05 20:17:22 -08:00
clemensrieder
2801b60b0e
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
7ecb76dddc Merge remote-tracking branch 'origin/main' into beta 2023-01-24 17:54:42 -08:00
Michael Shamoon
e74af5c73c Note rollback need for regenerating thumbnails
[skip ci]
2023-01-24 10:15:52 -08:00
Muli Dayan
3c7eacf923
Fix docker-compose.yml file name 2023-01-20 12:10:25 -05:00
Robert Resch
e6cd3c1970
fix link 2023-01-17 20:00:24 +01:00
shamoon
6c7ff54aad
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
412d9f5cd2
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
150c7f26a5 Fix comment re bare metal runserver command 2023-01-13 11:30:47 -08:00
Michael Shamoon
7b87511e88 Add note re PAPERLESS_DEBUG for dev server 2023-01-08 13:41:23 -08:00
Trenton Holmes
fbebd8d7c0 Fixes up the slightly behind docs 2023-01-07 16:45:48 -08:00
Stefan
3c8d7f2dee 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
43b863b816 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
tooomm
0472dfe25a
Docs: Fix leftover issues from conversion (#2172) 2022-12-11 10:12:58 -08:00
tooomm
8b36c9ad64 more fixes and cleanup 2022-12-11 08:06:17 -08:00
tooomm
1266f2d5b9 fix links 2022-12-11 08:06:17 -08:00
Sven Strittmatter
d198142a1e
Update setup.md
W/o the slash it resolves to /setup/configuration/ which does 404.
2022-12-09 22:09:06 +01:00
Trenton Holmes
7788d93227 Further cleanup of docs, including fixing autoconvert issues and general cleanups 2022-12-06 10:45:18 -08:00
Michael Shamoon
cdd49c5142 Update frontend compilation info 2022-12-04 14:32:08 -08:00
Trenton Holmes
1727eb00cc Cleans up a number of internal links 2022-12-03 08:28:44 -08:00
Michael Shamoon
605f885e19 Move docs to material-mkdocs 2022-12-02 14:48:36 -08:00