summaryrefslogtreecommitdiff
path: root/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst')
-rw-r--r--vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst
new file mode 100644
index 0000000..daaa1ef
--- /dev/null
+++ b/vendor/CherryPy-3.2.0/sphinx/source/refman/process/plugins/dropprivileges.rst
@@ -0,0 +1,25 @@
+***************
+Drop privileges
+***************
+
+Use this :ref:`Engine Plugin<plugins>` to start your
+CherryPy site as root (for example, to listen on a privileged port like 80)
+and then reduce privileges to something more restricted.
+
+This priority of this plugin's "start" listener is slightly higher than the
+priority for ``server.start`` in order to facilitate the most common use:
+starting on a low port (which requires root) and then dropping to another user.
+
+Example::
+
+ DropPrivileges(cherrypy.engine, '/var/run/myapp.pid').subscribe()
+
+.. currentmodule:: cherrypy.process.plugins
+
+Classes
+=======
+
+.. autoclass:: DropPrivileges
+ :members:
+ :show-inheritance:
+