From 4c18f9f0e713717dae155ec9436873e05d1d6d7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Tue, 19 Sep 2023 09:39:28 +0200 Subject: [PATCH] Document router protection env var --- app/config/variables.php | 9 +++++++++ app/views/install/compose.phtml | 2 ++ tests/resources/docker/docker-compose.yml | 1 + 3 files changed, 12 insertions(+) diff --git a/app/config/variables.php b/app/config/variables.php index 5d8c0eaa2e..24d48432ca 100644 --- a/app/config/variables.php +++ b/app/config/variables.php @@ -43,6 +43,15 @@ return [ 'question' => '', 'filter' => '' ], + [ + 'name' => '_APP_OPTIONS_ROUTER_PROTECTION', + 'description' => 'Protects server from serving requests from unknown hostnames, and from serving Console for custom project domains. By default, set to \'disabled\'. To start router protection, set to \'enabled\'. It is recommended to enable this variable on production environment.', + 'introduction' => '1.4.4', + 'default' => 'disabled', + 'required' => false, + 'question' => '', + 'filter' => '' + ], [ 'name' => '_APP_OPENSSL_KEY_V1', 'description' => 'This is your server private secret key that is used to encrypt all sensitive data on your server. Appwrite server encrypts all secret data on your server like webhooks, HTTP passwords, user sessions, and storage files. The var is not set by default, if you wish to take advantage of Appwrite encryption capabilities you should change it and make sure to **keep it a secret and have a backup for it**.', diff --git a/app/views/install/compose.phtml b/app/views/install/compose.phtml index d59f97b9da..09afc9d96d 100644 --- a/app/views/install/compose.phtml +++ b/app/views/install/compose.phtml @@ -84,6 +84,7 @@ services: - _APP_SYSTEM_SECURITY_EMAIL_ADDRESS - _APP_SYSTEM_RESPONSE_FORMAT - _APP_OPTIONS_ABUSE + - _APP_OPTIONS_ROUTER_PROTECTION - _APP_OPTIONS_FORCE_HTTPS - _APP_OPENSSL_KEY_V1 - _APP_DOMAIN @@ -196,6 +197,7 @@ services: - _APP_ENV - _APP_WORKER_PER_CORE - _APP_OPTIONS_ABUSE + - _APP_OPTIONS_ROUTER_PROTECTION - _APP_OPENSSL_KEY_V1 - _APP_REDIS_HOST - _APP_REDIS_PORT diff --git a/tests/resources/docker/docker-compose.yml b/tests/resources/docker/docker-compose.yml index 3baae7316d..76eae3ab54 100644 --- a/tests/resources/docker/docker-compose.yml +++ b/tests/resources/docker/docker-compose.yml @@ -66,6 +66,7 @@ services: environment: - _APP_ENV - _APP_OPTIONS_ABUSE + - _APP_OPTIONS_ROUTER_PROTECTION - _APP_OPTIONS_FORCE_HTTPS - _APP_OPENSSL_KEY_V1 - _APP_DOMAIN