diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 86f3b8ee7e72204c9efe9043b4a26e741f34e513..7cc71b4bbd1810a6eb5d32e839b524754cb1bdd3 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -959,13 +959,22 @@ 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). -**php_rewrite_url** (string, optional) - If implementing some form of clean URL schema, this parameter can be used for - defining how the clean URLs should be mapped onto actual PHP scripts. When - specifying this parameter, one special variable is available - ``$suburi`` - (which is the URI requested by HTTP client, usually in clean URL form). This - is in addition to any other variables provided out of the box by ``nginx`` - (like ``$args`` and such). +**index** (string, optional) + 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``. + +**php_file_regex** (string, optional) + Regular expression used for determining which file should be interepted via + PHP. Default is ``\.php$``. + +**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) A list of rewrite rules that are applied to incoming requests. Each element of @@ -996,7 +1005,7 @@ Here is an example configuration for setting-up a (base) PHP website (for runnin fqdn: cloud.example.com uid: 2001 admin: admin - php_rewrite_url: /index.php + php_file_regex: \.php($|/) rewrites: - ^/\.well-known/host-meta /public.php?service=host-meta - ^/\.well-known/host-meta\.json /public.php?service=host-meta-json