From 5c229dedb0c9a38a470b3e6118bc2ff6b68d7c45 Mon Sep 17 00:00:00 2001 From: Chris Darroch Date: Fri, 21 Mar 2008 07:49:47 +0000 Subject: [PATCH] PR 43211: Revise mod_authn_dbd and mod_authz_dbd documenation to reflect current APR DBD query statement parameter requirements. Tidy up examples and links to glossary and external sites. Update transformation. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@639562 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/directives.html.en | 1 + docs/manual/mod/mod_authn_dbd.html.en | 96 ++-- docs/manual/mod/mod_authn_dbd.xml | 107 ++-- docs/manual/mod/mod_authz_dbd.html.en | 136 +++-- docs/manual/mod/mod_authz_dbd.xml | 137 +++-- docs/manual/mod/mod_dbd.html.en | 16 +- docs/manual/mod/mod_dbd.xml | 17 +- docs/manual/mod/mpm_common.html.en | 21 + docs/manual/mod/mpm_common.xml.de | 2 +- docs/manual/mod/mpm_common.xml.ja | 2 +- docs/manual/mod/mpm_common.xml.meta | 2 +- docs/manual/mod/quickreference.html.en | 729 +++++++++++++------------ 12 files changed, 683 insertions(+), 583 deletions(-) diff --git a/docs/manual/mod/directives.html.en b/docs/manual/mod/directives.html.en index 669e45d65a..f482006c6e 100644 --- a/docs/manual/mod/directives.html.en +++ b/docs/manual/mod/directives.html.en @@ -145,6 +145,7 @@
  • CheckCaseOnly
  • CheckSpelling
  • ChildPerUserID
    • +
  • ChrootDir
  • ContentDigest
  • CookieDomain
  • CookieExpires
    • diff --git a/docs/manual/mod/mod_authn_dbd.html.en b/docs/manual/mod/mod_authn_dbd.html.en index 3bc4136e9a..b2c5dd5f25 100644 --- a/docs/manual/mod/mod_authn_dbd.html.en +++ b/docs/manual/mod/mod_authn_dbd.html.en @@ -74,35 +74,29 @@

    This simple example shows use of this module in the context of the Authentication and DBD frameworks.

    -#Database Management
+# mod_dbd configuration
+DBDriver pgsql
+DBDParams "dbname=apacheauth user=apache password=xxxxxx"
 
-#Use the PostgreSQL driver
-DBDriver pgsql
+DBDMin  4
+DBDKeep 8
+DBDMax  20
+DBDExptime 300
 
-#Connection string: database name and login credentials
-DBDParams "dbname=htpasswd user=apache password=xxxxxx"
+<Directory /usr/www/myhost/private>
+  # mod_authn_core and mod_auth_basic configuration
+  # for mod_authn_dbd
+  AuthType Basic
+  AuthName "My Server"
+  AuthBasicProvider dbd
 
-#Parameters for Connection Pool Management
-DBDMin  1
-DBDKeep 2
-DBDMax  10
-DBDExptime 60
+  # mod_authz_core configuration
+  Require valid-user
 
-#Authentication Section
-<Directory /usr/www/myhost/private>
-
-    #mod_auth configuration for authn_dbd
-    AuthType Basic
-    AuthName "My Server"
-    AuthBasicProvider dbd
-
-    #authz configuration
-    Require valid-user
-
-    #SQL query to verify a user
-    #(note: DBD drivers recognise both stdio-like %s and native syntax)
-    AuthDBDUserPWQuery "select password from authn where username = %s"
-</Directory>
+  # mod_authn_dbd SQL query to authenticate a user
+  AuthDBDUserPWQuery \
+    "SELECT password FROM authn WHERE user = %s"
+</Directory>
    top
    @@ -131,16 +125,22 @@ configuration required in some web applications. Module:mod_authn_dbd

    The AuthDBDUserPWQuery specifies an - SQL query to look up a password for a specified user. - The query must take a single string (typically SQL varchar) - argument (username), and return a single value (encrypted password). -

    -

    - AuthDBDUserPWQuery "SELECT password FROM authn WHERE username = %s" -

    -

    If httpd was built against apr v1.3.0 or higher, any additional - columns specified in the select statement will be inserted into - the environment with the name AUTHENTICATE_<COLUMN>. + SQL query to look up a password for a specified user. The user's ID + will be passed as a single string parameter when the SQL query is + executed. It may be referenced within the query statement using + a %s format specifier.

    +

    Example

    +AuthDBDUserPWQuery \
