]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Expands documentation around the permissions of the custom scripts and the folder
authorTrenton Holmes <797416+stumpylog@users.noreply.github.com>
Wed, 30 Nov 2022 04:06:56 +0000 (20:06 -0800)
committerTrenton H <797416+stumpylog@users.noreply.github.com>
Thu, 1 Dec 2022 15:21:25 +0000 (07:21 -0800)
docs/advanced_usage.rst

index 1fe3e368583e09efe4b4bfb170eacf0608c4b0c5..61b5f332328901a1eac343f47d98c62135425c51 100644 (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