Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 12.4] [TASK] Move "Production settings" to distinct section #353

Merged
merged 1 commit into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions Documentation/Installation/DeployTYPO3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,6 @@ General Deployment Steps
(e.g. ``{"platform": {"php": "8.1"}}``), 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 <t3coreapi:logging-configuration>` 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 <t3coreapi:security-file-directory-permissions>` are correct on the live system.

Deployment Automation
=====================

Expand Down
36 changes: 36 additions & 0 deletions Documentation/Installation/EnvironmentConfiguration.rst
Original file line number Diff line number Diff line change
@@ -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 <t3coreapi:logging-configuration>` 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 <t3coreapi:security-file-directory-permissions>` are correct on the live system.
1 change: 1 addition & 0 deletions Documentation/Installation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Installation

Install
TutorialDdev
EnvironmentConfiguration
TuneTYPO3
DeployTYPO3
LegacyInstallation
Loading