+  "SELECT password FROM authn WHERE user = %s"
+
    +

    The first column value of the first row returned by the query + statement should be a string containing the encrypted password. + Subsequent rows will be ignored. If no rows are returned, the user + will not be authenticated through mod_authn_dbd.

    +

    If httpd was built against APR version 1.3.0 + or higher, any additional column values in the first row returned by + the query statement will be stored as environment variables with + names of the form AUTHENTICATE_COLUMN.

    @@ -156,19 +156,23 @@ configuration required in some web applications.

    The AuthDBDUserRealmQuery specifies an SQL query to look up a password for a specified user and realm. - The query must take two string (typically SQL varchar) arguments - (username and realm), and return a single value (encrypted password). -

    -

    - AuthDBDUserRealmQuery "SELECT password FROM authn - WHERE username = %s AND realm = %s" -

    -

    If httpd was built against apr v1.3.0 or higher, any additional - columns specified in the select statement will be inserted into - the environment with the name AUTHENTICATE_<COLUMN>. + The user's ID and the realm, in that order, will be passed as string + parameters when the SQL query is executed. They may be referenced + within the query statement using %s format specifiers.

    +

    Example

    +AuthDBDUserRealmQuery \
+  "SELECT password FROM authn WHERE user = %s AND realm = %s"
+
    +

    The first column value of the first row returned by the query + statement should be a string containing the encrypted password. + Subsequent rows will be ignored. If no rows are returned, the user + will not be authenticated through mod_authn_dbd.

    +

    If httpd was built against APR version 1.3.0 + or higher, any additional column values in the first row returned by + the query statement will be stored as environment variables with + names of the form AUTHENTICATE_COLUMN.

    -
    diff --git a/docs/manual/mod/mod_authn_dbd.xml b/docs/manual/mod/mod_authn_dbd.xml index 6f743994d2..bdf1b6a657 100644 --- a/docs/manual/mod/mod_authn_dbd.xml +++ b/docs/manual/mod/mod_authn_dbd.xml @@ -62,37 +62,30 @@

    This simple example shows use of this module in the context of the Authentication and DBD frameworks.

    -#Database Management
-
-#Use the PostgreSQL driver
-DBDriver pgsql
-
-#Connection string: database name and login credentials
-DBDParams "dbname=htpasswd user=apache password=xxxxxx"
-
-#Parameters for Connection Pool Management
-DBDMin  1
-DBDKeep 2
-DBDMax  10
-DBDExptime 60
-
-#Authentication Section
-<Directory /usr/www/myhost/private>
-
-    #mod_auth configuration for authn_dbd
-    AuthType Basic
-    AuthName "My Server"
-    AuthBasicProvider dbd
-
-    #authz configuration
-    Require valid-user
-
-    #SQL query to verify a user
-    #(note: DBD drivers recognise both stdio-like %s and native syntax)
-    AuthDBDUserPWQuery "select password from authn where username = %s"
-</Directory>
-
    -     +# mod_dbd configuration +DBDriver pgsql +DBDParams "dbname=apacheauth user=apache password=xxxxxx" + +DBDMin 4 +DBDKeep 8 +DBDMax 20 +DBDExptime 300 + +<Directory /usr/www/myhost/private> + # mod_authn_core and mod_auth_basic configuration + # for mod_authn_dbd + AuthType Basic + AuthName "My Server" + AuthBasicProvider dbd + + # mod_authz_core configuration + Require valid-user + + # mod_authn_dbd SQL query to authenticate a user + AuthDBDUserPWQuery \ + "SELECT password FROM authn WHERE user = %s" +</Directory> +
    @@ -120,16 +113,22 @@ configuration required in some web applications.

    The AuthDBDUserPWQuery specifies an - SQL query to look up a password for a specified user. - The query must take a single string (typically SQL varchar) - argument (username), and return a single value (encrypted password). -

    - - AuthDBDUserPWQuery "SELECT password FROM authn WHERE username = %s" - -

    If httpd was built against apr v1.3.0 or higher, any additional - columns specified in the select statement will be inserted into - the environment with the name AUTHENTICATE_<COLUMN>. + SQL query to look up a password for a specified user. The user's ID + will be passed as a single string parameter when the SQL query is + executed. It may be referenced within the query statement using + a %s format specifier.

    + Example
    +AuthDBDUserPWQuery \
