diff --git a/source/configuration.rst b/source/configuration/index.rst similarity index 98% rename from source/configuration.rst rename to source/configuration/index.rst index 1e71a462..17fa53bb 100644 --- a/source/configuration.rst +++ b/source/configuration/index.rst @@ -2,7 +2,7 @@ :og:description: Create and maintain a working configuration using listeners, routes, apps, and upstreams. -.. include:: include/replace.rst +.. include:: ../include/replace.rst ############# Configuration @@ -2228,7 +2228,7 @@ affects the resulting response headers. The values support :ref:`variables ` and -:doc:`template literals `, +:doc:`template literals <../scripting>`, which enables arbitrary runtime logic: .. code-block:: json @@ -2441,7 +2441,7 @@ A **share**-based action provides the following options: `, the process runs as **unit:unit**; for details of other installation methods, - see :doc:`installation`. + see :doc:`../installation`. Consider the following configuration: @@ -3988,7 +3988,7 @@ and rebuild the app. # yum install unit-devel - If you installed Unit from - :doc:`source `, + :doc:`source <../howto/source>`, install the include files and libraries: .. code-block:: console @@ -4101,7 +4101,7 @@ Example: For Go-based examples, see our - :doc:`howto/grafana` + :doc:`../howto/grafana` howto or a basic :ref:`sample `. @@ -4191,10 +4191,10 @@ Example: For Java-based examples, see our - :doc:`howto/jira`, - :doc:`howto/opengrok`, + :doc:`../howto/jira`, + :doc:`../howto/opengrok`, and - :doc:`howto/springboot` + :doc:`../howto/springboot` howtos or a basic :ref:`sample `. @@ -4343,9 +4343,9 @@ your app only needs to replace the default **websocket**: For Node.js-based examples, see our - :doc:`howto/apollo`, - :doc:`howto/express`, - :doc:`howto/koa`, + :doc:`../howto/apollo`, + :doc:`../howto/express`, + :doc:`../howto/koa`, and :ref:`Docker ` howtos or a basic @@ -4412,9 +4412,9 @@ Example: For Perl-based examples of Perl, see our - :doc:`howto/bugzilla` + :doc:`../howto/bugzilla` and - :doc:`howto/catalyst` + :doc:`../howto/catalyst` howtos or a basic :ref:`sample `. @@ -4665,23 +4665,23 @@ are shared by all targets within the app. For PHP-based examples, see our - :doc:`howto/cakephp`, - :doc:`howto/codeigniter`, - :doc:`howto/dokuwiki`, - :doc:`howto/drupal`, - :doc:`howto/laravel`, - :doc:`howto/lumen`, - :doc:`howto/matomo`, - :doc:`howto/mediawiki`, - :doc:`howto/modx`, - :doc:`howto/nextcloud`, - :doc:`howto/phpbb`, - :doc:`howto/phpmyadmin`, - :doc:`howto/roundcube`, - :doc:`howto/symfony`, - :doc:`howto/wordpress`, + :doc:`../howto/cakephp`, + :doc:`../howto/codeigniter`, + :doc:`../howto/dokuwiki`, + :doc:`../howto/drupal`, + :doc:`../howto/laravel`, + :doc:`../howto/lumen`, + :doc:`../howto/matomo`, + :doc:`../howto/mediawiki`, + :doc:`../howto/modx`, + :doc:`../howto/nextcloud`, + :doc:`../howto/phpbb`, + :doc:`../howto/phpmyadmin`, + :doc:`../howto/roundcube`, + :doc:`../howto/symfony`, + :doc:`../howto/wordpress`, and - :doc:`howto/yii` + :doc:`../howto/yii` howtos or a basic :ref:`sample `. @@ -4972,27 +4972,27 @@ are shared by all targets in the app. For Python-based examples, see our - :doc:`howto/bottle`, - :doc:`howto/datasette`, - :doc:`howto/django`, - :doc:`howto/djangochannels`, - :doc:`howto/falcon`, - :doc:`howto/fastapi`, - :doc:`howto/flask`, - :doc:`howto/guillotina`, - :doc:`howto/mailman`, - :doc:`howto/mercurial`, - :doc:`howto/moin`, - :doc:`howto/plone`, - :doc:`howto/pyramid`, - :doc:`howto/quart`, - :doc:`howto/responder`, - :doc:`howto/reviewboard`, - :doc:`howto/sanic`, - :doc:`howto/starlette`, - :doc:`howto/trac`, + :doc:`../howto/bottle`, + :doc:`../howto/datasette`, + :doc:`../howto/django`, + :doc:`../howto/djangochannels`, + :doc:`../howto/falcon`, + :doc:`../howto/fastapi`, + :doc:`../howto/flask`, + :doc:`../howto/guillotina`, + :doc:`../howto/mailman`, + :doc:`../howto/mercurial`, + :doc:`../howto/moin`, + :doc:`../howto/plone`, + :doc:`../howto/pyramid`, + :doc:`../howto/quart`, + :doc:`../howto/responder`, + :doc:`../howto/reviewboard`, + :doc:`../howto/sanic`, + :doc:`../howto/starlette`, + :doc:`../howto/trac`, and - :doc:`howto/zope` + :doc:`../howto/zope` howtos or a basic :ref:`sample `. @@ -5110,9 +5110,9 @@ to your app. For Ruby-based examples, see our - :doc:`howto/rails` + :doc:`../howto/rails` and - :doc:`howto/redmine` + :doc:`../howto/redmine` howtos or a basic :ref:`sample `. @@ -5366,9 +5366,9 @@ that stores instance-wide preferences. - String or an array of strings; lists enabled :program:`njs` - :doc:`modules `, + :doc:`modules <../scripting>`, uploaded - via the :doc:`control API `. + via the :doc:`control API <../controlapi>`. In turn, the **http** option exposes the following settings: @@ -5591,7 +5591,7 @@ is formed *after* the request has been handled. Besides :ref:`built-in variables `, you can use :program:`njs` -:doc:`templates ` +:doc:`templates <../scripting>` to define the log format: .. code-block:: json diff --git a/source/contents.rst b/source/contents.rst index 5cc97b95..840d2fd6 100644 --- a/source/contents.rst +++ b/source/contents.rst @@ -6,11 +6,10 @@ news installation controlapi - configuration + configuration/index scripting certificates statusapi - unitctl howto/index troubleshooting community diff --git a/source/controlapi.rst b/source/controlapi.rst index bff7e37b..04b1d54f 100644 --- a/source/controlapi.rst +++ b/source/controlapi.rst @@ -28,7 +28,7 @@ that comprises four primary options: * - **/config** - Used for general - :doc:`configuration management `. + :doc:`configuration management `. * - **/control** - Queried for diff --git a/source/howto/security.rst b/source/howto/security.rst index 1351ef76..b706ae85 100644 --- a/source/howto/security.rst +++ b/source/howto/security.rst @@ -366,7 +366,7 @@ notorious **777**, instead assigning them on a need-to-know basis. # find :nxt_ph:`/path/to/app/ ` -type f -exec :nxt_hint:`chmod ` u=rx,g=rx,o= {} \; # find :nxt_ph:`/path/to/static/app/files/ ` -type f -exec :nxt_hint:`chmod ` u=r,g=r,o= {} \; - #. To run a single app, :doc:`configure <../configuration>` Unit as follows: + #. To run a single app, :doc:`configure <../configuration/index>` Unit as follows: .. code-block:: json @@ -397,7 +397,7 @@ notorious **777**, instead assigning them on a need-to-know basis. } } - #. To run several apps side by side, :doc:`configure <../configuration>` + #. To run several apps side by side, :doc:`configure <../configuration/index>` them with appropriate user and group names. The following configuration distinguishes apps based on the request URI, but you can implement another scheme such as different listeners: diff --git a/source/news/2019/unit-1.8.0-released.rst b/source/news/2019/unit-1.8.0-released.rst index 8a51eb65..28a57fe9 100644 --- a/source/news/2019/unit-1.8.0-released.rst +++ b/source/news/2019/unit-1.8.0-released.rst @@ -42,7 +42,7 @@ applications, and leave us feedback. If you're a Jira user, please use this HowTo: https://unit.nginx.org/howto/jira/ More documentation is available in :doc:`../../installation` and -:doc:`../../configuration` sections. +:doc:`../../configuration/index` sections. We intend to use our open-development process to refine and improve the software and to eventually test and certify the software's compatibility diff --git a/source/scripting.rst b/source/scripting.rst index 2ed2a961..6d5b6b6a 100644 --- a/source/scripting.rst +++ b/source/scripting.rst @@ -8,7 +8,7 @@ JavaScript expressions, including function calls, in the form of `__ written in `NGINX JavaScript `__ ( :program:`njs` ). -They can be used with these :doc:`configuration ` options: +They can be used with these :doc:`configuration ` options: - **pass** in :ref:`listeners `