paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-25 10:49:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Expands documentation around the permissions of the custom scripts and the folder

Browse Source
This commit is contained in:
Trenton Holmes 2022-11-29 20:06:56 -08:00 committed by Trenton H
parent 88e3e556a1
commit 4e90fda80f
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/advanced_usage.rst
View File

@ -407,11 +407,14 @@ The Docker image includes the ability to run custom user scripts during startup.
utilized for installing additional tools or Python packages, for example.
To utilize this, mount a folder containing your scripts to the custom initialization directory, `/custom-cont-init.d`
and place scripts you wish to run inside. For security, the folder and its contents must be owned by `root`.
Additionally, scripts must only be writable by `root`.
and place scripts you wish to run inside. For security, the folder must be owned by `root` and should have permissions
of `a=rx`. Additionally, scripts must only be writable by `root`.
Your scripts will be run directly before the webserver completes startup. Scripts will be run by the `root` user.
This is an advanced functionality with which you could break functionality or lose data.
If you would like to switch users, the utility `gosu` is available and preferred over `sudo`.
This is an advanced functionality with which you could break functionality or lose data. If you experience issues,
please disable any custom scripts and try again before reporting an issue.
For example, using Docker Compose:
@ -425,6 +428,7 @@ For example, using Docker Compose:
volumes:
- /path/to/my/scripts:/custom-cont-init.d:ro
.. _advanced-mysql-caveats:
MySQL Caveats