+  "SELECT password FROM authn WHERE user = %s"
+
     +

    The first column value of the first row returned by the query + statement should be a string containing the encrypted password. + Subsequent rows will be ignored. If no rows are returned, the user + will not be authenticated through mod_authn_dbd.

    +

    If httpd was built against APR version 1.3.0 + or higher, any additional column values in the first row returned by + the query statement will be stored as environment variables with + names of the form AUTHENTICATE_COLUMN.

    @@ -145,18 +144,22 @@ configuration required in some web applications.

    The AuthDBDUserRealmQuery specifies an SQL query to look up a password for a specified user and realm. - The query must take two string (typically SQL varchar) arguments - (username and realm), and return a single value (encrypted password). + The user's ID and the realm, in that order, will be passed as string + parameters when the SQL query is executed. They may be referenced + within the query statement using %s format specifiers.

    + Example
    +AuthDBDUserRealmQuery \
+  "SELECT password FROM authn WHERE user = %s AND realm = %s"
+
     +

    The first column value of the first row returned by the query + statement should be a string containing the encrypted password. + Subsequent rows will be ignored. If no rows are returned, the user + will not be authenticated through mod_authn_dbd.

    +

    If httpd was built against APR version 1.3.0 + or higher, any additional column values in the first row returned by + the query statement will be stored as environment variables with + names of the form AUTHENTICATE_COLUMN.

    - - AuthDBDUserRealmQuery "SELECT password FROM authn - WHERE username = %s AND realm = %s" - -

    If httpd was built against apr v1.3.0 or higher, any additional - columns specified in the select statement will be inserted into - the environment with the name AUTHENTICATE_<COLUMN>. -

    -     diff --git a/docs/manual/mod/mod_authz_dbd.html.en b/docs/manual/mod/mod_authz_dbd.html.en index bb71616001..2a39f07a3d 100644 --- a/docs/manual/mod/mod_authz_dbd.html.en +++ b/docs/manual/mod/mod_authz_dbd.html.en @@ -83,9 +83,9 @@ to start and end a client session.

    Configuration Example

    -
    
-# DBD Configuration
-DBDriver oracle
+
    +# mod_dbd configuration
+DBDriver pgsql
 DBDParams "dbname=apacheauth user=apache pass=xxxxxx"
 
 DBDMin  4
@@ -94,38 +94,49 @@ DBDMax  20
 DBDExptime 300
 
 <Directory /usr/www/my.site/team-private/>
-   # authn with mod_authn_dbd
-   AuthType Basic
-   AuthName Team
-   AuthBasicProvider dbd
-   AuthDBDUserPWQuery "SELECT pass FROM authn WHERE user = %s AND login = true"
-
-   # Require dbd-group and authz_dbd implementation
-   Require dbd-group team
-   AuthzDBDQuery "SELECT group FROM authz WHERE user = %s"
-
-   # When a user fails to authn/authz, invite them to login
-   ErrorDocument 401 /team-private/login-form.html
-
-   <Files login.html>
-      # Don't require that we're already logged in!
-      AuthDBDUserPWQuery "SELECT pass FROM authn WHERE user = %s"
-
-      # dbd-login action executes a query to set our own state
-      Require dbd-login
-      AuthzDBDQuery "UPDATE authn SET login = true WHERE user = %s"
-
-      # Return user to referring page (if any) on successful login
-      AuthzDBDLoginToReferer On
-   </Files>
-
-   <Files logout.html>
-      # dbd-logout action executes a query to set our own state
-      Require dbd-logout
-      AuthzDBDQuery "UPDATE authn SET login = false WHERE user = %s"
-   </Files>
+  # mod_authn_core and mod_auth_basic configuration
+  # for mod_authn_dbd
+  AuthType Basic
+  AuthName Team
+  AuthBasicProvider dbd
+
+  # mod_authn_dbd SQL query to authenticate a logged-in user
+  AuthDBDUserPWQuery \
+    "SELECT password FROM authn WHERE user = %s AND login = true"
+
+  # mod_authz_core configuration for mod_authz_dbd
+  Require dbd-group team
+
+  # mod_authz_dbd configuration
+  AuthzDBDQuery "SELECT group FROM authz WHERE user = %s"
+
+  # when a user fails to be authenticated or authorized,
+  # invite them to login
+  ErrorDocument 401 /team-private/login-form.html
+
+  <Files login.html>
+    # don't require user to already be logged in!
+    AuthDBDUserPWQuery \
+      "SELECT password FROM authn WHERE user = %s"
+
+    # dbd-login action executes a statement to log user in
+    Require dbd-login
+    AuthzDBDQuery \
+      "UPDATE authn SET login = true WHERE user = %s"
+
+    # return user to referring page (if any) after
+    # successful login
+    AuthzDBDLoginToReferer On
+  </Files>
+
+  <Files logout.html>
+    # dbd-logout action executes a statement to log user out
+    Require dbd-logout
+    AuthzDBDQuery \
+      "UPDATE authn SET login = false WHERE user = %s"
+  </Files>
 </Directory>
