diff --git a/docker/README.md b/docker/README.md index 199dc6e2..561bdba0 100644 --- a/docker/README.md +++ b/docker/README.md @@ -174,6 +174,8 @@ This is the complete list of supported env vars: * `MERCURE_INTERNAL_HUB_URL`: An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided but `MERCURE_PUBLIC_HUB_URL` was, the former one will be used to publish updates. * `MERCURE_JWT_SECRET`: The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server. * `ANONYMIZE_REMOTE_ADDR`: Tells if IP addresses from visitors should be obfuscated before storing them in the database. Default value is `true`. **Careful!** Setting this to `false` will make your Shlink instance no longer be in compliance with the GDPR and other similar data protection regulations. +* `REDIRECT_STATUS_CODE`: Either **301** or **302**. Used to determine if redirects from short to long URLs should be used with a 301 or 302 status. Defaults to 302. +* `REDIRECT_CACHE_LIFETIME`: Allows to set the amount of seconds that redirects should be cached when redirect status is 301. Default values is 30. An example using all env vars could look like this: @@ -206,6 +208,8 @@ docker run \ -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local" \ -e MERCURE_JWT_SECRET=super_secret_key \ -e ANONYMIZE_REMOTE_ADDR=false \ + -e REDIRECT_STATUS_CODE=301 \ + -e REDIRECT_CACHE_LIFETIME=90 \ shlinkio/shlink:stable ``` @@ -251,7 +255,9 @@ The whole configuration should have this format, but it can be split into multip "mercure_public_hub_url": "https://example.com", "mercure_internal_hub_url": "http://my-mercure-hub.prod.svc.cluster.local", "mercure_jwt_secret": "super_secret_key", - "anonymize_remote_addr": false + "anonymize_remote_addr": false, + "redirect_status_code": 301, + "redirect_cache_lifetime": 90 } ``` diff --git a/docker/config/shlink_in_docker.local.php b/docker/config/shlink_in_docker.local.php index b870ccd7..8d3c55fa 100644 --- a/docker/config/shlink_in_docker.local.php +++ b/docker/config/shlink_in_docker.local.php @@ -11,6 +11,9 @@ use function explode; use function Functional\contains; use function Shlinkio\Shlink\Common\env; +use const Shlinkio\Shlink\Core\DEFAULT_DELETE_SHORT_URL_THRESHOLD; +use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME; +use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE; use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH; use const Shlinkio\Shlink\Core\MIN_SHORT_CODES_LENGTH; @@ -104,7 +107,7 @@ return [ 'delete_short_urls' => [ 'check_visits_threshold' => true, - 'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', 15), + 'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD), ], 'entity_manager' => [ @@ -120,6 +123,8 @@ return [ 'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true), 'visits_webhooks' => $helper->getVisitsWebhooks(), 'default_short_codes_length' => $helper->getDefaultShortCodesLength(), + 'redirect_status_code' => (int) env('REDIRECT_STATUS_CODE', DEFAULT_REDIRECT_STATUS_CODE), + 'redirect_cache_lifetime' => (int) env('REDIRECT_CACHE_LIFETIME', DEFAULT_REDIRECT_CACHE_LIFETIME), ], 'not_found_redirects' => $helper->getNotFoundRedirectsConfig(), diff --git a/module/Core/functions/functions.php b/module/Core/functions/functions.php index 1fac0bd5..deea5f5f 100644 --- a/module/Core/functions/functions.php +++ b/module/Core/functions/functions.php @@ -11,6 +11,7 @@ use PUGX\Shortid\Factory as ShortIdFactory; use function sprintf; +const DEFAULT_DELETE_SHORT_URL_THRESHOLD = 15; const DEFAULT_SHORT_CODES_LENGTH = 5; const MIN_SHORT_CODES_LENGTH = 4; const DEFAULT_REDIRECT_STATUS_CODE = StatusCodeInterface::STATUS_FOUND; diff --git a/module/Core/src/Config/SimplifiedConfigParser.php b/module/Core/src/Config/SimplifiedConfigParser.php index 81f05d14..38fbdea3 100644 --- a/module/Core/src/Config/SimplifiedConfigParser.php +++ b/module/Core/src/Config/SimplifiedConfigParser.php @@ -38,6 +38,8 @@ class SimplifiedConfigParser 'mercure_internal_hub_url' => ['mercure', 'internal_hub_url'], 'mercure_jwt_secret' => ['mercure', 'jwt_secret'], 'anonymize_remote_addr' => ['url_shortener', 'anonymize_remote_addr'], + 'redirect_status_code' => ['url_shortener', 'redirect_status_code'], + 'redirect_cache_lifetime' => ['url_shortener', 'redirect_cache_lifetime'], ]; private const SIMPLIFIED_CONFIG_SIDE_EFFECTS = [ 'delete_short_url_threshold' => [ diff --git a/module/Core/src/Options/DeleteShortUrlsOptions.php b/module/Core/src/Options/DeleteShortUrlsOptions.php index ee7d9dee..9fa7fcf0 100644 --- a/module/Core/src/Options/DeleteShortUrlsOptions.php +++ b/module/Core/src/Options/DeleteShortUrlsOptions.php @@ -6,9 +6,11 @@ namespace Shlinkio\Shlink\Core\Options; use Laminas\Stdlib\AbstractOptions; +use const Shlinkio\Shlink\Core\DEFAULT_DELETE_SHORT_URL_THRESHOLD; + class DeleteShortUrlsOptions extends AbstractOptions { - private int $visitsThreshold = 15; + private int $visitsThreshold = DEFAULT_DELETE_SHORT_URL_THRESHOLD; private bool $checkVisitsThreshold = true; public function getVisitsThreshold(): int diff --git a/module/Core/test/Config/SimplifiedConfigParserTest.php b/module/Core/test/Config/SimplifiedConfigParserTest.php index 3700b042..9d4bca69 100644 --- a/module/Core/test/Config/SimplifiedConfigParserTest.php +++ b/module/Core/test/Config/SimplifiedConfigParserTest.php @@ -65,6 +65,8 @@ class SimplifiedConfigParserTest extends TestCase 'mercure_internal_hub_url' => 'internal_url', 'mercure_jwt_secret' => 'super_secret_value', 'anonymize_remote_addr' => false, + 'redirect_status_code' => 301, + 'redirect_cache_lifetime' => 90, ]; $expected = [ 'app_options' => [ @@ -94,6 +96,8 @@ class SimplifiedConfigParserTest extends TestCase ], 'default_short_codes_length' => 8, 'anonymize_remote_addr' => false, + 'redirect_status_code' => 301, + 'redirect_cache_lifetime' => 90, ], 'delete_short_urls' => [