From 79f492230be2c7c1e9673eae6c11ea9be2c864c0 Mon Sep 17 00:00:00 2001 From: Garvin Hicking Date: Mon, 4 Mar 2024 13:34:31 +0100 Subject: [PATCH] [TASK] Move "Production settings" to distinct section (#352) --- Documentation/Installation/DeployTYPO3.rst | 13 ------- .../Installation/EnvironmentConfiguration.rst | 36 +++++++++++++++++++ Documentation/Installation/Index.rst | 1 + 3 files changed, 37 insertions(+), 13 deletions(-) create mode 100644 Documentation/Installation/EnvironmentConfiguration.rst diff --git a/Documentation/Installation/DeployTYPO3.rst b/Documentation/Installation/DeployTYPO3.rst index cae838b9..e12b3a84 100644 --- a/Documentation/Installation/DeployTYPO3.rst +++ b/Documentation/Installation/DeployTYPO3.rst @@ -37,19 +37,6 @@ General Deployment Steps (e.g. ``{"platform": {"php": "7.4.10"}}``), so `composer` will always check the correct dependencies. -Production Settings -=================== - -To ensure a secure installation of TYPO3 on a production server, the following settings need to be set: - -- :guilabel:`Admin Tools > Settings > Configuration Presets` The "Live" preset has to be chosen to make sure no debug output is displayed. -- `HTTPS` should be used on production servers and :php:`$GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL']` should be set to `true`. -- Enforce HSTS (Strict-Transport-Security header) in the web servers configuration. -- The `TYPO3_CONTEXT` environment variable should be set to a main context of `Production` (can be verified on the top right in the TYPO3 backend :guilabel:`Application Information`). It should be used to select the appropriate `base variant` for the target system in the Site Configuration. -- Configure the :ref:`TYPO3 logging framework ` to log messages of high severity including and above WARNING or ERROR - and continue to rotate log files stored in :file:`var/log`. -- Verify the :ref:`file permissions ` are correct on the live system. - Deployment Automation ===================== diff --git a/Documentation/Installation/EnvironmentConfiguration.rst b/Documentation/Installation/EnvironmentConfiguration.rst new file mode 100644 index 00000000..470df53f --- /dev/null +++ b/Documentation/Installation/EnvironmentConfiguration.rst @@ -0,0 +1,36 @@ +.. include:: /Includes.rst.txt + +.. index:: Environment; Configuration; .env ; dotenv + +.. _legacyinstallation: + +======================== +Configuring environments +======================== + +.. todo: Enhancements + * .env / dotenv (with loaders, also helhum/dotenv-connector) + * AdditionalConfiguration specifics + * debug settings / presets + * PasswordPolicies + * Mail settings + * EncryptionKey/InstallPassword + * Error handling + * Additional service keys (Redis, API, ...) + * SiteConfiguration (via siteVariants, link to that chapter) + * what to version (link to "versioning") + * Rephrase "Production Settings" section + + +Production Settings +=================== + +To ensure a secure installation of TYPO3 on a production server, the following settings need to be set: + +- :guilabel:`Admin Tools > Settings > Configuration Presets` The "Live" preset has to be chosen to make sure no debug output is displayed. +- `HTTPS` should be used on production servers and :php:`$GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL']` should be set to `true`. +- Enforce HSTS (Strict-Transport-Security header) in the web servers configuration. +- The `TYPO3_CONTEXT` environment variable should be set to a main context of `Production` (can be verified on the top right in the TYPO3 backend :guilabel:`Application Information`). It should be used to select the appropriate `base variant` for the target system in the Site Configuration. +- Configure the :ref:`TYPO3 logging framework ` to log messages of high severity including and above WARNING or ERROR + and continue to rotate log files stored in :file:`var/log`. +- Verify the :ref:`file permissions ` are correct on the live system. diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst index 0378b807..5a66f2ac 100644 --- a/Documentation/Installation/Index.rst +++ b/Documentation/Installation/Index.rst @@ -96,6 +96,7 @@ Installation Install TutorialDdev + EnvironmentConfiguration TuneTYPO3 DeployTYPO3 LegacyInstallation