-
    
+
    top

    AuthzDBDLoginToReferer Directive

    @@ -151,7 +162,7 @@ header is present

    AuthzDBDQuery Directive

    - + @@ -161,37 +172,58 @@ header is presentRequire directive in effect.

      -
    • With Require dbd-group, it specifies a query - to look up groups for the current user. This is the standard - functionality of other authz modules such as +
    • When used with a Require dbd-group directive, + it specifies a query to look up groups for the current user. This is + the standard functionality of other authorization modules such as mod_authz_file and mod_authz_dbm. - In this case it will typically take the form
      - AuthzDBDQuery "SELECT group FROM groups WHERE user= %s" + The first column value of each row returned by the query statement + should be a string containing a group name. Zero, one, or more rows + may be returned. +

      Example

      +Require dbd-group
+AuthzDBDQuery \
+  "SELECT group FROM groups WHERE user = %s"
+
      • -
    • With Require dbd-login or Require dbd-logout, - it will never deny access, but will instead execute an SQL Query - designed to log the user (who must already be authenticated with - mod_authn_dbd) in or out. Such a query will - typically take the form
      - AuthzDBDQuery "UPDATE authn SET login = true WHERE user = %s" +
    • When used with a Require dbd-login or + Require dbd-logout directive, it will never deny access, + but will instead execute a SQL statement designed to log the user + in or out. The user must already be authenticated with + mod_authn_dbd. +

      Example

      +Require dbd-login
+AuthzDBDQuery \
+  "UPDATE authn SET login = true WHERE user = %s"
+
    +

    In all cases, the user's ID will be passed as a single string + parameter when the SQL query is executed. It may be referenced within + the query statement using a %s format specifier.

    top

    AuthzDBDRedirectQuery Directive

    Description:Specify the SQL Query for the required operation
    Syntax:AuthzDBDQuery SQL-Query
    Syntax:AuthzDBDQuery query
    Context:directory
    Status:Extension
    Module:mod_authz_dbd
    - +
    Description:Specify a query to look up a login page for the user
    Syntax:AuthzDBDRedirectQuery SQL-Query
    Syntax:AuthzDBDRedirectQuery query
    Context:directory
    Status:Extension
    Module:mod_authz_dbd
    -

    Specifies an optional query to use after successful login - (or logout) to redirect the user to a page, which may be - specific to the user. Such a query will take the form
    - AuthzDBDRedirectQuery "SELECT userpage FROM userpages WHERE user = %s" -

    +

    Specifies an optional SQL query to use after successful login + (or logout) to redirect the user to a URL, which may be + specific to the user. The user's ID will be passed as a single string + parameter when the SQL query is executed. It may be referenced within + the query statement using a %s format specifier.

    +

    Example

    +AuthzDBDRedirectQuery \
+  "SELECT userpage FROM userpages WHERE user = %s"
+
    +

    The first column value of the first row returned by the query + statement should be a string containing a URL to which to redirect + the client. Subsequent rows will be ignored. If no rows are returned, + the client will not be redirected.

    Note that AuthzDBDLoginToReferer takes precedence if both are set.

    diff --git a/docs/manual/mod/mod_authz_dbd.xml b/docs/manual/mod/mod_authz_dbd.xml index e6484279bb..f3e4bf03a8 100644 --- a/docs/manual/mod/mod_authz_dbd.xml +++ b/docs/manual/mod/mod_authz_dbd.xml @@ -69,9 +69,9 @@ to start and end a client session.

    Configuration Example -
    
-# DBD Configuration
-DBDriver oracle
+
    +# mod_dbd configuration
+DBDriver pgsql
 DBDParams "dbname=apacheauth user=apache pass=xxxxxx"
 
 DBDMin  4
@@ -80,45 +80,55 @@ DBDMax  20
 DBDExptime 300
 
 <Directory /usr/www/my.site/team-private/>
