Fix env var names in docs

This commit is contained in:
cytopia 2022-12-23 21:07:34 +01:00
parent e3b7c2d4db
commit 6fa03e6961
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
4 changed files with 15 additions and 15 deletions

View File

@ -76,7 +76,7 @@ jobs:
cd "${GITHUB_WORKSPACE}/.tests/" cd "${GITHUB_WORKSPACE}/.tests/"
# Test full customization # Test full customization
make configure KEY=DEBUG_COMPOSE_ENTRYPOINT VAL="$(( RANDOM % 3 ))" make configure KEY=DEBUG_ENTRYPOINT VAL="$(( RANDOM % 3 ))"
make configure KEY=DOCKER_LOGS VAL="$(( RANDOM % 1 ))" make configure KEY=DOCKER_LOGS VAL="$(( RANDOM % 1 ))"
make configure KEY=TLD_SUFFIX VAL=loc2 make configure KEY=TLD_SUFFIX VAL=loc2
make configure KEY=TIMEZONE VAL='Europe/Berlin' make configure KEY=TIMEZONE VAL='Europe/Berlin'

View File

@ -51,7 +51,7 @@ pull: ../.env
### ###
start: ../.env start: ../.env
@$(MAKE) --no-print-directory configure KEY=HOST_PATH_HTTPD_DATADIR VAL=.tests/www @$(MAKE) --no-print-directory configure KEY=HOST_PATH_HTTPD_DATADIR VAL=.tests/www
@$(MAKE) --no-print-directory configure KEY=DEBUG_COMPOSE_ENTRYPOINT VAL=2 @$(MAKE) --no-print-directory configure KEY=DEBUG_ENTRYPOINT VAL=3
@$(MAKE) --no-print-directory configure KEY=NEW_UID VAL=$$(id -u) @$(MAKE) --no-print-directory configure KEY=NEW_UID VAL=$$(id -u)
@$(MAKE) --no-print-directory configure KEY=NEW_GID VAL=$$(id -g) @$(MAKE) --no-print-directory configure KEY=NEW_GID VAL=$$(id -g)
@$(PWD)/scripts/compose-start.sh @$(PWD)/scripts/compose-start.sh

View File

@ -67,7 +67,7 @@ First you simply copy the while definition of the bind service from ``docker-com
## ##
## Debug? ## Debug?
## ##
- DEBUG_ENTRYPOINT=${DEBUG_COMPOSE_ENTRYPOINT} - DEBUG_ENTRYPOINT=${DEBUG_ENTRYPOINT}
- DOCKER_LOGS=1 - DOCKER_LOGS=1
## ##

View File

@ -32,18 +32,18 @@ to ``.env`` to initially create it with sane defaults.
Core settings Core settings
============= =============
DEBUG_COMPOSE_ENTRYPOINT DEBUG_ENTRYPOINT
------------------------ ----------------
This variable controls the docker-compose log verbosity during service startup. This variable controls the docker-compose log verbosity during service startup.
When set to ``1`` verbose output as well as executed commands are shown. When set to ``1`` verbose output as well as executed commands are shown.
When set to ``0`` only warnings and errors are shown. When set to ``0`` only warnings and errors are shown.
+------------------------------+----------------+---------------+ +------------------------------+-----------------------------------+---------------+
| Name | Allowed values | Default value | | Name | Allowed values | Default value |
+==============================+================+===============+ +==============================+===================================+===============+
| ``DEBUG_COMPOSE_ENTRYPOINT`` | ``0`` or ``1`` | ``1`` | | ``DEBUG_ENTRYPOINT`` | ``0``, ``1``, ``2``, ``3``, ``4`` | ``2`` |
+------------------------------+----------------+---------------+ +------------------------------+-----------------------------------+---------------+
.. _env_docker_logs: .. _env_docker_logs:
@ -1505,8 +1505,8 @@ changing the server name or adding locations to other assets.
.. _env_httpd_timeout_to_php_fpm: .. _env_httpd_timeout_to_php_fpm:
HTTPD_TIMEOUT_TO_PHP_FPM HTTPD_BACKEND_TIMEOUT
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
This variable specifies after how many seconds the webserver should quit an unanswered connection This variable specifies after how many seconds the webserver should quit an unanswered connection
to PHP-FPM. to PHP-FPM.
@ -1515,17 +1515,17 @@ Ensure that this value is higher than PHP's ``max_execution_time``, otherwise th
could still run and the webserver will simply drop the connection before getting an answer could still run and the webserver will simply drop the connection before getting an answer
by PHP. by PHP.
If ``HTTPD_TIMEOUT_TO_PHP_FPM`` is smaller then ``max_execution_time`` and a script runs longer If ``HTTPD_BACKEND_TIMEOUT`` is smaller then ``max_execution_time`` and a script runs longer
than ``max_execution_time``, you will get a: ``504 Gateway timeout`` in the browser. than ``max_execution_time``, you will get a: ``504 Gateway timeout`` in the browser.
If ``HTTPD_TIMEOUT_TO_PHP_FPM`` is greater then ``max_execution_time`` and a script runs longer If ``HTTPD_BACKEND_TIMEOUT`` is greater then ``max_execution_time`` and a script runs longer
than ``max_execution_time``, you will get a proper PHP error message in the browser. than ``max_execution_time``, you will get a proper PHP error message in the browser.
+------------------------------+-------------------+------------------+ +------------------------------+-------------------+------------------+
| Name | Allowed values | Default value | | Name | Allowed values | Default value |
+==============================+===================+==================+ +==============================+===================+==================+
| ``HTTPD_TIMEOUT_TO_PHP_FPM`` | positive integer | ``180`` | | ``HTTPD_BACKEND_TIMEOUT`` | positive integer | ``180`` |
+------------------------------+-------------------+------------------+ +------------------------------+-------------------+------------------+
HTTPD_NGINX_WORKER_PROCESSES HTTPD_NGINX_WORKER_PROCESSES