diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 0b515d1f427f5b4f1dcd6dc1c55bb670cd107813..e2e73e55fc4d56dbbfd663f7fb04ad3408f77de5 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1001,7 +1001,7 @@ Parameters user is capable of making modifications to website configuration and data stored within the website directory. -**deny_files_regex** (list, optional) +**deny_files_regex** (list, optional, ``[]``) List of regular expressions for matching files/locations to which the web server should deny access. This is useful to block access to any sensitive files that should not be served directly by the web server. The format must be @@ -1013,11 +1013,11 @@ Parameters for calculating the user/group name for dedicated website user, as well as home directory of the website user (where data/code should be stored at). -**index** (string, optional) +**index** (string, optional, ``index.php``) Space-separated list of files which should be treated as index files by the web server. The web server will attempt opening these index files, in succession, until the first match, or until it runs out of matches, when a - client requests an URI pointing to directory. Default is ``index.php``. + client requests an URI pointing to directory. **https_tls_certificate** (string, optional, ``{{ tls_certificate_dir }}/{{ fqdn }}_https.pem``) Path to file on Ansible host that contains the X.509 certificate used for TLS @@ -1027,24 +1027,24 @@ Parameters Path to file on Ansible host that contains the private key used for TLS for HTTPS service. The file will be copied to directory ``/etc/ssl/private/``. -**php_file_regex** (string, optional) +**php_file_regex** (string, optional, ``\.php$``) Regular expression used for determining which file should be interepted via - PHP. Default is ``\.php$``. + PHP. -**php_rewrite_urls** (list, optional) +**php_rewrite_urls** (list, optional, ``[]``) A list of rewrite rules that are applied to incoming requests. These rewrite rules are specifically targetted at prettying-up the URLs used by the PHP scripts. Each element of the list should be a string value compatible with the format of ``nginx`` option ``rewrite``. The keyword ``rewrite`` itself should be omitted, as well as trailing semi-colon (``;``). -**rewrites** (list, optional) +**rewrites** (list, optional, ``[]``) A list of rewrite rules that are applied to incoming requests. Each element of the list should be a string value compatible with the format of ``nginx`` option ``rewrite``. The keyword ``rewrite`` itself should be omitted, as well as trailing semi-colon (``;``). -**packages** (list, optional) +**packages** (list, optional, ``[]``) A list of additional packages to install for this particular PHP appliction. This is usually going to be different PHP extensions. @@ -1177,18 +1177,18 @@ Parameters Path to file on Ansible host that contains the private key used for TLS for HTTPS service. The file will be copied to directory ``/etc/ssl/private/``. -**packages** (list, optional) +**packages** (list, optional, ``[]``) A list of additional packages to install for this particular WSGI website. This is usually going to be development libraries for building Python packages. -**rewrites** (list, optional) +**rewrites** (list, optional, ``[]``) A list of rewrite rules that are applied to incoming requests. Each element of the list should be a string value compatible with the format of ``nginx`` option ``rewrite``. The keyword ``rewrite`` itself should be omitted, as well as trailing semi-colon (``;``). -**static_locations** (list, optional) +**static_locations** (list, optional, ``[]``) List of locations that should be treated as static-only, and not processed by the WSGI application at all. This is normally used for designating serving of static/media files by Nginx (for example, in case of Django projects for @@ -1198,13 +1198,13 @@ Parameters UID/GID (they are set-up to be the same) of the dedicated website user/group. -**use_paste** (boolean, optional) +**use_paste** (boolean, optional, ``False``) Tell Gunicorn to assume that the passed-in ``wsgi_application`` value is a filename of a Python Paste ``ini`` file instead of WSGI application. -**virtuaelnv_packages** (list, optional) - A list of additional packages to install for this particular PHP - appliction. This is usually going to be different PHP extensions. +**virtuaelnv_packages** (list, optional, ``[]``) + A list of additional packages to install for this particular WSGI appliction + in its virtual environment using ``pip``. **wsgi_application** (string, mandatory) WSGI application that should be started by Gunicorn. The format should be