-   # authn with mod_authn_dbd
-   AuthType Basic
-   AuthName Team
-   AuthBasicProvider dbd
-   AuthDBDUserPWQuery "SELECT pass FROM authn WHERE user = %s AND login = true"
-
-   # Require dbd-group and authz_dbd implementation
-   Require dbd-group team
-   AuthzDBDQuery "SELECT group FROM authz WHERE user = %s"
-
-   # When a user fails to authn/authz, invite them to login
-   ErrorDocument 401 /team-private/login-form.html
-
-   <Files login.html>
-      # Don't require that we're already logged in!
-      AuthDBDUserPWQuery "SELECT pass FROM authn WHERE user = %s"
-
-      # dbd-login action executes a query to set our own state
-      Require dbd-login
-      AuthzDBDQuery "UPDATE authn SET login = true WHERE user = %s"
-
-      # Return user to referring page (if any) on successful login
-      AuthzDBDLoginToReferer On
-   </Files>
-
-   <Files logout.html>
-      # dbd-logout action executes a query to set our own state
-      Require dbd-logout
-      AuthzDBDQuery "UPDATE authn SET login = false WHERE user = %s"
-   </Files>
+  # mod_authn_core and mod_auth_basic configuration
+  # for mod_authn_dbd
+  AuthType Basic
+  AuthName Team
+  AuthBasicProvider dbd
+
+  # mod_authn_dbd SQL query to authenticate a logged-in user
+  AuthDBDUserPWQuery \
+    "SELECT password FROM authn WHERE user = %s AND login = true"
+
+  # mod_authz_core configuration for mod_authz_dbd
+  Require dbd-group team
+
+  # mod_authz_dbd configuration
+  AuthzDBDQuery "SELECT group FROM authz WHERE user = %s"
+
+  # when a user fails to be authenticated or authorized,
+  # invite them to login
+  ErrorDocument 401 /team-private/login-form.html
+
+  <Files login.html>
+    # don't require user to already be logged in!
+    AuthDBDUserPWQuery \
+      "SELECT password FROM authn WHERE user = %s"
+
+    # dbd-login action executes a statement to log user in
+    Require dbd-login
+    AuthzDBDQuery \
+      "UPDATE authn SET login = true WHERE user = %s"
+
+    # return user to referring page (if any) after
+    # successful login
+    AuthzDBDLoginToReferer On
+  </Files>
+
+  <Files logout.html>
+    # dbd-logout action executes a statement to log user out
+    Require dbd-logout
+    AuthzDBDQuery \
+      "UPDATE authn SET login = false WHERE user = %s"
+  </Files>
 </Directory>
-
    
-
+
    AuthzDBDQuery Specify the SQL Query for the required operation -AuthzDBDQuery SQL-Query +AuthzDBDQuery query directory @@ -127,36 +137,57 @@ DBDExptime 300 Require directive in effect.

      -
    • With Require dbd-group, it specifies a query - to look up groups for the current user. This is the standard - functionality of other authz modules such as +
    • When used with a Require dbd-group directive, + it specifies a query to look up groups for the current user. This is + the standard functionality of other authorization modules such as mod_authz_file and mod_authz_dbm. - In this case it will typically take the form
      - AuthzDBDQuery "SELECT group FROM groups WHERE user= %s" + The first column value of each row returned by the query statement + should be a string containing a group name. Zero, one, or more rows + may be returned. + Example
      +Require dbd-group
+AuthzDBDQuery \
+  "SELECT group FROM groups WHERE user = %s"
+
      • -
    • With Require dbd-login or Require dbd-logout, - it will never deny access, but will instead execute an SQL Query - designed to log the user (who must already be authenticated with - mod_authn_dbd) in or out. Such a query will - typically take the form
      - AuthzDBDQuery "UPDATE authn SET login = true WHERE user = %s" +
    • When used with a Require dbd-login or + Require dbd-logout directive, it will never deny access, + but will instead execute a SQL statement designed to log the user + in or out. The user must already be authenticated with + mod_authn_dbd. + Example
      +Require dbd-login
+AuthzDBDQuery \
+  "UPDATE authn SET login = true WHERE user = %s"
+
    +

    In all cases, the user's ID will be passed as a single string + parameter when the SQL query is executed. It may be referenced within + the query statement using a %s format specifier.

         AuthzDBDRedirectQuery Specify a query to look up a login page for the user -AuthzDBDRedirectQuery SQL-Query +AuthzDBDRedirectQuery query directory -

    Specifies an optional query to use after successful login - (or logout) to redirect the user to a page, which may be - specific to the user. Such a query will take the form
    - AuthzDBDRedirectQuery "SELECT userpage FROM userpages WHERE user = %s" -

    +

    Specifies an optional SQL query to use after successful login + (or logout) to redirect the user to a URL, which may be + specific to the user. The user's ID will be passed as a single string + parameter when the SQL query is executed. It may be referenced within + the query statement using a %s format specifier.

    + Example
    +AuthzDBDRedirectQuery \
+  "SELECT userpage FROM userpages WHERE user = %s"
+
     +

    The first column value of the first row returned by the query + statement should be a string containing a URL to which to redirect + the client. Subsequent rows will be ignored. If no rows are returned, + the client will not be redirected.

    Note that AuthzDBDLoginToReferer takes precedence if both are set.

     diff --git a/docs/manual/mod/mod_dbd.html.en b/docs/manual/mod/mod_dbd.html.en index f5843e4c88..5dc8828453 100644 --- a/docs/manual/mod/mod_dbd.html.en +++ b/docs/manual/mod/mod_dbd.html.en @@ -31,11 +31,14 @@

    Summary

    mod_dbd manages SQL database connections using - apr_dbd. - It provides database connections on request to modules - requiring SQL database functions, and takes care of + APR. It provides database connections on request + to modules requiring SQL database functions, and takes care of managing databases with optimal efficiency and scalability - for both threaded and non-threaded MPMs.

    + for both threaded and non-threaded MPMs. For details, see the + APR website and this overview of the + Apache DBD Framework + by its original developer. +

    Directives

      @@ -66,8 +69,9 @@ classic LAMP (Linux, Apache, Mysql, Perl/PHP/Python). On threaded platform, it provides an altogether more scalable and efficient connection pool, as - described in this article at ApacheTutor. mod_dbd supersedes - the modules presented in that article.

      + described in this + article at ApacheTutor. Note that mod_dbd + supersedes the modules presented in that article.

    top

    Apache DBD API

    diff --git a/docs/manual/mod/mod_dbd.xml b/docs/manual/mod/mod_dbd.xml index 758b553ddc..266b0fcbb7 100644 --- a/docs/manual/mod/mod_dbd.xml +++ b/docs/manual/mod/mod_dbd.xml @@ -31,11 +31,14 @@

    mod_dbd manages SQL database connections using - apr_dbd. - It provides database connections on request to modules - requiring SQL database functions, and takes care of + APR. It provides database connections on request + to modules requiring SQL database functions, and takes care of managing databases with optimal efficiency and scalability - for both threaded and non-threaded MPMs.

    + for both threaded and non-threaded MPMs. For details, see the + APR website and this overview of the + Apache DBD Framework + by its original developer. +

     Password Formats @@ -47,9 +50,9 @@ classic LAMP (Linux, Apache, Mysql, Perl/PHP/Python). On threaded platform, it provides an altogether more scalable and efficient connection pool, as - described in this article at ApacheTutor. mod_dbd supersedes - the modules presented in that article.

    + described in this + article at ApacheTutor. Note that mod_dbd + supersedes the modules presented in that article.

    Apache DBD API diff --git a/docs/manual/mod/mpm_common.html.en b/docs/manual/mod/mpm_common.html.en index edb7060781..25d040b057 100644 --- a/docs/manual/mod/mpm_common.html.en +++ b/docs/manual/mod/mpm_common.html.en @@ -32,6 +32,7 @@ more than one multi-processing module (MPM)

    Directives

    +
    +
    top
    +

    ChrootDir Directive

    + + + + + + + +
    Description:Directory for apache to run chroot(8) after startup.
    Syntax:ChrootDir /path/to/directory
    Default:none
    Context:server config
    Status:MPM
    Module:event, prefork, worker
    +

    This directive, available in httpd 2.2.9(?) and later, tells the + server to chroot(8) to the specified directory after + startup, but before accepting requests over the 'net.

    +

    Note that running the server under chroot is not simple, + and requires additional setup, particularly if you are running + scripts such as CGI or PHP. Please make sure you are properly + familiar with the operation of chroot before attempting to use + this feature.

    +
    top

    CoreDumpDirectory Directive

    diff --git a/docs/manual/mod/mpm_common.xml.de b/docs/manual/mod/mpm_common.xml.de index 22e235e028..25a71e15b4 100644 --- a/docs/manual/mod/mpm_common.xml.de +++ b/docs/manual/mod/mpm_common.xml.de @@ -1,7 +1,7 @@ - + +