Merge pull request #2481 from shlinkio/develop

Release 4.5.2

.dockerignore

@@ -0,0 +1,26 @@
+bin/rr
+config/autoload/*local*
+config/params/shlink_dev_env.*
+data/infra
+data/cache/*
+data/log/*
+data/locks/*
+data/proxies/*
+data/migrations_template.txt
+data/GeoLite2-City*
+data/database.sqlite
+data/shlink-tests.db
+CHANGELOG.md
+CONTRIBUTING.md
+UPGRADE.md
+composer.lock
+vendor
+docs
+indocker
+docker-*
+phpstan.neon
+php*xml*
+**/test*
+build*
+**/.*
+!config/roadrunner/.rr.yml

.env.dist

@@ -1,15 +0,0 @@
-# Application
-APP_ENV=
-SECRET_KEY=
-SHORTENED_URL_SCHEMA=
-SHORTENED_URL_HOSTNAME=
-SHORTCODE_CHARS=
-
-# Language
-DEFAULT_LOCALE=
-CLI_LOCALE=
-
-# Database
-DB_USER=
-DB_PASSWORD=
-DB_NAME=

.gitattributes

@@ -0,0 +1,22 @@
+/config/test export-ignore
+/data/infra export-ignore
+/docs export-ignore
+/module/CLI/test export-ignore
+/module/CLI/test-resources export-ignore
+/module/Core/test export-ignore
+/module/Core/test-db export-ignore
+/module/Rest/test export-ignore
+/module/Rest/test-api export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.phpstorm.meta.php export-ignore
+.travis.yml export-ignore
+build.sh export-ignore
+CHANGELOG.md export-ignore
+docker-compose.yml export-ignore
+indocker export-ignore
+phpcs.xml export-ignore
+phpunit.xml.dist export-ignore
+phpunit-api.xml export-ignore
+phpunit-db.xml export-ignore
+phpstan.neon

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: ['acelaya']
+custom: ['https://slnk.to/donate']

.github/ISSUE_TEMPLATE/Bug.yml

@@ -0,0 +1,71 @@
+name: Bug report
+description: Something on Shlink is broken or not working as documented?
+labels: ['bug']
+body:
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Shlink version
+      placeholder: x.y.z
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: PHP version
+      placeholder: x.y.z
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: How do you serve Shlink
+      options:
+        - Self-hosted Apache
+        - Self-hosted nginx
+        - Self-hosted RoadRunner
+        - Docker image
+        - Other (explain in summary)
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: Database engine
+      options:
+        - MySQL
+        - MariaDB
+        - PostgreSQL
+        - MicrosoftSQL
+        - SQLite
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Database version
+      placeholder: x.y.z
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Current behavior
+      value: '<!-- How is it actually behaving (and it should not)? -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Expected behavior
+      value: '<!-- How did you expect it to behave? -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Minimum steps to reproduce
+      value: |
+        <!--
+        Simple but detailed way to reproduce the bug:
+        
+        * Avoid things like "create a kubernetes cluster", or anything related with cloud providers, as that is rarely the root cause.
+        * Avoid too vague steps or one-liners like "Update from v1 to v2".
+        * Providing the reproduction in the form of a self-contained docker-composer is desirable. 
+        
+        Failing in any of these will cause the issue to be closed as "not reproducible".
+        -->

.github/ISSUE_TEMPLATE/Feature_Request.yml

@@ -0,0 +1,16 @@
+name: Feature request
+description: Do you find Shlink is missing some important feature that would make it more useful?
+labels: ['feature']
+body:
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Summary
+      value: '<!-- Describe the new feature you would like to request. -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Use case
+      value: '<!-- Explain why do you think this feature would be useful, and what problems would it help to solve. -->'

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question - Support
+    about: Do you need help setting up or using Shlink?
+    url: https://github.com/orgs/shlinkio/discussions/new?category=help-wanted

.github/actions/ci-setup/action.yml

@@ -0,0 +1,47 @@
+name: CI setup
+description: 'Sets up the environment to run CI actions for Shlink'
+
+inputs:
+  install-deps:
+    description: 'Tells if dependencies should be installed with composer. Default value is "yes"'
+    required: true
+    default: 'yes'
+  php-version:
+    description: 'The PHP version to be setup'
+    required: true
+  php-extensions:
+    description: 'The PHP extensions to install'
+    required: false
+  extensions-cache-key:
+    description: 'The key used to cache PHP extensions. If empty value is provided, extension caching is disabled'
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Setup cache environment
+      if: ${{ inputs.php-extensions }}
+      id: extcache
+      uses: shivammathur/cache-extensions@v1
+      with:
+        php-version: ${{ inputs.php-version }}
+        extensions: ${{ inputs.php-extensions }}
+        key: ${{ inputs.extensions-cache-key }}
+    - name: Cache extensions
+      if: ${{ inputs.php-extensions }}
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.extcache.outputs.dir }}
+        key: ${{ steps.extcache.outputs.key }}
+        restore-keys: ${{ steps.extcache.outputs.key }}
+    - name: Use PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ inputs.php-version }}
+        tools: composer
+        extensions: ${{ inputs.php-extensions }}
+        coverage: xdebug
+    - name: Install dependencies
+      if: ${{ inputs.install-deps == 'yes' }}
+      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.5' && '--ignore-platform-req=php' || '' }}
+      shell: bash

.github/workflows/ci-db-tests.yml

@@ -0,0 +1,45 @@
+name: Database tests
+
+on:
+  workflow_call:
+    inputs:
+      platform:
+        type: string
+        required: true
+        description: One of sqlite:ci, mysql, maria, postgres or ms
+
+jobs:
+  db-tests:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3', '8.4', '8.5']
+    continue-on-error: ${{ matrix.php-version == '8.5' }}
+    env:
+      LC_ALL: C
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install MSSQL ODBC
+        if: ${{ inputs.platform == 'ms' }}
+        run: sudo ./data/infra/ci/install-ms-odbc.sh
+      - name: Start database server
+        if: ${{ inputs.platform != 'sqlite:ci' }}
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_${{ inputs.platform }}
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          php-extensions: pdo_sqlsrv-5.12.0
+          extensions-cache-key: db-tests-extensions-${{ matrix.php-version }}-${{ inputs.platform }}
+      - name: Create test database
+        if: ${{ inputs.platform == 'ms' }}
+        run: docker compose exec -T shlink_db_ms /opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
+      - name: Run tests
+        run: composer test:db:${{ inputs.platform }}
+      - name: Upload code coverage
+        uses: actions/upload-artifact@v4
+        if: ${{ matrix.php-version == '8.3' && inputs.platform == 'sqlite:ci' }}
+        with:
+          name: coverage-db
+          path: |
+            build/coverage-db
+            build/coverage-db.cov

.github/workflows/ci-docker-image-build.yml

@@ -0,0 +1,12 @@
+name: Test docker image build
+
+on:
+  pull_request:
+    paths:
+      - 'Dockerfile'
+
+jobs:
+  build-docker-image:
+    uses: shlinkio/github-actions/.github/workflows/docker-image-build-ci.yml@main
+    with:
+      platforms: 'linux/arm64/v8,linux/amd64'

.github/workflows/ci-tests.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  workflow_call:
+    inputs:
+      test-group:
+        type: string
+        required: true
+        description: One of unit, api or cli
+
+jobs:
+  tests:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3', '8.4', '8.5']
+    continue-on-error: ${{ matrix.php-version == '8.5' }}
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
+    steps:
+      - uses: actions/checkout@v4
+      - name: Start postgres database server
+        if: ${{ inputs.test-group == 'api' }}
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
+      - name: Start maria database server
+        if: ${{ inputs.test-group == 'cli' }}
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
+      - name: Download RoadRunner binary
+        if: ${{ inputs.test-group == 'api' }}
+        run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
+      - run: composer test:${{ inputs.test-group }}:ci
+      - uses: actions/upload-artifact@v4
+        if: ${{ matrix.php-version == '8.3' }}
+        with:
+          name: coverage-${{ inputs.test-group }}
+          path: |
+            build/coverage-${{ inputs.test-group }}
+            build/coverage-${{ inputs.test-group }}.cov

.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+name: Continuous integration
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.neon'
+  push:
+    branches:
+      - main
+      - develop
+      - 2.x
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.neon'
+
+jobs:
+  static-analysis:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3']
+        command: ['cs', 'stan', 'openapi:validate']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ matrix.command }}
+      - run: composer ${{ matrix.command }}
+
+  unit-tests:
+    uses: './.github/workflows/ci-tests.yml'
+    with:
+      test-group: unit
+
+  cli-tests:
+    uses: './.github/workflows/ci-tests.yml'
+    with:
+      test-group: cli
+
+  api-tests:
+    uses: './.github/workflows/ci-tests.yml'
+    with:
+      test-group: api
+
+  db-tests:
+    strategy:
+      matrix:
+        platform: ['sqlite:ci', 'mysql', 'maria', 'postgres', 'ms']
+    uses: './.github/workflows/ci-db-tests.yml'
+    with:
+      platform: ${{ matrix.platform }}
+
+  upload-coverage:
+    needs:
+      - unit-tests
+      - api-tests
+      - cli-tests
+      - db-tests
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use PHP
+        uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}
+      - uses: actions/download-artifact@v4
+        with:
+          path: build
+      - run: mv build/coverage-unit/coverage-unit.cov build/coverage-unit.cov
+      - run: mv build/coverage-db/coverage-db.cov build/coverage-db.cov
+      - run: mv build/coverage-api/coverage-api.cov build/coverage-api.cov
+      - run: mv build/coverage-cli/coverage-cli.cov build/coverage-cli.cov
+      - run: vendor/bin/phpcov merge build --clover build/clover.xml
+      - name: Publish coverage
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./build/clover.xml
+
+  delete-artifacts:
+    needs:
+      - upload-coverage
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: geekyeggo/delete-artifact@v5
+        with:
+          name: |
+            coverage-*

.github/workflows/publish-docker-image.yml

@@ -0,0 +1,26 @@
+name: Build and publish docker image
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-image:
+    strategy:
+      matrix:
+        include:
+          - runtime: 'rr'
+            platforms: 'linux/arm64/v8,linux/amd64'
+          - runtime: 'rr'
+            tag-suffix: 'roadrunner'
+            platforms: 'linux/arm64/v8,linux/amd64'
+    uses: shlinkio/github-actions/.github/workflows/docker-publish-image.yml@main
+    secrets: inherit
+    with:
+      image-name: shlinkio/shlink
+      version-arg-name: SHLINK_VERSION
+      platforms: ${{ matrix.platforms }}
+      tags-suffix: ${{ matrix.tag-suffix }}
+      extra-build-args: |
+        SHLINK_RUNTIME=${{ matrix.runtime }}

.github/workflows/publish-openapi-spec.yml

@@ -0,0 +1,35 @@
+name: Publish openapi spec
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Determine version
+        id: determine_version
+        run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+        shell: bash
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions-cache-key: publish-openapi-spec-extensions-${{ matrix.php-version }}
+      - run: composer openapi:inline
+      - run: mkdir ${{ steps.determine_version.outputs.version }}
+      - run: mv docs/swagger/openapi-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json
+      - name: Publish spec
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          token: ${{ secrets.OAS_PUBLISH_TOKEN }}
+          repository-name: 'shlinkio/shlink-open-api-specs'
+          branch: main
+          folder: ${{ steps.determine_version.outputs.version }}
+          target-folder: specs/${{ steps.determine_version.outputs.version }}
+          clean: false

.github/workflows/publish-release.yml

@@ -0,0 +1,50 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        php-version: ['8.3', '8.4']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
+          install-deps: 'no'
+      - run: ./build.sh ${GITHUB_REF#refs/tags/v}
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-files-${{ matrix.php-version }}
+          path: build
+
+  publish:
+    needs: ['build']
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          path: build
+      - name: Publish release with assets
+        uses: docker://antonyurchenko/git-release:latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ALLOW_EMPTY_CHANGELOG: "true"
+        with:
+          args: |
+            build/*/shlink*_dist.zip
+
+  delete-artifacts:
+    needs: ['publish']
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: geekyeggo/delete-artifact@v5
+        with:
+          name: dist-files-*

.gitignore

@@ -1,5 +1,15 @@
 .idea
+bin/rr
+.pid
 build
+!docker/build
 composer.lock
+composer.phar
 vendor/
-.env
+data/database.sqlite
+data/shlink-tests.db
+data/GeoLite2-City.*
+data/infra/matomo
+docs/mercure.html
+.phpunit.result.cache
+docs/swagger/openapi-inlined.json

.phpstorm.meta.php

@@ -1,7 +1,8 @@
 <?php
 namespace PHPSTORM_META;
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
+use Laminas\ServiceManager\ServiceLocatorInterface;
 
 /**
  * PhpStorm Container Interop code completion
@@ -16,4 +17,7 @@ $STATIC_METHOD_TYPES = [
     ContainerInterface::get('') => [
         '' == '@',
     ],
+    ServiceLocatorInterface::build('') => [
+        '' == '@',
+    ],
 ];

.scrutinizer.yml

@@ -1,6 +0,0 @@
-tools:
-  external_code_coverage: true
-checks:
-    php:
-        code_rating: true
-        duplication: true

.travis-php.ini

@@ -1 +0,0 @@
-extension="memcached.so"

.travis.yml

@@ -1,27 +0,0 @@
-language: php
-
-branches:
-  only:
-    - master
-    - develop
-
-php:
-  - 5.6
-  - 7
-  - 7.1
-
-before_install: phpenv config-add .travis-php.ini
-
-before_script:
-  - composer self-update
-  - composer install --no-interaction
-
-script:
-  - mkdir build
-  - composer check
-
-after_script:
-  - wget https://scrutinizer-ci.com/ocular.phar
-  - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
-
-sudo: false

CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# Contributing
+
+This file will guide you through the process of getting to project up and running, in case you want to provide coding contributions.
+
+You will also see how to ensure the code fulfills the expected code checks, and how to create a pull request.
+
+## System dependencies
+
+The project provides all its dependencies as docker containers through a `docker compose` configuration.
+
+Because of this, the only actual dependencies are [docker](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/install/).
+
+## Setting up the project
+
+The first thing you need to do is fork the repository, and clone it in your local machine.
+
+Then you will have to follow these steps:
+
+* Copy the `config/params/shlink_dev_env.php.dist` in the same directory, but removing the `.dist` extension:
+
+    ```
+    cp config/params/shlink_dev_env.php.dist config/params/shlink_dev_env.php
+    ```
+
+    The `shlink_dev_env.php` file is gitignored, so you can customize it as you want. For example, by adding your own GeoLite license key.
+
+* Start-up the project by running `docker compose up`.
+
+    The first time this command is run, it will create several containers that are used during development, so it may take some time.
+
+    It will also create some empty databases and install the project dependencies with composer.
+
+* Run `./indocker bin/cli db:create` to create the initial database.
+* Run `./indocker bin/cli db:migrate` to get database migrations up to date.
+* Run `./indocker bin/cli api-key:generate` to get your first API key generated.
+
+Once you finish this, you will have the project exposed in ports `8800` through RoadRunner and `8000` through nginx+php-fpm.
+
+> Note: The `indocker` shell script is a helper tool used to run commands inside the main docker container.
+
+## Project structure
+
+This project is structured as a modular application, using [laminas/laminas-config-aggregator](https://github.com/laminas/laminas-config-aggregator) to merge the configuration provided by every module.
+
+All modules are inside the `module` folder, and each one has its own `src`, `test` and `config` folders, with the source code, tests and configuration. They also have their own `ConfigProvider` class, which is consumed by the config aggregator.
+
+This is a simplified version of the project structure:
+
+```
+shlink
+├── bin
+│   ├── cli
+│   └── [...]
+├── config
+│   ├── autoload
+│   ├── params
+│   ├── config.php
+│   ├── container.php
+│   └── [...]
+├── data
+│   ├── cache
+│   ├── locks
+│   ├── log
+│   └── proxies
+├── docs
+│   ├── adr
+│   ├── async-api
+│   └── swagger
+├── module
+│   ├── CLI
+│   ├── Core
+│   └── Rest
+├── public
+│   └── [...]
+├── composer.json
+└── README.md
+```
+
+The purposes of every folder are:
+
+* `bin`: It contains the CLI tools. The `cli` one is the main entry point to run Shlink from the command line.
+* `config`: Contains application-wide configurations, which are later merged with the ones provided by every module.
+* `data`: Common git-ignored assets, like logs, caches, lock files, GeoLite DB files, etc. It's the only location where Shlink may need to write at runtime.
+* `docs`: Any project documentation is stored here, like API spec definitions or architectural decision records.
+* `module`: Contains a sub-folder for every module in the project. Modules contain the source code, tests and configurations for every context in the project.
+* `public`: Few assets (like `favicon.ico` or `robots.txt`) and the web entry point are stored here. This web entry point is not used when serving the app with RoadRunner.
+
+## Project tests
+
+In order to ensure stability and no regressions are introduced while developing new features, this project has different types of tests.
+
+* **Unit tests**: These are the simplest to run, and usually test individual pieces of code, replacing any external dependency by mocks.
+
+    The code coverage of unit tests is pretty high, and only components which work closer to the database, like entity repositories, are excluded because of their nature.
+
+* **Database tests**: These are integration tests that run against a real database, and only cover components which work closer to the database.
+
+    Its purpose is to verify all the database queries behave as expected and return what's expected.
+
+    The project provides some tooling to run them against any of the supported database engines.
+
+* **API tests**: These are E2E tests that spin up an instance of the app with RoadRunner, and test it from the outside by interacting with the REST API.
+
+    These are the best tests to catch regressions, and to verify everything behaves as expected.
+
+    They use Postgres as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+
+    Since the app instance is run on a process different from the one running the tests, when a test fails it might not be obvious why. To help debugging that, the app will dump all its logs inside `data/log/api-tests`, where you will find the `shlink.log` and `access.log` files.
+
+* **CLI tests**: These are E2E tests too, but they test console commands instead of REST endpoints.
+
+    They use Maria DB as the database engine, and include the same fixtures as the API tests, that ensure the same data exists at the beginning of the execution.
+
+Depending on the kind of contribution, maybe not all kinds of tests are needed, but the more you provide, the better.
+
+## Running code checks
+
+* Run `./indocker composer cs` to check coding styles are fulfilled.
+* Run `./indocker composer cs:fix` to fix coding styles (some may not be fixable from the CLI)
+* Run `./indocker composer stan` to statically analyze the code with [phpstan](https://phpstan.org/). This tool is the closest to "compile" PHP and verify everything would work as expected.
+* Run `./indocker composer test:unit` to run the unit tests.
+* Run `./indocker composer test:db` to run the database integration tests.
+
+    This command runs the same test suite against all supported database engines in parallel. If you just want to run one of them, you can add one of `:sqlite`, `:mysql`, `:maria`, `:postgres`, `:mssql` at the end of the command.
+    
+    For example, `test:db:postgres`.
+
+* Run `./indocker composer test:api` to run API E2E tests. For these, the Postgres database engine is used.
+* Run `./indocker composer test:cli` to run CLI E2E tests. For these, the Maria DB database engine is used.
+* Run `./indocker composer ci` to run all previous commands together, parallelizing non-conflicting tasks as much as possible.
+
+## Testing endpoints
+
+The project provides a Swagger UI container for dev envs, which can be accessed in http://localhost:8005.
+
+It will automatically load the contents of `docs/swagger`, so you can make any updates and they will get reflected.
+
+## Pull request process
+
+**Important!**: Before starting to work on a pull request, make sure you always [open an issue](https://github.com/shlinkio/shlink/issues/new/choose) first.
+
+This is important because any contribution needs to be discussed first. Maybe there's someone else already working on something similar, or there are other considerations to have in mind.
+
+Once everything is clear, to provide a pull request to this project, you should always start by creating a new branch, where you will make all desired changes.
+
+The base branch should always be `develop`, and the target branch for the pull request should also be `develop`.
+
+Before your branch can be merged, all the checks described in [Running code checks](#running-code-checks) have to be passing. You can verify that manually by running `./indocker composer ci`, or wait for the build to be run automatically after the pull request is created.
+
+## Architectural Decision Records
+
+The project includes logs for some architectural decisions, using the [adr](https://adr.github.io/) proposal.
+
+If you are curious or want to understand why something has been built in some specific way, [take a look at them](docs/adr).

Dockerfile

@@ -0,0 +1,69 @@
+FROM php:8.4-alpine3.21 AS base
+
+ARG SHLINK_VERSION=latest
+ENV SHLINK_VERSION=${SHLINK_VERSION}
+ARG SHLINK_RUNTIME=rr
+ENV SHLINK_RUNTIME=${SHLINK_RUNTIME}
+
+ENV USER_ID='1001'
+ENV PDO_SQLSRV_VERSION='5.12.0'
+ENV MS_ODBC_DOWNLOAD='7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION='18_18.4.1.1'
+ENV LC_ALL='C'
+
+WORKDIR /etc/shlink
+
+# Install required PHP extensions
+RUN \
+    # Temp install dev dependencies needed to compile the extensions
+    # FIXME Deprecated image-related extensions. They can be removed with QR-code support
+    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev linux-headers && \
+    docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip gd && \
+    apk add --no-cache sqlite-libs && \
+    docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
+    # Remove temp dev extensions, and install prod equivalents that are required at runtime
+    apk del .dev-deps && \
+    apk add --no-cache postgresql icu libzip libpng
+
+# Install sqlsrv driver for x86_64 builds
+RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+    if [ $(uname -m) == "x86_64" ]; then \
+      wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      apk add --allow-untrusted msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} && \
+      docker-php-ext-enable pdo_sqlsrv && \
+      rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
+    fi; \
+    apk del .phpize-deps
+
+# Install shlink
+FROM base AS builder
+COPY . .
+COPY --from=composer:2 /usr/bin/composer ./composer.phar
+RUN apk add --no-cache git && \
+    php composer.phar install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction && \
+    php composer.phar clear-cache && \
+    rm -r docker composer.* && \
+    sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" module/Core/src/Config/Options/AppOptions.php
+
+
+# Prepare final image
+FROM base
+LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+
+COPY --from=builder --chown=${USER_ID} /etc/shlink .
+RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink && \
+    if [ "$SHLINK_RUNTIME" == 'rr' ]; then \
+      php ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr ; \
+    fi;
+
+# Expose default port
+EXPOSE 8080
+
+# Copy config specific for the image
+COPY docker/docker-entrypoint.sh docker-entrypoint.sh
+COPY docker/config/php.ini ${PHP_INI_DIR}/conf.d/
+
+USER ${USER_ID}
+
+ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Alejandro Celaya
+Copyright (c) 2016-2024 Alejandro Celaya
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,104 @@
-# Shlink
+![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png)
 
-[![Build Status](https://travis-ci.org/shlinkio/shlink.svg?branch=master)](https://travis-ci.org/shlinkio/shlink)
-[![Code Coverage](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Latest Stable Version](https://poser.pugx.org/shlinkio/shlink/v/stable.png)](https://packagist.org/packages/shlinkio/shlink)
-[![License](https://poser.pugx.org/shlinkio/shlink/license.png)](https://packagist.org/packages/shlinkio/shlink)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/shlinkio/shlink/ci.yml?branch=develop&logo=github&style=flat-square)](https://github.com/shlinkio/shlink/actions/workflows/ci.yml?query=workflow%3A%22Continuous+integration%22)
+[![Code Coverage](https://img.shields.io/codecov/c/gh/shlinkio/shlink/develop?style=flat-square)](https://app.codecov.io/gh/shlinkio/shlink)
+[![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
+[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?logo=docker&style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
+[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/main/LICENSE)
 
-A PHP-based URL shortener application with analytics and management
+[![Mastodon](https://img.shields.io/mastodon/follow/109329425426175098?color=%236364ff&domain=https%3A%2F%2Ffosstodon.org&label=follow&logo=mastodon&logoColor=white&style=flat-square)](https://fosstodon.org/@shlinkio)
+[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlink.io)
+[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://slnk.to/donate)
+
+A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.
+
+## Table of Contents
+
+- [Full documentation](#full-documentation)
+- [Docker image](#docker-image)
+- [Self-hosted](#self-hosted)
+    - [Download](#download)
+    - [Configure](#configure)
+- [Using shlink](#using-shlink)
+- [Contributing](#contributing)
+
+## Full documentation
+
+This document contains the very basics to get started with Shlink. If you want to learn everything you can do with it, visit the [full searchable documentation](https://shlink.io/documentation/).
+
+## Docker image
+
+You can learn how to use the official docker image by reading [the docs](https://shlink.io/documentation/install-docker-image/).
+
+The idea is that you can just generate a container using the image and provide the custom config via env vars.
+
+## Self-hosted
+
+First, make sure the host where you are going to run shlink fulfills these requirements:
+
+* PHP 8.3 or 8.4
+* The next PHP extensions: json, curl, pdo, intl, gd and gmp/bcmath.
+    * apcu extension is recommended if you don't plan to use RoadRunner.
+    * xml extension is required if you want to generate QR codes in svg format.
+    * sockets and bcmath extensions are required if you want to integrate with a RabbitMQ instance.
+* MySQL, MariaDB, PostgreSQL, MicrosoftSQL or SQLite.
+    * You will also need the corresponding pdo variation for the database you are planning to use: `pdo_mysql`, `pdo_pgsql`, `pdo_sqlsrv` or `pdo_sqlite`.
+
+### Download
+
+In order to run Shlink, you will need a built version of the project. There are two ways to get it.
+
+* **Using a dist file**
+
+    The easiest way to install shlink is by using one of the pre-bundled distributable packages.
+
+    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink*_dist.zip` file that suits your needs. You will find one for every supported PHP version.
+
+    Finally, decompress the file in the location of your choice.
+
+* **Building from sources**
+
+    If for any reason you want to build the project yourself, follow these steps:
+
+    * Clone the project with git (`git clone https://github.com/shlinkio/shlink.git`), or download it by clicking the **Clone or download** green button.
+    * Download the [Composer](https://getcomposer.org/download/) PHP package manager inside the project folder.
+    * Run `./build.sh 3.0.0`, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when running `shlink -V` from the command line).
+
+    After that, you will have a dist file inside the `build` directory, that you need to decompress in the location of your choice.
+
+    > **Note**
+    >
+    > This is the process used when releasing new Shlink versions. After tagging the new version with git, the GitHub release is automatically created by a [GitHub workflow](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Publish+release%22), attaching the generated dist file to it.
+
+### Configure
+
+Despite how you built the project, you now need to configure it, by following these steps:
+
+* If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
+* Recursively grant write permissions to the `data` directory. Shlink uses it to cache some information.
+* Set up the application by running the `vendor/bin/shlink-installer install` script. It is a command line tool that will guide you through the installation process. **Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.**
+* Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with Shlink's API.
+
+## Using shlink
+
+Once shlink is installed, there are two main ways to interact with it:
+
+* **The command line**: Try running `bin/cli` to see all the available commands.
+
+    All of them can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
+
+    It is probably a good idea to symlink the CLI entry point (`bin/cli`) to somewhere in your path, so that you can run shlink from any directory.
+
+* **The REST API**: The complete docs on how to use the API can be found [here](https://shlink.io/documentation/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
+
+    However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or hosted by yourself.
+
+Both the API and CLI allow you to do mostly the same operations, except for API key management, which can be done from the command line interface only.
+
+## Contributing
+
+If you are trying to find out how to run the project in development mode or how to provide contributions, read the [CONTRIBUTING](CONTRIBUTING.md) doc.
+
+---
+
+> This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

UPGRADE.md

@@ -0,0 +1,186 @@
+# Upgrading
+
+## From v3.x to v4.x
+
+### General
+
+* Swoole and Openswoole are no longer officially supported runtimes. The recommended alternative is RoadRunner.
+* Dist files for swoole/openswoole are no longer published.
+* Webhooks are no longer supported. Migrate to one of the other [real-time updates](https://shlink.io/documentation/advanced/real-time-updates/) mechanisms.
+* When using RoadRunner, the amount of web workers, task workers and the port number can no longer be provided via config options. Use `WEB_WORKER_NUM`, `TASK_WORKER_NUM` and `PORT` env vars instead.
+
+### Changes in URL shortener
+
+* The short URLs `loosely` mode is no longer supported, as it was a typo. Use `loose` mode instead.
+* QR codes URLs now work by default, even for short URLs that cannot be visited due to max visits or date range limitations.
+  If you want to keep previous behavior, pass `QR_CODE_FOR_DISABLED_SHORT_URLS=false` or the equivalent configuration option.
+* Long URL title resolution is now enabled by default. You can still disable it by passing `AUTO_RESOLVE_TITLES=false` or the equivalent configuration option.
+* Shlink no longer allows to opt-in for long URL verification. Long URLs are unconditionally considered correct during short URL creation/edition.
+* Device long URLs have been migrated to the new Dynamic rule-based redirects system and will continue to work as expected, but the API surface has changed.
+  If you use shlink-web-client and rely on this feature when creating/updating short URLs, **DO NOT UPDATE YET**. Support for dynamic rule-based redirects will be added to shlink-web-client soon, in v4.1.0
+
+### Changes in REST API
+
+* REST API v1/v2 now behave like v3. This only affects error codes, which are now proper URIs.
+  * `INVALID_ARGUMENT` -> `https://shlink.io/api/error/invalid-data`
+  * `INVALID_SHORT_URL_DELETION` -> `https://shlink.io/api/error/invalid-short-url-deletion`
+  * `DOMAIN_NOT_FOUND` -> `https://shlink.io/api/error/domain-not-found`
+  * `FORBIDDEN_OPERATION` -> `https://shlink.io/api/error/forbidden-tag-operation`
+  * `INVALID_SLUG` -> `https://shlink.io/api/error/non-unique-slug`
+  * `INVALID_SHORTCODE` -> `https://shlink.io/api/error/short-url-not-found`
+  * `TAG_CONFLICT` -> `https://shlink.io/api/error/tag-conflict`
+  * `TAG_NOT_FOUND` -> `https://shlink.io/api/error/tag-not-found`
+  * `MERCURE_NOT_CONFIGURED` -> `https://shlink.io/api/error/mercure-not-configured`
+  * `INVALID_AUTHORIZATION` -> `https://shlink.io/api/error/missing-authentication`
+  * `INVALID_API_KEY` -> `https://shlink.io/api/error/invalid-api-key`
+* Endpoints previously returning props like `"visitsCount": {number}` no longer do it. There should be an alternative `"visitsSummary": {}` object with the amount nested on it.
+* It is no longer possible to order the short URLs list with `orderBy=visitsCount-ASC`/`orderBy=visitsCount-DESC`. Use `orderBy=visits-ASC`/`orderBy=visits-DESC` instead.
+* It is no longer possible to get tags with stats using `GET /tags?withStats=true`. Use `GET /tags/stats` endpoint instead.
+* The `deviceLongUrls` are ignored when calling `POST /short-urls` or `PATCH /short-urls/{shortCode}`. These should now be configured as dynamic rule-based redirects via `POST /short-urls/{shortCode}/redirect-rules`.
+
+### Changes in Docker image
+
+* Since openswoole is no longer supported, there are no longer image tags suffixed with `openswoole`. You should migrate to the default or `roadrunner` ones.
+* The `non-root` docker tag is no longer published, as all docker images are now running without super-user permissions.
+* Due to previous point, it is no longer possible to pass `ENABLE_PERIODIC_VISIT_LOCATE=true` in order to configure a cron job that locates visits periodically.
+  This was not really needed in the docker image, as visits are located on the fly.
+
+### Changes in integrations
+
+* Credentials in redis URLs should now be URL-encoded, as they are unconditionally url-decoded before being used. Previously, it was possible to customize this behavior via `REDIS_DECODE_CREDENTIALS=true|false`.
+* Providing redis URIs in the form of `tcp://password@6.6.6.6:6379` is no longer supported. If you want to provide password with no username, do `tcp://:password@6.6.6.6:6379` instead.
+
+## From v2.x to v3.x
+
+### Changes in REST API
+
+* The `type` property returned when trying to delete a URL that reached the visits threshold, when using the `DELETE /short-urls/{shortCode}` endpoint, is now `INVALID_SHORT_URL_DELETION` instead of `INVALID_SHORTCODE_DELETION`.
+* The `INVALID_AUTHORIZATION` error no longer includes the `expectedTypes` property. Use `expectedHeaders` one instead.
+* The `GET /rest/v2/short-urls` endpoint no longer allows ordering by `visitsCount`, `visitCount` or `originalUrl`. Use `visits` instead of the first two, and `longUrl` instead of the last one.
+* The `GET /rest/v2/short-urls` endpoint no longer allows providing the ordering params with array notation, as in `/shortUrls?orderBy[longUrl]=DESC`. Instead, use the following notation `/shortUrls?orderBy=longUrl-DESC`.
+* The `GET /rest/v2/short-urls` endpoint now has a default ordering of newest-to-oldest. Use `/shortUrls?orderBy=dateCreated-ASC` in order to keep the oldest-to-newest behavior.
+* Requests expecting a body no longer support url-encoded payloads. Instead, always use JSON bodies with `Content-Type: application/json`.
+* The next endpoints have been removed:
+  * `PUT /rest/v2/short-urls/{shortCode}/tags`: Use the `PATCH /rest/v2/short-urls/{shortCode}` endpoint to set the short URL tags.
+  * `POST /rest/v2/tags`: Use `POST /rest/v2/short-urls` or `PATCH /rest/v2/short-urls/{shortCodes}` to create new tags already attached to a short URL. Creating orphan tags makes no sense.
+
+### Changes in CLI
+
+* The next commands have been removed:
+  * `short-url:generate`: Use `short-url:create` instead.
+  * `tag:create`: Creating orphan tags makes no sense.
+* Params in camelCase format are no longer supported. They all have an equivalent kebab-case replacement. (for example, from `--startDate` to `--start-date`).
+* The `short-url:create` command no longer accepts the `--no-validate-url` flag. Now URLs are never validated, unless `--validate-url` is passed.
+* The CLI installer tool entry-points have changed.
+  * `bin/install`: replaced by `vendor/bin/shlink-installer install`
+  * `bin/update`: replaced by `vendor/bin/shlink-installer update`
+  * `bin/set-option`: replaced by `vendor/bin/shlink-installer set-option`
+
+### Changes in config
+
+* The next env vars have been removed:
+  * `INVALID_SHORT_URL_REDIRECT_TO`: Replaced by `DEFAULT_INVALID_SHORT_URL_REDIRECT`.
+  * `REGULAR_404_REDIRECT_TO`: Replaced by `DEFAULT_REGULAR_404_REDIRECT`.
+  * `BASE_URL_REDIRECT_TO`: Replaced by `DEFAULT_BASE_URL_REDIRECT`.
+  * `SHORT_DOMAIN_HOST`: Replaced by `DEFAULT_DOMAIN`.
+  * `SHORT_DOMAIN_SCHEMA`: Replaced by `IS_HTTPS_ENABLED`.
+  * `USE_HTTPS`: Replaced by `IS_HTTPS_ENABLED`.
+  * `VALIDATE_URLS`: There's no replacement. URLs are not validated, unless explicitly requested during creation or edition.
+* The next env vars behavior has changed:
+  * `DELETE_SHORT_URL_THRESHOLD`: Now, if this env var is not provided, the "visits threshold" won't be checked at all when deleting short URLs. Make sure you explicitly provide a value if you want to enable this feature.
+* Environment variables now have precedence over configuration set via the installer tool.
+
+### Other changes
+
+* A default GeoLite2 license key is no longer provided. If you don't provide your own as explained in [the docs](https://shlink.io/documentation/geolite-license-key/), Shlink will not try to update the file anymore.
+* The docker image no longer accepts providing configuration via json files mounted in the `config/params` folder. Only env vars are supported now.
+* If you were manually serving Shlink with swoole, the entry script has to be changed from `/path/to/shlink/vendor/bin/mezzio-swoole start` to `/path/to/shlink/vendor/bin/laminas mezzio:swoole:start`
+* The `GET /{shortCode}/qr-code/{size}` url has been removed. Use `GET /{shortCode}/qr-code?size={size}` instead.
+* Regular swoole extension is no longer supported. Use openswoole instead, as a direct replacement. In most of the cases you just need to uninstall one and install the other, the rest is transparent.
+
+## From v1.x to v2.x
+
+### PHP 7.4 required
+
+This new version takes advantage of several new features introduced in PHP 7.4.
+
+Thanks to that, the code is more reliable and robust, and easier to maintain and improve.
+
+However, that means that any previous PHP version is no longer supported.
+
+### Preview generation
+
+The ability to generate website previews has been completely removed and has no replacement.
+
+The feature never properly worked, and it wasn't really useful. Because of that, the feature is no longer available on Shlink 2.x
+
+Removing this feature has these implications:
+
+* The `short-url:process-previews` CLI command no longer exists, and an error will be thrown if executed.
+* The `/{shortCode}/preview` path is no longer valid, and will return a 404 status.
+
+### Removed paths
+
+These routes have been removed, but have a direct replacement:
+
+* `/qr/{shortCode}[/{size}]` -> `/{shortCode}/qr-code[/{size}]`
+* `PUT /rest/v{version}/short-urls/{shortCode}` -> `PATCH /rest/v{version}/short-urls/{shortCode}`
+
+When using the old ones, a 404 status will be returned now.
+
+### Removed command and route aliases
+
+All the aliases for the CLI commands in the `short-urls` namespace have been removed. If you were using any of those commands with the `shortcode` or `short-code` prefixes, make sure to update them to use the `short-urls` prefix instead.
+
+The same happens for all REST endpoints starting with `/short-code`. They were previously aliased to `/short-urls` ones, but they will return a 404 now. Make sure to update them accordingly.
+
+### JWT authentication removed
+
+Shlink's REST API no longer accepts authentication using a JWT token. The API key has to be passed now in the `x-api-key` header.
+
+Removing this feature has these implications:
+
+* Shlink will no longer introspect the `Authorization` header for Bearer tokens.
+* The `POST /rest/v{version}/authenticate` endpoint no longer exists and will return a 404.
+
+### API version is now required
+
+Endpoints need to provide a version in the path now. Previously, not providing a version used to fall back to v1. Now, it will return a 404 status, as no route will match.
+
+The only exception is the `/rest/health` endpoint, which will continue working without the version.
+
+### API errors
+
+Shlink v1.21.0 introduced support for API errors using the Problem Details format, as well as the v2 of the API.
+
+For backwards compatibility reasons, requests performed to v1 continued to return the old `error` and `message` properties.
+
+Starting with Shlink v2.0.0, both versions of the API will no longer return those two properties.
+
+As a replacement, use `type` instead of `error`, and `detail` instead of `message`.
+
+### Changes in models
+
+The next REST API models have changed:
+
+* **ShortUrl**: The `originalUrl` property was deprecated and has been removed. Use `longUrl` instead.
+* **Visit**: The `remoteAddr` property was deprecated and has been removed. It has no replacement.
+* **VisitLocation**: The `latitude` and `longitude` properties are no longer strings, but float.
+
+### URL validation
+
+Shlink can verify provided long URLs are valid before trying to shorten them. Starting with v2, it no longer does it by default and needs to be explicitly enabled instead of explicitly disabled.
+
+### Removed config options
+
+The `not_found_redirect_to` config option and the `NOT_FOUND_REDIRECT_TO` env var are no longer taken into consideration for the docker image.
+
+Instead, use `invalid_short_url_redirect_to` and `INVALID_SHORT_URL_REDIRECT_TO` respectively.
+
+### Migrated to Laminas
+
+The project has been using Zend Framework components since the beginning. Since it has been re-branded as [Laminas](https://getlaminas.org/), this version updates to the new set of components.
+
+Updating to Laminas components has these implications:
+
+* If you were manually serving Shlink with swoole, the entry script has to be changed from `/path/to/shlink/vendor/bin/zend-expressive-swoole` to `/path/to/shlink/vendor/bin/mezzio-swoole`

bin/cli

@@ -1,17 +1,10 @@
 #!/usr/bin/env php
 <?php
-use Interop\Container\ContainerInterface;
-use Symfony\Component\Console\Application as CliApp;
+
+declare(strict_types=1);
+
 use Symfony\Component\Console\Application;
-use Zend\I18n\Translator\Translator;
-
-/** @var ContainerInterface $container */
-$container = include __DIR__ . '/../config/container.php';
-
-/** @var Translator $translator */
-$translator = $container->get('translator');
-$translator->setLocale(env('CLI_LOCALE', 'en'));
 
 /** @var Application $app */
-$app = $container->get(CliApp::class);
+$app = require __DIR__ . '/../config/cli-app.php';
 $app->run();

bin/doctrine

@@ -0,0 +1,12 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Tools\Console\ConsoleRunner;
+use Doctrine\ORM\Tools\Console\EntityManagerProvider\SingleManagerProvider;
+
+/** @var EntityManager $app */
+$em = require __DIR__ . '/../config/entity-manager.php';
+ConsoleRunner::run(new SingleManagerProvider($em));

bin/roadrunner-worker.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Mezzio\Application;
+use Psr\Container\ContainerInterface;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
+use Shlinkio\Shlink\EventDispatcher\RoadRunner\RoadRunnerTaskConsumerToListener;
+use Spiral\RoadRunner\Http\PSR7Worker;
+
+use function gc_collect_cycles;
+use function Shlinkio\Shlink\Config\env;
+
+(static function (): void {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/../config/container.php';
+    $rrMode = env('RR_MODE');
+    $gcCollectCycles = env('GC_COLLECT_CYCLES', default: false);
+
+    if ($rrMode === 'http') {
+        // This was spin-up as a web worker
+        $app = $container->get(Application::class);
+        $worker = $container->get(PSR7Worker::class);
+
+        while ($req = $worker->waitRequest()) {
+            try {
+                $worker->respond($app->handle($req));
+            } catch (Throwable $e) {
+                $worker->getWorker()->error((string) $e);
+            } finally {
+                if ($gcCollectCycles) {
+                    gc_collect_cycles();
+                }
+            }
+        }
+    } else {
+        $requestIdMiddleware = $container->get(RequestIdMiddleware::class);
+        $container->get(RoadRunnerTaskConsumerToListener::class)->listenForTasks(
+            fn (string $requestId) => $requestIdMiddleware->setCurrentRequestId($requestId),
+        );
+    }
+})();

bin/test/run-api-tests.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env sh
+
+export APP_ENV=test
+export TEST_ENV=api
+export TEST_RUNTIME="${TEST_RUNTIME:-"rr"}" # rr is the only runtime currently supported
+export DB_DRIVER="${DB_DRIVER:-"postgres"}"
+export GENERATE_COVERAGE="${GENERATE_COVERAGE:-"no"}"
+
+[ "$GENERATE_COVERAGE" != 'no' ] && export XDEBUG_MODE=coverage
+
+# Reset logs
+OUTPUT_LOGS=data/log/api-tests/output.log
+rm -rf data/log/api-tests
+mkdir data/log/api-tests
+touch $OUTPUT_LOGS
+
+# Try to stop server just in case it hanged in last execution
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -f -w .
+
+echo 'Starting server...'
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr serve -p -w . -c=config/roadrunner/.rr.test.yml \
+  -o=logs.output="${PWD}/${OUTPUT_LOGS}" \
+  -o=logs.channels.http.output="${PWD}/${OUTPUT_LOGS}" \
+  -o=logs.channels.server.output="${PWD}/${OUTPUT_LOGS}" &
+sleep 2 # Let's give the server a couple of seconds to start
+
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --testdox-summary $*
+TESTS_EXIT_CODE=$?
+
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -w .
+
+# Exit this script with the same code as the tests. If tests failed, this script has to fail
+exit $TESTS_EXIT_CODE

bin/test/run-cli-tests.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+
+export APP_ENV=test
+export TEST_ENV=cli
+export DB_DRIVER="${DB_DRIVER:-"maria"}"
+export GENERATE_COVERAGE="${GENERATE_COVERAGE:-"no"}"
+
+[ "$GENERATE_COVERAGE" != 'no' ] && export XDEBUG_MODE=coverage
+
+vendor/bin/phpunit --order-by=random --testdox --testdox-summary -c phpunit-cli.xml $*
+TESTS_EXIT_CODE=$?
+
+# Exit this script with the same code as the tests. If tests failed, this script has to fail
+exit $TESTS_EXIT_CODE

build.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+set -e
+
+if [ "$#" -lt 1 ]; then
+  echo "Usage:" >&2
+  echo "   $0 {version}" >&2
+  exit 1
+fi
+
+version=$1
+phpVersion=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
+distId="shlink${version}_php${phpVersion}_dist"
+builtContent="./build/${distId}"
+projectdir=$(pwd)
+[[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
+
+# Copy project content to temp dir
+echo 'Copying project files...'
+rm -rf "${builtContent}"
+mkdir -p "${builtContent}"
+rsync -av * "${builtContent}" \
+    --exclude=*docker* \
+    --exclude=Dockerfile \
+    --include=.htaccess \
+    --include=config/roadrunner/.rr.yml \
+    --exclude-from=./.dockerignore
+cd "${builtContent}"
+
+# Install dependencies
+echo "Installing dependencies with $composerBin..."
+${composerBin} self-update
+${composerBin} install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction
+
+# Delete development files
+echo 'Deleting dev files...'
+rm composer.*
+
+# Update Shlink version
+sed -i "s/%SHLINK_VERSION%/${version}/g" module/Core/src/Config/Options/AppOptions.php
+
+# Compressing file
+echo 'Compressing files...'
+cd "${projectdir}"/build
+rm -f ./${distId}.zip
+zip -ry ./${distId}.zip ./${distId}
+cd "${projectdir}"
+rm -rf "${builtContent}"
+
+echo 'Done!'

composer.json

@@ -1,72 +1,170 @@
 {
     "name": "shlinkio/shlink",
     "type": "project",
-    "homepage": "http://shlink.io",
+    "homepage": "https://shlink.io",
     "description": "A self-hosted and PHP-based URL shortener application with CLI and REST interfaces",
     "license": "MIT",
     "authors": [
         {
             "name": "Alejandro Celaya Alastrué",
-            "homepage": "http://www.alejandrocelaya.com",
+            "homepage": "https://www.alejandrocelaya.com",
             "email": "alejandro@alejandrocelaya.com"
         }
     ],
     "require": {
-        "php": "^5.6 || ^7.0",
-        "zendframework/zend-expressive": "^1.0",
-        "zendframework/zend-expressive-fastroute": "^1.1",
-        "zendframework/zend-expressive-twigrenderer": "^1.0",
-        "zendframework/zend-stdlib": "^2.7",
-        "zendframework/zend-servicemanager": "^3.0",
-        "zendframework/zend-paginator": "^2.6",
-        "zendframework/zend-config": "^2.6",
-        "zendframework/zend-i18n": "^2.7",
-        "mtymek/expressive-config-manager": "^0.4",
-        "acelaya/zsm-annotated-services": "^0.2.0",
-        "doctrine/orm": "^2.5",
-        "guzzlehttp/guzzle": "^6.2",
-        "symfony/console": "^3.0",
-        "firebase/php-jwt": "^4.0",
-        "monolog/monolog": "^1.21",
-        "theorchard/monolog-cascade": "^0.4",
-        "endroid/qrcode": "^1.7"
+        "php": "^8.3",
+        "ext-curl": "*",
+        "ext-gd": "*",
+        "ext-json": "*",
+        "ext-mbstring": "*",
+        "ext-pdo": "*",
+        "akrabat/ip-address-middleware": "^2.6",
+        "cakephp/chronos": "^3.1",
+        "doctrine/dbal": "^4.2",
+        "doctrine/migrations": "^3.8",
+        "doctrine/orm": "^3.3",
+        "donatj/phpuseragentparser": "^1.10",
+        "endroid/qr-code": "^6.0.5",
+        "friendsofphp/proxy-manager-lts": "^1.0",
+        "geoip2/geoip2": "^3.1",
+        "guzzlehttp/guzzle": "^7.9",
+        "hidehalo/nanoid-php": "^2.0",
+        "jaybizzle/crawler-detect": "^1.3",
+        "laminas/laminas-config-aggregator": "^1.17",
+        "laminas/laminas-diactoros": "^3.5",
+        "laminas/laminas-inputfilter": "^2.31",
+        "laminas/laminas-servicemanager": "^3.23",
+        "laminas/laminas-stdlib": "^3.20",
+        "matomo/matomo-php-tracker": "^3.3",
+        "mezzio/mezzio": "^3.20",
+        "mezzio/mezzio-fastroute": "^3.12",
+        "mezzio/mezzio-problem-details": "^1.15",
+        "mlocati/ip-lib": "^1.18.1",
+        "pagerfanta/core": "^3.8",
+        "ramsey/uuid": "^4.7",
+        "shlinkio/doctrine-specification": "^2.2",
+        "shlinkio/shlink-common": "^7.1",
+        "shlinkio/shlink-config": "^4.0",
+        "shlinkio/shlink-event-dispatcher": "^4.3",
+        "shlinkio/shlink-importer": "^5.6",
+        "shlinkio/shlink-installer": "^9.6",
+        "shlinkio/shlink-ip-geolocation": "^4.3",
+        "shlinkio/shlink-json": "^1.2",
+        "spiral/roadrunner": "^2025.1",
+        "spiral/roadrunner-cli": "^2.7",
+        "spiral/roadrunner-http": "^3.5",
+        "spiral/roadrunner-jobs": "^4.6",
+        "symfony/console": "^7.3",
+        "symfony/filesystem": "^7.3",
+        "symfony/lock": "^7.3.2",
+        "symfony/process": "^7.3",
+        "symfony/string": "^7.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.0",
-        "squizlabs/php_codesniffer": "^2.3",
+        "devizzent/cebe-php-openapi": "^1.1.2",
+        "devster/ubench": "^2.1",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-doctrine": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0.5",
+        "phpstan/phpstan-symfony": "^2.0",
+        "phpunit/php-code-coverage": "^12.0",
+        "phpunit/phpcov": "^11.0",
+        "phpunit/phpunit": "^12.0.10",
         "roave/security-advisories": "dev-master",
-        "filp/whoops": "^2.0",
-        "symfony/var-dumper": "^3.0",
-        "vlucas/phpdotenv": "^2.2"
+        "shlinkio/php-coding-standard": "~2.4.2",
+        "shlinkio/shlink-test-utils": "^4.3.1",
+        "symfony/var-dumper": "^7.3",
+        "veewee/composer-run-parallel": "^1.4"
+    },
+    "conflict": {
+        "symfony/var-exporter": ">=6.3.9,<=6.4.0"
     },
     "autoload": {
         "psr-4": {
             "Shlinkio\\Shlink\\CLI\\": "module/CLI/src",
             "Shlinkio\\Shlink\\Rest\\": "module/Rest/src",
-            "Shlinkio\\Shlink\\Core\\": "module/Core/src",
-            "Shlinkio\\Shlink\\Common\\": "module/Common/src"
+            "Shlinkio\\Shlink\\Core\\": "module/Core/src"
         },
         "files": [
-            "module/Common/functions/functions.php"
+            "config/constants.php",
+            "module/Core/functions/array-utils.php",
+            "module/Core/functions/functions.php"
         ]
     },
     "autoload-dev": {
         "psr-4": {
             "ShlinkioTest\\Shlink\\CLI\\": "module/CLI/test",
+            "ShlinkioCliTest\\Shlink\\CLI\\": "module/CLI/test-cli",
             "ShlinkioTest\\Shlink\\Rest\\": "module/Rest/test",
+            "ShlinkioApiTest\\Shlink\\Rest\\": "module/Rest/test-api",
+            "ShlinkioDbTest\\Shlink\\Rest\\": "module/Rest/test-db",
             "ShlinkioTest\\Shlink\\Core\\": "module/Core/test",
-            "ShlinkioTest\\Shlink\\Common\\": "module/Common/test"
-        }
+            "ShlinkioDbTest\\Shlink\\Core\\": "module/Core/test-db",
+            "ShlinkioApiTest\\Shlink\\Core\\": "module/Core/test-api"
+        },
+        "files": [
+            "config/test/constants.php"
+        ]
     },
     "scripts": {
-        "check": [
-            "@cs",
-            "@test"
+        "ci": [
+            "@parallel cs stan openapi:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms",
+            "@parallel test:api:ci test:cli:ci"
         ],
-        "cs": "phpcs",
-        "cs-fix": "phpcbf",
-        "serve": "php -S 0.0.0.0:8000 -t public/",
-        "test": "phpunit --coverage-clover build/clover.xml",
-        "pretty-test": "phpunit --coverage-html build/coverage"
+        "cs": "phpcs -s",
+        "cs:fix": "phpcbf",
+        "stan": ["@putenv APP_ENV=test", "phpstan analyse"],
+        "test": [
+            "@parallel test:unit test:db",
+            "@parallel test:api test:cli"
+        ],
+        "test:unit": ["@putenv COLUMNS=120", "phpunit --order-by=random --testdox --testdox-summary"],
+        "test:unit:ci": ["@putenv XDEBUG_MODE=coverage", "@test:unit --coverage-php=build/coverage-unit.cov"],
+        "test:unit:pretty": ["@putenv XDEBUG_MODE=coverage", "@test:unit --coverage-html build/coverage-unit/coverage-html"],
+        "test:db": "@parallel test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
+        "test:db:sqlite": ["@putenv APP_ENV=test", "phpunit --order-by=random --testdox --testdox-summary -c phpunit-db.xml"],
+        "test:db:sqlite:ci": ["@putenv XDEBUG_MODE=coverage", "@test:db:sqlite --coverage-php build/coverage-db.cov"],
+        "test:db:mysql": ["@putenv DB_DRIVER=mysql", "@test:db:sqlite"],
+        "test:db:maria": ["@putenv DB_DRIVER=maria", "@test:db:sqlite"],
+        "test:db:postgres": ["@putenv DB_DRIVER=postgres", "@test:db:sqlite"],
+        "test:db:ms": ["@putenv DB_DRIVER=mssql", "@test:db:sqlite"],
+        "test:api": "bin/test/run-api-tests.sh",
+        "test:api:sqlite": ["@putenv DB_DRIVER=sqlite", "@test:api"],
+        "test:api:mysql": ["@putenv DB_DRIVER=mysql", "@test:api"],
+        "test:api:maria": ["@putenv DB_DRIVER=maria", "@test:api"],
+        "test:api:mssql": ["@putenv DB_DRIVER=mssql", "@test:api"],
+        "test:api:ci": [
+            "@putenv GENERATE_COVERAGE=yes",
+            "@test:api",
+            "phpcov merge build/coverage-api --php build/coverage-api.cov && rm build/coverage-api/*.cov"
+        ],
+        "test:api:pretty": [
+            "@putenv GENERATE_COVERAGE=yes",
+            "@test:api",
+            "phpcov merge build/coverage-api --html build/coverage-api/coverage-html && rm build/coverage-api/*.cov"
+        ],
+        "test:cli": "bin/test/run-cli-tests.sh",
+        "test:cli:ci": [
+            "@putenv GENERATE_COVERAGE=yes",
+            "@test:cli",
+            "vendor/bin/phpcov merge build/coverage-cli --php build/coverage-cli.cov && rm build/coverage-cli/*.cov"
+        ],
+        "test:cli:pretty": [
+            "@putenv GENERATE_COVERAGE=yes",
+            "@test:cli",
+            "phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov"
+        ],
+        "openapi:validate": "php-openapi validate docs/swagger/swagger.json",
+        "openapi:inline": "php-openapi inline docs/swagger/swagger.json docs/swagger/openapi-inlined.json",
+        "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
+    },
+    "config": {
+        "sort-packages": true,
+        "platform-check": false,
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "veewee/composer-run-parallel": true
+        }
     }
 }

config/autoload/.gitignore

@@ -1,2 +0,0 @@
-local.php
-*.local.php

config/autoload/app_options.global.php

@@ -1,10 +0,0 @@
-<?php
-return [
-
-    'app_options' => [
-        'name' => 'Shlink',
-        'version' => '1.1.0',
-        'secret_key' => env('SECRET_KEY'),
-    ],
-
-];

config/autoload/cache.global.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return (static function (): array {
+    $redisServers = EnvVars::REDIS_SERVERS->loadFromEnv();
+    $redis = ['pub_sub_enabled' => $redisServers !== null && EnvVars::REDIS_PUB_SUB_ENABLED->loadFromEnv()];
+    $cacheRedisBlock = $redisServers === null ? [] : [
+        'redis' => [
+            'servers' => $redisServers,
+            'sentinel_service' => EnvVars::REDIS_SENTINEL_SERVICE->loadFromEnv(),
+        ],
+    ];
+
+    return [
+        'cache' => [
+            'namespace' => EnvVars::CACHE_NAMESPACE->loadFromEnv(),
+            ...$cacheRedisBlock,
+        ],
+        'redis' => $redis,
+    ];
+})();

config/autoload/common.global.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ConfigAggregator\ConfigAggregator;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return (function () {
+    $isDev = EnvVars::isDevEnv();
+
+    return [
+
+        'debug' => $isDev,
+
+        // Disabling config cache for cli, ensures it's never used for RoadRunner, and also that console
+        // commands don't generate a cache file that's then used by php-fpm web executions
+        ConfigAggregator::ENABLE_CACHE => ! $isDev && PHP_SAPI !== 'cli',
+
+    ];
+})();

config/autoload/dependencies.global.php

@@ -1,23 +1,52 @@
 <?php
-use Shlinkio\Shlink\Common\ErrorHandler\ContentBasedErrorHandler;
-use Zend\Expressive;
-use Zend\Expressive\Container;
-use Zend\Expressive\Router;
-use Zend\Expressive\Template;
-use Zend\Expressive\Twig;
-use Zend\ServiceManager\Factory\InvokableFactory;
+
+declare(strict_types=1);
+
+use GuzzleHttp\Client;
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Mezzio\Application;
+use Mezzio\Container;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\ServerRequestFactoryInterface;
+use Psr\Http\Message\StreamFactoryInterface;
+use Psr\Http\Message\UploadedFileFactoryInterface;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Spiral\RoadRunner\Http\PSR7Worker;
+use Spiral\RoadRunner\WorkerInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 return [
 
     'dependencies' => [
         'factories' => [
-            Expressive\Application::class => Container\ApplicationFactory::class,
-            Router\FastRouteRouter::class => InvokableFactory::class,
-            Template\TemplateRendererInterface::class => Twig\TwigRendererFactory::class,
+            PSR7Worker::class => ConfigAbstractFactory::class,
+            Filesystem::class => InvokableFactory::class,
         ],
+
+        'delegators' => [
+            Application::class => [
+                Container\ApplicationConfigInjectionDelegator::class,
+            ],
+        ],
+
         'aliases' => [
-            Router\RouterInterface::class => Router\FastRouteRouter::class,
-            'Zend\Expressive\FinalHandler' => ContentBasedErrorHandler::class,
+            ClientInterface::class => Client::class,
+        ],
+
+        'lazy_services' => [
+            'proxies_target_dir' => 'data/proxies',
+            'proxies_namespace' => 'ShlinkProxy',
+            'write_proxy_files' => EnvVars::isProdEnv(),
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        PSR7Worker::class => [
+            WorkerInterface::class,
+            ServerRequestFactoryInterface::class,
+            StreamFactoryInterface::class,
+            UploadedFileFactoryInterface::class,
         ],
     ],
 

config/autoload/entity-manager.global.php

@@ -1,20 +1,80 @@
 <?php
-return [
 
-    'entity_manager' => [
-        'orm' => [
-            'proxies_dir' => 'data/proxies',
+declare(strict_types=1);
+
+use Doctrine\ORM\Events;
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\Visit\Listener\OrphanVisitsCountTracker;
+use Shlinkio\Shlink\Core\Visit\Listener\ShortUrlVisitsCountTracker;
+
+use function Shlinkio\Shlink\Core\ArrayUtils\contains;
+
+return (static function (): array {
+    $driver = EnvVars::DB_DRIVER->loadFromEnv();
+    $useEncryption = (bool) EnvVars::DB_USE_ENCRYPTION->loadFromEnv();
+    $isMysqlCompatible = contains($driver, ['maria', 'mysql']);
+
+    $doctrineDriver = match ($driver) {
+        'postgres' => 'pdo_pgsql',
+        'mssql' => 'pdo_sqlsrv',
+        default => 'pdo_mysql',
+    };
+    $readCredentialAsString = static function (EnvVars $envVar): string|null {
+        $value = $envVar->loadFromEnv();
+        return $value === null ? null : (string) $value;
+    };
+    $charset = match ($driver) {
+        // This does not determine charsets or collations in tables or columns, but the charset used in the data
+        // flowing in the connection, so it has to match what has been set in the database.
+        'maria', 'mysql' => 'utf8mb4',
+        'postgres' => 'utf8',
+        default => null,
+    };
+    $driverOptions = match ($driver) {
+        'mssql' => ['TrustServerCertificate' => 'true'],
+        'maria', 'mysql' => ! $useEncryption ? [] : [
+            1007 => true, // PDO::MYSQL_ATTR_SSL_KEY: Require using SSL
+            1014 => false, // PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT: Trust any certificate
         ],
-        'connection' => [
-            'driver' => 'pdo_mysql',
-            'user' => env('DB_USER'),
-            'password' => env('DB_PASSWORD'),
-            'dbname' => env('DB_NAME', 'shlink'),
-            'charset' => 'utf8',
-            'driverOptions' => [
-                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
+        'postgres' =>  ! $useEncryption ? [] : [
+            'sslmode' => 'require', // Require connections to be encrypted
+            'sslrootcert' => '', // Allow any certificate
+        ],
+        default => [],
+    };
+    $connection = match ($driver) {
+        null, 'sqlite' => [
+            'driver' => 'pdo_sqlite',
+            'path' => 'data/database.sqlite',
+        ],
+        default => [
+            'driver' => $doctrineDriver,
+            'dbname' => EnvVars::DB_NAME->loadFromEnv(),
+            'user' => $readCredentialAsString(EnvVars::DB_USER),
+            'password' => $readCredentialAsString(EnvVars::DB_PASSWORD),
+            'host' => EnvVars::DB_HOST->loadFromEnv(),
+            'port' => EnvVars::DB_PORT->loadFromEnv(),
+            'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
+            'charset' => $charset,
+            'driverOptions' => $driverOptions,
+        ],
+    };
+
+    return [
+
+        'entity_manager' => [
+            'orm' => [
+                'proxies_dir' => 'data/proxies',
+                'load_mappings_using_functional_style' => true,
+                'default_repository_classname' => EntitySpecificationRepository::class,
+                'listeners' => [
+                    Events::onFlush => [ShortUrlVisitsCountTracker::class, OrphanVisitsCountTracker::class],
+                    Events::postFlush => [ShortUrlVisitsCountTracker::class, OrphanVisitsCountTracker::class],
+                ],
             ],
+            'connection' => $connection,
         ],
-    ],
 
-];
+    ];
+})();

config/autoload/error-handler.global.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\Stratigility\Middleware\ErrorHandler;
+use Mezzio\ProblemDetails\ProblemDetailsMiddleware;
+use Shlinkio\Shlink\Common\Logger;
+
+use function Shlinkio\Shlink\Core\toProblemDetailsType;
+
+return [
+
+    'problem-details' => [
+        'default_types_map' => [
+            404 => toProblemDetailsType('not-found'),
+            500 => toProblemDetailsType('internal-server-error'),
+        ],
+    ],
+
+    'error_handler' => [
+        'listeners' => [Logger\ErrorLogger::class],
+    ],
+
+    'dependencies' => [
+        'delegators' => [
+            ErrorHandler::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+            ProblemDetailsMiddleware::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+        ],
+    ],
+
+];

config/autoload/errorhandler.local.php.dist

@@ -1,28 +0,0 @@
-<?php
-use Shlinkio\Shlink\Common\ErrorHandler\ContentBasedErrorHandler;
-use Zend\Expressive\Container\WhoopsErrorHandlerFactory;
-
-return [
-    'dependencies' => [
-        'invokables' => [
-            'Zend\Expressive\Whoops' => Whoops\Run::class,
-            'Zend\Expressive\WhoopsPageHandler' => Whoops\Handler\PrettyPageHandler::class,
-        ],
-    ],
-
-    'whoops' => [
-        'json_exceptions' => [
-            'display'    => true,
-            'show_trace' => true,
-            'ajax_only'  => true,
-        ],
-    ],
-
-    'error_handler' => [
-        'plugins' => [
-            'factories' => [
-                ContentBasedErrorHandler::DEFAULT_CONTENT => WhoopsErrorHandlerFactory::class,
-            ],
-        ],
-    ],
-];

config/autoload/geolite2.global.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'geolite2' => [
+        'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
+        'temp_dir' => __DIR__ . '/../../data',
+        'license_key' => EnvVars::GEOLITE_LICENSE_KEY->loadFromEnv(),
+    ],
+
+];

config/autoload/installer.global.php

@@ -0,0 +1,113 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI;
+
+use Shlinkio\Shlink\Installer\Config\Option;
+use Shlinkio\Shlink\Installer\Util\InstallationCommand;
+
+return [
+
+    'installer' => [
+        'enabled_options' => [
+            Option\Server\RuntimeConfigOption::class,
+            Option\Server\MemoryLimitConfigOption::class,
+            Option\Server\LogsFormatConfigOption::class,
+            Option\Database\DatabaseDriverConfigOption::class,
+            Option\Database\DatabaseNameConfigOption::class,
+            Option\Database\DatabaseHostConfigOption::class,
+            Option\Database\DatabasePortConfigOption::class,
+            Option\Database\DatabaseUserConfigOption::class,
+            Option\Database\DatabasePasswordConfigOption::class,
+            Option\Database\DatabaseUnixSocketConfigOption::class,
+            Option\Database\DatabaseUseEncryptionConfigOption::class,
+            Option\UrlShortener\ShortDomainHostConfigOption::class,
+            Option\UrlShortener\ShortDomainSchemaConfigOption::class,
+            Option\Redirect\BaseUrlRedirectConfigOption::class,
+            Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
+            Option\Redirect\Regular404RedirectConfigOption::class,
+            Option\Visit\VisitsThresholdConfigOption::class,
+            Option\BasePathConfigOption::class,
+            Option\TimezoneConfigOption::class,
+            Option\Cache\CacheNamespaceConfigOption::class,
+            Option\Redis\RedisServersConfigOption::class,
+            Option\Redis\RedisSentinelServiceConfigOption::class,
+            Option\Redis\RedisPubSubConfigOption::class,
+            Option\UrlShortener\ShortCodeLengthOption::class,
+            Option\Mercure\EnableMercureConfigOption::class,
+            Option\Mercure\MercurePublicUrlConfigOption::class,
+            Option\Mercure\MercureInternalUrlConfigOption::class,
+            Option\Mercure\MercureJwtSecretConfigOption::class,
+            Option\UrlShortener\GeoLiteLicenseKeyConfigOption::class,
+            Option\UrlShortener\RedirectStatusCodeConfigOption::class,
+            Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
+            Option\UrlShortener\RedirectCacheVisibilityConfigOption::class,
+            Option\UrlShortener\AutoResolveTitlesConfigOption::class,
+            Option\UrlShortener\ExtraPathModeConfigOption::class,
+            Option\UrlShortener\EnableMultiSegmentSlugsConfigOption::class,
+            Option\UrlShortener\EnableTrailingSlashConfigOption::class,
+            Option\UrlShortener\ShortUrlModeConfigOption::class,
+            Option\Robots\RobotsAllowAllShortUrlsConfigOption::class,
+            Option\Robots\RobotsUserAgentsConfigOption::class,
+            Option\Tracking\IpAnonymizationConfigOption::class,
+            Option\Tracking\OrphanVisitsTrackingConfigOption::class,
+            Option\Tracking\DisableTrackParamConfigOption::class,
+            Option\Tracking\DisableTrackingFromConfigOption::class,
+            Option\Tracking\DisableTrackingConfigOption::class,
+            Option\Tracking\DisableIpTrackingConfigOption::class,
+            Option\Tracking\DisableReferrerTrackingConfigOption::class,
+            Option\Tracking\DisableUaTrackingConfigOption::class,
+            Option\QrCode\DefaultSizeConfigOption::class,
+            Option\QrCode\DefaultMarginConfigOption::class,
+            Option\QrCode\DefaultFormatConfigOption::class,
+            Option\QrCode\DefaultErrorCorrectionConfigOption::class,
+            Option\QrCode\DefaultRoundBlockSizeConfigOption::class,
+            Option\QrCode\DefaultColorConfigOption::class,
+            Option\QrCode\DefaultBgColorConfigOption::class,
+            Option\QrCode\DefaultLogoUrlConfigOption::class,
+            Option\QrCode\EnabledForDisabledShortUrlsConfigOption::class,
+            Option\RabbitMq\RabbitMqEnabledConfigOption::class,
+            Option\RabbitMq\RabbitMqHostConfigOption::class,
+            Option\RabbitMq\RabbitMqUseSslConfigOption::class,
+            Option\RabbitMq\RabbitMqPortConfigOption::class,
+            Option\RabbitMq\RabbitMqUserConfigOption::class,
+            Option\RabbitMq\RabbitMqPasswordConfigOption::class,
+            Option\RabbitMq\RabbitMqVhostConfigOption::class,
+            Option\Matomo\MatomoEnabledConfigOption::class,
+            Option\Matomo\MatomoBaseUrlConfigOption::class,
+            Option\Matomo\MatomoSiteIdConfigOption::class,
+            Option\Matomo\MatomoApiTokenConfigOption::class,
+            Option\RealTimeUpdates\RealTimeUpdatesTopicsConfigOption::class,
+            Option\Cors\CorsAllowOriginConfigOption::class,
+            Option\Cors\CorsAllowCredentialsConfigOption::class,
+            Option\Cors\CorsMaxAgeConfigOption::class,
+            Option\TrustedProxiesConfigOption::class,
+        ],
+
+        'installation_commands' => [
+            InstallationCommand::DB_CREATE_SCHEMA->value => [
+                'command' => 'bin/cli ' . Command\Db\CreateDatabaseCommand::NAME,
+            ],
+            InstallationCommand::DB_MIGRATE->value => [
+                'command' => 'bin/cli ' . Command\Db\MigrateDatabaseCommand::NAME,
+            ],
+            InstallationCommand::ORM_PROXIES->value => [
+                'command' => 'bin/doctrine orm:generate-proxies',
+            ],
+            InstallationCommand::ORM_CLEAR_CACHE->value => [
+                'command' => 'bin/doctrine orm:clear-cache:metadata',
+            ],
+            InstallationCommand::GEOLITE_DOWNLOAD_DB->value => [
+                'command' => 'bin/cli ' . Command\Visit\DownloadGeoLiteDbCommand::NAME,
+            ],
+            InstallationCommand::API_KEY_GENERATE->value => [
+                'command' => 'bin/cli ' . Command\Api\GenerateKeyCommand::NAME,
+            ],
+            InstallationCommand::API_KEY_CREATE->value => [
+                'command' => 'bin/cli ' . Command\Api\InitialApiKeyCommand::NAME,
+            ],
+        ],
+    ],
+
+];

config/autoload/ip-address.global.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+use RKA\Middleware\IpAddress;
+use RKA\Middleware\Mezzio\IpAddressFactory;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\Middleware\ReverseForwardedAddressesMiddlewareDecorator;
+
+use function Shlinkio\Shlink\Core\splitByComma;
+
+use const Shlinkio\Shlink\IP_ADDRESS_REQUEST_ATTRIBUTE;
+
+return (static function (): array {
+    $trustedProxies = EnvVars::TRUSTED_PROXIES->loadFromEnv();
+    $proxiesIsHopCount = is_numeric($trustedProxies);
+
+    return [
+
+        // Configuration for RKA\Middleware\IpAddress
+        'rka' => [
+            'ip_address' => [
+                'attribute_name' => IP_ADDRESS_REQUEST_ATTRIBUTE,
+                'check_proxy_headers' => true,
+                // List of trusted proxies
+                'trusted_proxies' => $proxiesIsHopCount ? [] : splitByComma($trustedProxies),
+                // Amount of addresses to skip from the right, before finding the visitor IP address
+                'hop_count' => $proxiesIsHopCount ? (int) $trustedProxies : 0,
+                'headers_to_inspect' => [
+                    'CF-Connecting-IP',
+                    'X-Forwarded-For',
+                    'X-Forwarded',
+                    'Forwarded',
+                    'True-Client-IP',
+                    'X-Real-IP',
+                    'X-Cluster-Client-Ip',
+                    'Client-Ip',
+                ],
+            ],
+        ],
+
+        'dependencies' => [
+            'factories' => [
+                IpAddress::class => IpAddressFactory::class,
+            ],
+            'delegators' => [
+                // Make middleware decoration transparent to other parts of the code
+                IpAddress::class => [
+                    fn ($c, $n, callable $callback) =>
+                        // If trusted proxies have been provided, use original middleware verbatim, otherwise decorate
+                        // with workaround
+                        $trustedProxies !== null
+                            ? $callback()
+                            : new ReverseForwardedAddressesMiddlewareDecorator($callback()),
+                ],
+            ],
+
+        ],
+
+    ];
+})();

config/autoload/local.php.dist

@@ -1,8 +0,0 @@
-<?php
-
-return [
-
-    'debug' => true,
-    'config_cache_enabled' => false,
-
-];

config/autoload/locks.global.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Shlinkio\Shlink\Common\Cache\RedisFactory;
+use Shlinkio\Shlink\Common\Lock\NamespacedStore;
+use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Symfony\Component\Lock;
+
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
+
+return [
+
+    'locks' => [
+        'locks_dir' => __DIR__ . '/../../data/locks',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
+            Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
+            Lock\LockFactory::class => ConfigAbstractFactory::class,
+            LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
+            NamespacedStore::class => ConfigAbstractFactory::class,
+        ],
+        'aliases' => [
+            'lock_store' => EnvVars::REDIS_SERVERS->existsInEnv() ? 'redis_lock_store' : 'local_lock_store',
+
+            'redis_lock_store' => NamespacedStore::class,
+            'local_lock_store' => Lock\Store\FlockStore::class,
+        ],
+        'delegators' => [
+            Lock\LockFactory::class => [
+                LoggerAwareDelegatorFactory::class,
+            ],
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
+        Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
+        NamespacedStore::class => [Lock\Store\RedisStore::class, 'config.cache.namespace'],
+
+        Lock\LockFactory::class => ['lock_store'],
+        LOCAL_LOCK_FACTORY => ['local_lock_store'],
+    ],
+
+];

config/autoload/logger.global.php

@@ -1,32 +1,80 @@
 <?php
-use Monolog\Handler\RotatingFileHandler;
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Monolog\Level;
 use Monolog\Logger;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Shlinkio\Shlink\Common\Logger\LoggerFactory;
+use Shlinkio\Shlink\Common\Logger\LoggerType;
+use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\EventDispatcher\Helper\RequestIdProvider;
+use Shlinkio\Shlink\EventDispatcher\Util\RequestIdProviderInterface;
 
-return [
+use function Shlinkio\Shlink\Config\env;
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
-    'logger' => [
-        'formatters' => [
-            'dashed' => [
-                'format' => '[%datetime%] %channel%.%level_name% - %message% %context%' . PHP_EOL,
-                'include_stacktraces' => true,
+return (static function (): array {
+    $isDev = EnvVars::isDevEnv();
+    $format = EnvVars::LOGS_FORMAT->loadFromEnv();
+    $buildCommonConfig = static fn (bool $addNewLine = false) => [
+        'level' => $isDev ? Level::Debug->value : Level::Info->value,
+        'processors' => [RequestIdMiddleware::class],
+        'formatter' => [
+            'type' => $format,
+            'add_new_line' => $addNewLine,
+            'line_format' =>
+                '[%datetime%] [%extra.' . RequestIdMiddleware::ATTRIBUTE . '%] %channel%.%level_name% - %message%',
+        ],
+    ];
+
+    // In dev env or the docker container, stream Shlink logs to stderr, otherwise send them to a file
+    $useStreamForShlinkLogger = $isDev || env('SHLINK_RUNTIME') !== null;
+
+    return [
+
+        'logger' => [
+            'Shlink' => $useStreamForShlinkLogger ? [
+                'type' => LoggerType::STREAM->value,
+                'destination' => 'php://stderr',
+                ...$buildCommonConfig(),
+            ] : [
+                'type' => LoggerType::FILE->value,
+                ...$buildCommonConfig(),
+            ],
+            'Access' => [
+                'type' => LoggerType::STREAM->value,
+                'destination' => 'php://stderr',
+                ...$buildCommonConfig(! runningInRoadRunner()),
             ],
         ],
 
-        'handlers' => [
-            'rotating_file_handler' => [
-                'class' => RotatingFileHandler::class,
-                'level' => Logger::INFO,
-                'filename' => 'data/log/shlink_log.log',
-                'max_files' => 30,
-                'formatter' => 'dashed',
+        'dependencies' => [
+            'factories' => [
+                'Logger_Shlink' => [LoggerFactory::class, 'Shlink'],
+                'Logger_Access' => [LoggerFactory::class, 'Access'],
+                NullLogger::class => InvokableFactory::class,
+                RequestIdProvider::class => ConfigAbstractFactory::class,
+            ],
+            'aliases' => [
+                'logger' => 'Logger_Shlink',
+                Logger::class => 'Logger_Shlink',
+                LoggerInterface::class => 'Logger_Shlink',
+                AccessLogMiddleware::LOGGER_SERVICE_NAME => 'Logger_Access',
+                RequestIdProviderInterface::class => RequestIdProvider::class,
             ],
         ],
 
-        'loggers' => [
-            'Shlink' => [
-                'handlers' => ['rotating_file_handler'],
-            ],
+        ConfigAbstractFactory::class => [
+            RequestIdProvider::class => [RequestIdMiddleware::class],
         ],
-    ],
 
-];
+    ];
+})();

config/autoload/logger.local.php.dist

@@ -1,14 +0,0 @@
-<?php
-use Monolog\Logger;
-
-return [
-
-    'logger' => [
-        'handlers' => [
-            'rotating_file_handler' => [
-                'level' => Logger::DEBUG,
-            ],
-        ],
-    ],
-
-];

config/autoload/mercure.global.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\Proxy\LazyServiceFactory;
+use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Symfony\Component\Mercure\Hub;
+use Symfony\Component\Mercure\HubInterface;
+
+return [
+
+    // This config is used by shlink-common. Do not delete
+    'mercure' => [
+        'enabled' => EnvVars::MERCURE_ENABLED->loadFromEnv(),
+        'public_hub_url' => EnvVars::MERCURE_PUBLIC_HUB_URL->loadFromEnv(),
+        'internal_hub_url' => EnvVars::MERCURE_INTERNAL_HUB_URL->loadFromEnv(),
+        'jwt_secret' => EnvVars::MERCURE_JWT_SECRET->loadFromEnv(),
+        'jwt_issuer' => 'Shlink',
+    ],
+
+    'dependencies' => [
+        'delegators' => [
+            LcobucciJwtProvider::class => [
+                LazyServiceFactory::class,
+            ],
+            Hub::class => [
+                LazyServiceFactory::class,
+            ],
+        ],
+        'lazy_services' => [
+            'class_map' => [
+                LcobucciJwtProvider::class => LcobucciJwtProvider::class,
+                Hub::class => HubInterface::class,
+            ],
+        ],
+    ],
+
+];

config/autoload/middleware-pipeline.global.php

@@ -1,21 +1,85 @@
 <?php
-use Zend\Expressive\Container\ApplicationFactory;
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Laminas\Stratigility\Middleware\ErrorHandler;
+use Mezzio\ProblemDetails;
+use Mezzio\Router;
+use RKA\Middleware\IpAddress;
+use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
+use Shlinkio\Shlink\Common\Middleware\ContentLengthMiddleware;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
+use Shlinkio\Shlink\Core\Geolocation\Middleware\IpGeolocationMiddleware;
 
 return [
 
     'middleware_pipeline' => [
-        'routing' => [
+        'error-handler' => [
             'middleware' => [
-                ApplicationFactory::ROUTING_MIDDLEWARE,
+                AccessLogMiddleware::class,
+                ContentLengthMiddleware::class,
+                RequestIdMiddleware::class,
+                ErrorHandler::class,
+                Rest\Middleware\CrossDomainMiddleware::class,
+            ],
+        ],
+        'error-handler-rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                ProblemDetails\ProblemDetailsMiddleware::class,
             ],
-            'priority' => 10,
         ],
 
-        'post-routing' => [
+        'pre-routing' => [
             'middleware' => [
-                ApplicationFactory::DISPATCH_MIDDLEWARE,
+                Common\Middleware\CloseDbConnectionMiddleware::class,
+            ],
+        ],
+
+        'routing' => [
+            'middleware' => [
+                Router\Middleware\RouteMiddleware::class,
+                Router\Middleware\ImplicitHeadMiddleware::class,
+            ],
+        ],
+
+        'rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                Router\Middleware\ImplicitOptionsMiddleware::class,
+                Rest\Middleware\BodyParserMiddleware::class,
+                Rest\Middleware\AuthenticationMiddleware::class,
+            ],
+        ],
+
+        'dispatch' => [
+            'middleware' => [
+                Router\Middleware\DispatchMiddleware::class,
+            ],
+        ],
+
+        'not-found-rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                ProblemDetails\ProblemDetailsNotFoundHandler::class,
+            ],
+        ],
+        'not-found' => [
+            'middleware' => [
+                // These two middlewares are in front of other tracking actions.
+                // Putting them here for orphan visits tracking
+                IpAddress::class,
+                IpGeolocationMiddleware::class,
+
+                Core\ErrorHandler\NotFoundTypeResolverMiddleware::class,
+                Core\ShortUrl\Middleware\ExtraPathRedirectMiddleware::class,
+                Core\ErrorHandler\NotFoundTrackerMiddleware::class,
+                Core\ErrorHandler\NotFoundRedirectHandler::class,
+                Core\ErrorHandler\NotFoundTemplateHandler::class,
             ],
-            'priority' => 1,
         ],
     ],
+
 ];

config/autoload/rabbit.global.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    // This config is used by shlink-common. Do not delete
+    'rabbitmq' => [
+        'enabled' => (bool) EnvVars::RABBITMQ_ENABLED->loadFromEnv(),
+        'host' => EnvVars::RABBITMQ_HOST->loadFromEnv(),
+        'use_ssl' => (bool) EnvVars::RABBITMQ_USE_SSL->loadFromEnv(),
+        'port' => (int) EnvVars::RABBITMQ_PORT->loadFromEnv(),
+        'user' => EnvVars::RABBITMQ_USER->loadFromEnv(),
+        'password' => EnvVars::RABBITMQ_PASSWORD->loadFromEnv(),
+        'vhost' => EnvVars::RABBITMQ_VHOST->loadFromEnv(),
+    ],
+
+];

config/autoload/router.global.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Mezzio\Router\FastRouteRouter;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'router' => [
+        'base_path' => EnvVars::BASE_PATH->loadFromEnv(),
+
+        'fastroute' => [
+            // Disabling config cache for cli, ensures it's never used for RoadRunner, and also that console
+            // commands don't generate a cache file that's then used by php-fpm web executions
+            FastRouteRouter::CONFIG_CACHE_ENABLED => EnvVars::isProdEnv() && PHP_SAPI !== 'cli',
+            FastRouteRouter::CONFIG_CACHE_FILE => 'data/cache/fastroute_cached_routes.php',
+        ],
+    ],
+
+];

config/autoload/routes.config.php

@@ -0,0 +1,119 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Fig\Http\Message\RequestMethodInterface;
+use RKA\Middleware\IpAddress;
+use Shlinkio\Shlink\Core\Action as CoreAction;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\Geolocation\Middleware\IpGeolocationMiddleware;
+use Shlinkio\Shlink\Core\ShortUrl\Middleware\TrimTrailingSlashMiddleware;
+use Shlinkio\Shlink\Rest\Action;
+use Shlinkio\Shlink\Rest\ConfigProvider;
+use Shlinkio\Shlink\Rest\Middleware;
+use Shlinkio\Shlink\Rest\Middleware\Mercure\NotConfiguredMercureErrorHandler;
+
+use function sprintf;
+
+return (static function (): array {
+    $dropDomainMiddleware = Middleware\ShortUrl\DropDefaultDomainFromRequestMiddleware::class;
+    $overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class;
+    $shortUrlRouteSuffix = EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv() ? '[/]' : '';
+
+    return [
+
+        // The order of the routes defined here matters. Changing it might cause path conflicts
+        'routes' => [
+            // Rest
+            ...ConfigProvider::applyRoutesPrefix([
+                Action\HealthAction::getRouteDef(),
+
+                // Visits and rules routes must go first, as they have a more specific path, otherwise, when
+                // multi-segment slugs are enabled, routes with a less-specific path might match first
+
+                // Visits.
+                Action\Visit\ShortUrlVisitsAction::getRouteDef([$dropDomainMiddleware]),
+                Action\ShortUrl\DeleteShortUrlVisitsAction::getRouteDef([$dropDomainMiddleware]),
+                Action\Visit\TagVisitsAction::getRouteDef(),
+                Action\Visit\DomainVisitsAction::getRouteDef(),
+                Action\Visit\GlobalVisitsAction::getRouteDef(),
+                Action\Visit\OrphanVisitsAction::getRouteDef(),
+                Action\Visit\DeleteOrphanVisitsAction::getRouteDef(),
+                Action\Visit\NonOrphanVisitsAction::getRouteDef(),
+
+                //Redirect rules
+                Action\RedirectRule\ListRedirectRulesAction::getRouteDef([$dropDomainMiddleware]),
+                Action\RedirectRule\SetRedirectRulesAction::getRouteDef([$dropDomainMiddleware]),
+
+                // Short URLs
+                Action\ShortUrl\CreateShortUrlAction::getRouteDef([
+                    $dropDomainMiddleware,
+                    $overrideDomainMiddleware,
+                    Middleware\ShortUrl\DefaultShortCodesLengthMiddleware::class,
+                ]),
+                Action\ShortUrl\SingleStepCreateShortUrlAction::getRouteDef([
+                    Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class,
+                    $overrideDomainMiddleware,
+                ]),
+                Action\ShortUrl\EditShortUrlAction::getRouteDef([$dropDomainMiddleware]),
+                Action\ShortUrl\DeleteShortUrlAction::getRouteDef([$dropDomainMiddleware]),
+                Action\ShortUrl\ResolveShortUrlAction::getRouteDef([$dropDomainMiddleware]),
+                Action\ShortUrl\ListShortUrlsAction::getRouteDef(),
+
+                // Tags
+                Action\Tag\ListTagsAction::getRouteDef(),
+                Action\Tag\TagsStatsAction::getRouteDef(),
+                Action\Tag\DeleteTagsAction::getRouteDef(),
+                Action\Tag\UpdateTagAction::getRouteDef(),
+
+                // Domains
+                Action\Domain\ListDomainsAction::getRouteDef(),
+                Action\Domain\DomainRedirectsAction::getRouteDef(),
+
+                Action\MercureInfoAction::getRouteDef([NotConfiguredMercureErrorHandler::class]),
+            ]),
+
+            // Non-rest
+            [
+                'name' => CoreAction\RobotsAction::class,
+                'path' => '/robots.txt',
+                'middleware' => [
+                    CoreAction\RobotsAction::class,
+                ],
+                'allowed_methods' => [RequestMethodInterface::METHOD_GET],
+            ],
+            [
+                'name' => CoreAction\PixelAction::class,
+                'path' => '/{shortCode}/track',
+                'middleware' => [
+                    IpAddress::class,
+                    IpGeolocationMiddleware::class,
+                    CoreAction\PixelAction::class,
+                ],
+                'allowed_methods' => [RequestMethodInterface::METHOD_GET],
+            ],
+            [
+                'name' => CoreAction\QrCodeAction::class,
+                'path' => '/{shortCode}/qr-code',
+                'middleware' => [
+                    CoreAction\QrCodeAction::class,
+                ],
+                'allowed_methods' => [RequestMethodInterface::METHOD_GET],
+            ],
+            [
+                'name' => CoreAction\RedirectAction::class,
+                'path' => sprintf('/{shortCode}%s', $shortUrlRouteSuffix),
+                'middleware' => [
+                    IpAddress::class,
+                    IpGeolocationMiddleware::class,
+                    TrimTrailingSlashMiddleware::class,
+                    CoreAction\RedirectAction::class,
+                ],
+                'allowed_methods' => [RequestMethodInterface::METHOD_GET],
+            ],
+        ],
+
+    ];
+})();

config/autoload/templates.global.php

@@ -1,12 +0,0 @@
-<?php
-
-return [
-
-    'twig' => [
-        'cache_dir'  => 'data/cache/twig',
-        'extensions' => [
-            // extension service names or instances
-        ],
-    ],
-
-];

config/autoload/translator.global.php

@@ -1,8 +0,0 @@
-<?php
-return [
-
-    'translator' => [
-        'locale' => env('DEFAULT_LOCALE', 'en'),
-    ],
-
-];

config/autoload/url-shortener.global.php

@@ -1,14 +0,0 @@
-<?php
-use Shlinkio\Shlink\Core\Service\UrlShortener;
-
-return [
-
-    'url_shortener' => [
-        'domain' => [
-            'schema' => env('SHORTENED_URL_SCHEMA', 'http'),
-            'hostname' => env('SHORTENED_URL_HOSTNAME'),
-        ],
-        'shortcode_chars' => env('SHORTCODE_CHARS', UrlShortener::DEFAULT_CHARS),
-    ],
-
-];

config/autoload/zend-expressive.global.php

@@ -1,8 +0,0 @@
-<?php
-
-return [
-
-    'debug' => false,
-    'config_cache_enabled' => true,
-
-];

config/cli-app.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Console\Application as CliApp;
+
+return (static function (): CliApp {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/container.php';
+    return $container->get(CliApp::class);
+})();

config/cli-config.php

@@ -1,11 +1,27 @@
 <?php
-use Doctrine\ORM\EntityManager;
-use Doctrine\ORM\Tools\Console\ConsoleRunner;
-use Interop\Container\ContainerInterface;
 
-/** @var ContainerInterface $container */
-$container = include __DIR__ . '/container.php';
-/** @var EntityManager $em */
-$em = $container->get(EntityManager::class);
+declare(strict_types=1);
 
-return ConsoleRunner::createHelperSet($em);
+use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
+use Doctrine\Migrations\Configuration\Migration\ConfigurationArray;
+use Doctrine\Migrations\DependencyFactory;
+
+// This file is currently used by doctrine migrations only
+
+return (static function () {
+    $migrationsConfig = [
+        'migrations_paths' => [
+            'ShlinkMigrations' => 'module/Core/migrations',
+        ],
+        'table_storage' => [
+            'table_name' => 'migrations',
+        ],
+        'custom_template' => 'data/migrations_template.txt',
+    ];
+    $em = include __DIR__ . '/entity-manager.php';
+
+    return DependencyFactory::fromEntityManager(
+        new ConfigurationArray($migrationsConfig),
+        new ExistingEntityManager($em),
+    );
+})();

config/config.php

@@ -1,24 +1,42 @@
 <?php
-use Shlinkio\Shlink\CLI;
-use Shlinkio\Shlink\Common;
-use Shlinkio\Shlink\Core;
-use Shlinkio\Shlink\Rest;
-use Zend\Expressive\ConfigManager\ConfigManager;
-use Zend\Expressive\ConfigManager\ZendConfigProvider;
 
-/**
- * Configuration files are loaded in a specific order. First ``global.php``, then ``*.global.php``.
- * then ``local.php`` and finally ``*.local.php``. This way local settings overwrite global settings.
- *
- * The configuration can be cached. This can be done by setting ``config_cache_enabled`` to ``true``.
- *
- * Obviously, if you use closures in your config you can't cache it.
- */
+declare(strict_types=1);
 
-return (new ConfigManager([
-    Common\ConfigProvider::class,
-    Core\ConfigProvider::class,
-    CLI\ConfigProvider::class,
-    Rest\ConfigProvider::class,
-    new ZendConfigProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
-], 'data/cache/app_config.php'))->getMergedConfig();
+namespace Shlinkio\Shlink;
+
+use Laminas\ConfigAggregator;
+use Laminas\Diactoros;
+use Mezzio;
+use Mezzio\ProblemDetails;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return (new ConfigAggregator\ConfigAggregator(
+    providers: [
+        Mezzio\ConfigProvider::class,
+        Mezzio\Router\ConfigProvider::class,
+        Mezzio\Router\FastRouteRouter\ConfigProvider::class,
+        ProblemDetails\ConfigProvider::class,
+        Diactoros\ConfigProvider::class,
+        Common\ConfigProvider::class,
+        Config\ConfigProvider::class,
+        Importer\ConfigProvider::class,
+        IpGeolocation\ConfigProvider::class,
+        EventDispatcher\ConfigProvider::class,
+        Core\ConfigProvider::class,
+        CLI\ConfigProvider::class,
+        Rest\ConfigProvider::class,
+        new ConfigAggregator\PhpFileProvider('config/autoload/{,*.}global.php'),
+        // Test config should be loaded ONLY during tests
+        EnvVars::isTestEnv()
+            ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
+            : new ConfigAggregator\ArrayProvider([]),
+        // Routes have to be loaded last
+        new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
+    ],
+    cachedConfigFile: 'data/cache/app_config.php',
+    postProcessors: [
+        Core\Config\PostProcessor\BasePathPrefixer::class,
+        Core\Config\PostProcessor\MultiSegmentSlugProcessor::class,
+        Core\Config\PostProcessor\ShortUrlMethodsProcessor::class,
+    ],
+))->getMergedConfig();

config/constants.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Shlinkio\Shlink\Core\Util\RedirectStatus;
+
+const DEFAULT_DELETE_SHORT_URL_THRESHOLD = 15;
+const DEFAULT_SHORT_CODES_LENGTH = 5;
+const MIN_SHORT_CODES_LENGTH = 4;
+const DEFAULT_REDIRECT_STATUS_CODE = RedirectStatus::STATUS_302;
+const DEFAULT_REDIRECT_CACHE_LIFETIME = 30;
+const DEFAULT_REDIRECT_CACHE_VISIBILITY = 'private';
+const LOCAL_LOCK_FACTORY = 'Shlinkio\Shlink\LocalLockFactory';
+const LOOSE_URI_MATCHER = '/(.+)\:(.+)/i'; // Matches anything starting with a schema.
+const IP_ADDRESS_REQUEST_ATTRIBUTE = 'remote_address';
+const REDIRECT_URL_REQUEST_ATTRIBUTE = 'redirect_url';
+
+/**
+ * List of ISO 3166-1 alpha-2 two-letter country codes https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+ */
+const ISO_COUNTRY_CODES = [
+    'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ',
+    'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BQ', 'BA', 'BW', 'BV', 'BR',
+    'IO', 'BN', 'BG', 'BF', 'BI', 'CV', 'KH', 'CM', 'CA', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC',
+    'CO', 'KM', 'CG', 'CD', 'CK', 'CR', 'CI', 'HR', 'CU', 'CW', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO',
+    'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'SZ', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF',
+    'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY',
+    'HT', 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT', 'JM',
+    'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY',
+    'LI', 'LT', 'LU', 'MO', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX',
+    'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'NC', 'NZ', 'NI',
+    'NE', 'NG', 'NU', 'NF', 'MK', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH',
+    'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC',
+    'WS', 'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS',
+    'SS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK',
+    'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU',
+    'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW',
+];
+
+/** @deprecated */
+const DEFAULT_QR_CODE_SIZE = 300;
+/** @deprecated */
+const DEFAULT_QR_CODE_MARGIN = 0;
+/** @deprecated */
+const DEFAULT_QR_CODE_FORMAT = 'png';
+/** @deprecated */
+const DEFAULT_QR_CODE_ERROR_CORRECTION = 'l';
+/** @deprecated */
+const DEFAULT_QR_CODE_ROUND_BLOCK_SIZE = true;
+/** @deprecated */
+const DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS = true;
+/** @deprecated */
+const DEFAULT_QR_CODE_COLOR = '#000000'; // Black
+/** @deprecated */
+const DEFAULT_QR_CODE_BG_COLOR = '#ffffff'; // White

config/container.php

@@ -1,21 +1,45 @@
 <?php
-use Dotenv\Dotenv;
-use Zend\ServiceManager\ServiceManager;
 
+declare(strict_types=1);
+
+use Laminas\ServiceManager\ServiceManager;
+use Shlinkio\Shlink\Core\Config\EnvVars;
+use Symfony\Component\Lock;
+
+use function Shlinkio\Shlink\Config\loadEnvVarsFromConfig;
+use function Shlinkio\Shlink\Core\enumValues;
+
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
+
+// Set current directory to the project's root directory
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
-// If the Dotenv class exists, load env vars and enable errors
-if (class_exists(Dotenv::class)) {
-    error_reporting(E_ALL);
-    ini_set('display_errors', 1);
-    $dotenv = new Dotenv(__DIR__ . '/..');
-    $dotenv->load();
+// Promote env vars from installer, dev config or test config
+loadEnvVarsFromConfig(
+    EnvVars::isTestEnv() ? 'config/test/shlink_test_env.php' : 'config/params/*.php',
+    enumValues(EnvVars::class),
+);
+
+// This is one of the first files loaded. Set global configuration here
+error_reporting(
+    // Set a less strict error reporting for prod, where deprecation warnings should be ignored
+    EnvVars::isProdEnv() ? E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED : E_ALL,
+);
+ini_set('memory_limit', EnvVars::MEMORY_LIMIT->loadFromEnv());
+date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv());
+
+// This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
+// It needs to be placed here as individual config files will not be loaded once config is cached
+if (! class_exists(LOCAL_LOCK_FACTORY)) {
+    class_alias(Lock\LockFactory::class, LOCAL_LOCK_FACTORY);
 }
 
-// Build container
-$config = require __DIR__ . '/config.php';
-$container = new ServiceManager($config['dependencies']);
-$container->setService('config', $config);
-return $container;
+return (static function (): ServiceManager {
+    $config = require __DIR__ . '/config.php';
+    $container = new ServiceManager($config['dependencies']);
+    $container->setService('config', $config);
+
+    return $container;
+})();

config/entity-manager.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
+use Psr\Container\ContainerInterface;
+
+return (static function (): EntityManagerInterface {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/container.php';
+    return $container->get(EntityManager::class);
+})();

config/params/.gitignore

@@ -0,0 +1,3 @@
+*
+!.gitignore
+!*.dist

config/params/shlink_dev_env.php.dist

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    EnvVars::APP_ENV->value => 'dev',
+//    EnvVars::GEOLITE_LICENSE_KEY->value => '',
+
+    // URL shortener
+    EnvVars::DEFAULT_DOMAIN->value => 'localhost:8800',
+    EnvVars::IS_HTTPS_ENABLED->value => false,
+
+    // Database - MySQL
+    EnvVars::DB_DRIVER->value => 'mysql',
+    EnvVars::DB_USER->value => 'root',
+    EnvVars::DB_PASSWORD->value => 'root',
+    EnvVars::DB_NAME->value => 'shlink',
+//    EnvVars::DB_NAME->value => 'shlink_foo',
+    EnvVars::DB_HOST->value => 'shlink_db_mysql',
+
+    // Database - Maria
+//    EnvVars::DB_DRIVER->value => 'maria',
+//    EnvVars::DB_USER->value => 'root',
+//    EnvVars::DB_PASSWORD->value => 'root',
+//    EnvVars::DB_NAME->value => 'shlink_foo',
+//    EnvVars::DB_HOST->value => 'shlink_db_maria',
+
+    // Database - Postgres
+//    EnvVars::DB_DRIVER->value => 'postgres',
+//    EnvVars::DB_USER->value => 'postgres',
+//    EnvVars::DB_PASSWORD->value => 'root',
+//    EnvVars::DB_NAME->value => 'shlink_foo',
+//    EnvVars::DB_HOST->value => 'shlink_db_postgres',
+
+    // Database - MSSQL
+//    EnvVars::DB_DRIVER->value => 'mssql',
+//    EnvVars::DB_USER->value => 'sa',
+//    EnvVars::DB_PASSWORD->value => 'Passw0rd!',
+//    EnvVars::DB_NAME->value => 'shlink_foo',
+//    EnvVars::DB_HOST->value => 'shlink_db_ms',
+
+    // Matomo
+    // Dev matomo instance needs to be manually configured once before enabling the configuration below:
+    // 1. Go to http://localhost:8003 and follow the installation instructions.
+    // 2. Open data/infra/matomo/config/config.ini.php and replace `trusted_hosts[] = "localhost"` with
+    //   `trusted_hosts[] = "localhost:8003"` (see https://github.com/matomo-org/matomo/issues/9549)
+    // 3. Go to http://localhost:8003/index.php?module=SitesManager&action=index and paste the ID for the site you just
+    //    created into the `MATOMO_SITE_ID` var below.
+    // 4. Go to http://localhost:8003/index.php?module=UsersManager&action=userSecurity, scroll down, click
+    //    "Create new token" and once generated, paste the token into the `MATOMO_API_TOKEN` var below.
+    // 5. Copy the config below and paste it in a new shlink-dev.local.env file.
+    EnvVars::MATOMO_ENABLED->value => false,
+    EnvVars::MATOMO_BASE_URL->value => 'http://shlink_matomo',
+//    EnvVars::MATOMO_SITE_ID->value => ,
+//    EnvVars::MATOMO_API_TOKEN->value => ,
+
+    // Mercure
+    EnvVars::MERCURE_ENABLED->value => true,
+    EnvVars::MERCURE_PUBLIC_HUB_URL->value => 'http://localhost:8002',
+    EnvVars::MERCURE_INTERNAL_HUB_URL->value => 'http://shlink_mercure_proxy',
+    EnvVars::MERCURE_JWT_SECRET->value => 'mercure_jwt_key_long_enough_to_avoid_error',
+
+    // RabbitMQ
+    EnvVars::RABBITMQ_ENABLED->value => true,
+    EnvVars::RABBITMQ_HOST->value => 'shlink_rabbitmq',
+    EnvVars::RABBITMQ_PORT->value => 5672,
+    EnvVars::RABBITMQ_USER->value => 'rabbit',
+    EnvVars::RABBITMQ_PASSWORD->value => 'rabbit',
+
+    // Redis
+    EnvVars::REDIS_PUB_SUB_ENABLED->value => true,
+    EnvVars::REDIS_SERVERS->value => 'tcp://shlink_redis:6379',
+
+];

config/roadrunner/.rr.dev.yml

@@ -0,0 +1,46 @@
+version: '3'
+
+rpc:
+  listen: tcp://127.0.0.1:6001
+
+server:
+  command: 'php ../../bin/roadrunner-worker.php'
+
+http:
+  address: '0.0.0.0:8080'
+  middleware: ['static']
+  static:
+    dir: '../../public'
+    forbid: ['.php', '.htaccess']
+  pool:
+    num_workers: 1
+    debug: true
+
+jobs:
+  pool:
+    num_workers: 1
+    debug: true
+  timeout: 300
+  consume: ['shlink']
+  pipelines:
+    shlink:
+      driver: memory
+      config:
+        priority: 10
+        prefetch: 10
+
+logs:
+  encoding: console
+  mode: development
+  channels:
+    http:
+      mode: 'off' # Disable logging as Shlink handles it internally
+    server:
+      encoding: console
+      level: info
+    metrics:
+      encoding: console
+      level: debug
+    jobs:
+      encoding: console
+      level: debug

config/roadrunner/.rr.test.yml

@@ -0,0 +1,50 @@
+version: '3'
+
+############################################################################################
+# Routes here need to be relative to the project root, as API tests are run with `-w .`    #
+# See https://github.com/orgs/roadrunner-server/discussions/1440#discussioncomment-8486186 #
+############################################################################################
+
+rpc:
+    listen: tcp://127.0.0.1:6001
+
+server:
+    command: 'php ./bin/roadrunner-worker.php'
+
+http:
+    address: '0.0.0.0:9999'
+    middleware: ['static']
+    static:
+        dir: './public'
+        forbid: ['.php', '.htaccess']
+    pool:
+        num_workers: 1
+        debug: false
+
+jobs:
+    pool:
+        num_workers: 1
+        debug: false
+    timeout: 300
+    consume: ['shlink']
+    pipelines:
+        shlink:
+            driver: memory
+            config:
+                priority: 10
+                prefetch: 10
+
+logs:
+    encoding: console
+    mode: development
+    channels:
+        http:
+            mode: 'off' # Disable logging as Shlink handles it internally
+        server:
+            encoding: console
+            level: info
+        metrics:
+            level: panic
+        jobs:
+            encoding: console
+            level: panic

config/roadrunner/.rr.yml

@@ -0,0 +1,43 @@
+version: '3'
+
+rpc:
+  listen: tcp://127.0.0.1:6001
+
+server:
+  command: 'php -dopcache.enable_cli=1 -dopcache.validate_timestamps=0 ../../bin/roadrunner-worker.php'
+
+http:
+  address: '${ADDRESS:-0.0.0.0}:${PORT:-8080}'
+  middleware: ['static']
+  static:
+    dir: '../../public'
+    forbid: ['.php', '.htaccess']
+  pool:
+    num_workers: ${WEB_WORKER_NUM:-0}
+    max_jobs: 250 # Restart worker after processing this amount of requests to mitigate memory leaks
+
+jobs:
+  timeout: 300 # 5 minutes
+  pool:
+    num_workers: ${TASK_WORKER_NUM:-0}
+    max_jobs: 250 # Restart worker after processing this amount of jobs to mitigate memory leaks
+  consume: ['shlink']
+  pipelines:
+    shlink:
+      driver: memory
+      config:
+        priority: 10
+        prefetch: 10
+
+logs:
+  encoding: ${LOGS_FORMAT:-console}
+  mode: production
+  channels:
+    http:
+      mode: 'off' # Disable logging as Shlink handles it internally
+    server:
+      encoding: ${LOGS_FORMAT:-console}
+      level: info
+    jobs:
+      encoding: ${LOGS_FORMAT:-console}
+      level: debug

config/run.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use Mezzio\Application;
+use Psr\Container\ContainerInterface;
+
+return static function (): void {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/container.php';
+    $app = $container->get(Application::class);
+
+    $app->run();
+};

config/test/bootstrap_api_tests.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Doctrine\ORM\EntityManager;
+use Psr\Container\ContainerInterface;
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$testHelper = $container->get(Helper\TestHelper::class);
+$config = $container->get('config');
+$em = $container->get(EntityManager::class);
+$httpClient = $container->get('shlink_test_api_client');
+
+$testHelper->createTestDb(
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
+);
+ApiTest\ApiTestCase::setApiClient($httpClient);
+ApiTest\ApiTestCase::setSeedFixturesCallback(fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []));

config/test/bootstrap_cli_tests.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Doctrine\ORM\EntityManager;
+use Psr\Container\ContainerInterface;
+
+use function file_exists;
+use function unlink;
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$testHelper = $container->get(Helper\TestHelper::class);
+$config = $container->get('config');
+$em = $container->get(EntityManager::class);
+
+// Delete old coverage in PHP, to avoid merging older executions with current one
+$covFile = __DIR__ . '/../../build/coverage-cli.cov';
+if (file_exists($covFile)) {
+    unlink($covFile);
+}
+
+$testHelper->createTestDb(
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
+);
+CliTest\CliTestCase::setSeedFixturesCallback(
+    static fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []),
+);

config/test/bootstrap_db_tests.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Psr\Container\ContainerInterface;
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$container->get(Helper\TestHelper::class)->createTestDb(
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
+);
+DbTest\DatabaseTestCase::setEntityManager($container->get('em'));

config/test/constants.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink;
+
+const API_TESTS_HOST = '127.0.0.1';
+const API_TESTS_PORT = 9999;
+
+const ANDROID_USER_AGENT = 'Mozilla/5.0 (Linux; Android 13) AppleWebKit/537.36 (KHTML, like Gecko) '
+    . 'Chrome/109.0.5414.86 Mobile Safari/537.36';
+const IOS_USER_AGENT = 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_2 like Mac OS X) AppleWebKit/605.1.15 '
+    . '(KHTML, like Gecko) FxiOS/109.0 Mobile/15E148 Safari/605.1.15';
+const WINDOWS_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) '
+    . 'Chrome/138.0.0.0 Safari/537.36 Edg/138.0.3351.95';
+const LINUX_USER_AGENT = 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) '
+    . 'HeadlessChrome/81.0.4044.113 Safari/537.36';
+const MACOS_USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 15_5) AppleWebKit/605.1.15 (KHTML, like Gecko) '
+    . 'Version/18.4 Safari/605.1.15';
+const CHROMEOS_USER_AGENT = 'Mozilla/5.0 (X11; CrOS x86_64 16181.61.0) AppleWebKit/537.36 (KHTML, like Gecko) '
+    . 'Chrome/134.0.6998.198 Safari/537.36';

config/test/shlink_test_env.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    EnvVars::APP_ENV->value => 'test',
+
+    // URL shortener
+    EnvVars::DEFAULT_DOMAIN->value => 's.test',
+    EnvVars::IS_HTTPS_ENABLED->value => false,
+
+];

config/test/test_config.global.php

@@ -0,0 +1,149 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use GuzzleHttp\Client;
+use Laminas\ConfigAggregator\ConfigAggregator;
+use Laminas\Diactoros\Response\HtmlResponse;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Mezzio\Router\FastRouteRouter;
+use Monolog\Level;
+use Shlinkio\Shlink\Common\Logger\LoggerType;
+use Shlinkio\Shlink\TestUtils\ApiTest\CoverageMiddleware;
+use Shlinkio\Shlink\TestUtils\CliTest\CliCoverageDelegator;
+use Shlinkio\Shlink\TestUtils\Helper\CoverageHelper;
+use Symfony\Component\Console\Application;
+
+use function Laminas\Stratigility\middleware;
+use function Shlinkio\Shlink\Config\env;
+use function sleep;
+use function sprintf;
+
+use const ShlinkioTest\Shlink\API_TESTS_HOST;
+use const ShlinkioTest\Shlink\API_TESTS_PORT;
+
+$testEnv = env('TEST_ENV');
+$isApiTest = $testEnv === 'api';
+$isCliTest = $testEnv === 'cli';
+$isE2eTest = $isApiTest || $isCliTest;
+
+$coverageType = env('GENERATE_COVERAGE');
+$generateCoverage = $coverageType === 'yes';
+$coverage = $isE2eTest && $generateCoverage ? CoverageHelper::createCoverageForDirectories(
+    [
+        __DIR__ . '/../../module/Core/src',
+        __DIR__ . '/../../module/' . ($isApiTest ? 'Rest' : 'CLI') . '/src',
+    ],
+    __DIR__ . '/../../build/coverage-' . $testEnv,
+) : null;
+
+$buildDbConnection = static function (): array {
+    $driver = env('DB_DRIVER', 'sqlite');
+    $isCi = env('CI', false);
+    $getCiMysqlPort = static fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
+
+    return match ($driver) {
+        'sqlite' => [
+            'driver' => 'pdo_sqlite',
+            'memory' => true,
+        ],
+        'postgres' => [
+            'driver' => 'pdo_pgsql',
+            'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
+            'port' => $isCi ? '5434' : '5432',
+            'user' => 'postgres',
+            'password' => 'root',
+            'dbname' => 'shlink_test',
+            'charset' => 'utf8',
+        ],
+        'mssql' => [
+            'driver' => 'pdo_sqlsrv',
+            'host' => $isCi ? '127.0.0.1' : 'shlink_db_ms',
+            'user' => 'sa',
+            'password' => 'Passw0rd!',
+            'dbname' => 'shlink_test',
+            'driverOptions' => [
+                'TrustServerCertificate' => 'true',
+            ],
+        ],
+        default => [ // mysql and maria
+            'driver' => 'pdo_mysql',
+            'host' => $isCi ? '127.0.0.1' : sprintf('shlink_db_%s', $driver),
+            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
+            'user' => 'root',
+            'password' => 'root',
+            'dbname' => 'shlink_test',
+            'charset' => 'utf8mb4',
+        ],
+    };
+};
+
+$buildTestLoggerConfig = static fn (string $filename) => [
+    'level' => Level::Debug->value,
+    'type' => LoggerType::STREAM->value,
+    'destination' => sprintf('data/log/api-tests/%s', $filename),
+    'add_new_line' => true,
+];
+
+return [
+
+    'debug' => true,
+    ConfigAggregator::ENABLE_CACHE => false,
+    FastRouteRouter::CONFIG_CACHE_ENABLED => false,
+
+    'routes' => [
+        // This route is used to test that title resolution is skipped if the long URL times out
+        [
+            'name' => 'long_url_with_timeout',
+            'path' => '/api-tests/long-url-with-timeout',
+            'allowed_methods' => ['GET'],
+            'middleware' => middleware(static function () {
+                sleep(5); // Title resolution times out at 3 seconds
+                return new HtmlResponse('<title>The title</title>');
+            }),
+        ],
+    ],
+
+    'middleware_pipeline' => !$isApiTest ? [] : [
+        'capture_code_coverage' => [
+            'middleware' => new CoverageMiddleware($coverage),
+            'priority' => 9999,
+        ],
+    ],
+
+    'dependencies' => [
+        'services' => [
+            'shlink_test_api_client' => new Client([
+                'base_uri' => sprintf('http://%s:%s/', API_TESTS_HOST, API_TESTS_PORT),
+                'http_errors' => false,
+            ]),
+        ],
+        'factories' => [
+            TestUtils\Helper\TestHelper::class => InvokableFactory::class,
+        ],
+        'delegators' => $isCliTest ? [
+            Application::class => [
+                new CliCoverageDelegator($coverage),
+            ],
+        ] : [],
+    ],
+
+    'entity_manager' => [
+        'connection' => $buildDbConnection(),
+    ],
+
+    'data_fixtures' => [
+        'paths' => [
+            // TODO These are used for other module's tests, so maybe should be somewhere else
+            __DIR__ . '/../../module/Rest/test-api/Fixtures',
+        ],
+    ],
+
+    'logger' => [
+        'Shlink' => $buildTestLoggerConfig('shlink.log'),
+        'Access' => $buildTestLoggerConfig('access.log'),
+    ],
+
+];

data/infra/ci/install-ms-odbc.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -ex
+
+curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
+curl https://packages.microsoft.com/config/ubuntu/24.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+apt-get update
+ACCEPT_EULA=Y apt-get install msodbcsql18
+# apt-get install unixodbc-dev

data/infra/database/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/infra/database_maria/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/infra/database_pg/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/infra/examples/apache-vhost.conf

@@ -0,0 +1,11 @@
+<VirtualHost *:80>
+    ServerName s.test
+    DocumentRoot "/path/to/shlink/public"
+
+    <Directory "/path/to/shlink/public">
+        Options FollowSymLinks Includes ExecCGI
+        AllowOverride all
+        Order allow,deny
+        Allow from all
+    </Directory>
+</VirtualHost>

data/infra/examples/nginx-vhost.conf

@@ -0,0 +1,22 @@
+server {
+    server_name s.test;
+    listen 80;
+    root /path/to/shlink/public;
+    index index.php;
+    charset utf-8;
+
+    location / {
+        try_files $uri $uri/ /index.php$is_args$args;
+    }
+
+    location ~ \.php$ {
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
+        fastcgi_index index.php;
+        include fastcgi.conf;
+    }
+
+    location ~ /\.ht {
+        deny all;
+    }
+}

data/infra/mercure_proxy_vhost.conf

@@ -0,0 +1,17 @@
+server {
+    listen 80 default_server;
+
+    error_log /home/shlink/www/data/infra/nginx/mercure_proxy.error.log;
+
+    location / {
+        proxy_pass http://shlink_mercure;
+        proxy_read_timeout 24h;
+        proxy_http_version 1.1;
+        proxy_set_header Connection "";
+
+        ## Be sure to set USE_FORWARDED_HEADERS=1 to allow the hub to use those headers ##
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Host $host;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}

data/infra/nginx/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/infra/php.Dockerfile

@@ -0,0 +1,63 @@
+FROM php:8.4-fpm-alpine3.21
+MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
+
+ENV APCU_VERSION='5.1.24'
+ENV PDO_SQLSRV_VERSION='5.12.0'
+ENV MS_ODBC_DOWNLOAD='7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION='18_18.4.1.1'
+
+RUN apk update
+
+# Install common php extensions
+RUN docker-php-ext-install pdo_mysql
+RUN docker-php-ext-install calendar
+
+RUN apk add --no-cache oniguruma-dev
+RUN docker-php-ext-install mbstring
+
+RUN apk add --no-cache sqlite-libs
+RUN apk add --no-cache sqlite-dev
+RUN docker-php-ext-install pdo_sqlite
+
+RUN apk add --no-cache icu-dev
+RUN docker-php-ext-install intl
+
+RUN apk add --no-cache libzip-dev zlib-dev
+RUN docker-php-ext-install zip
+
+RUN apk add --no-cache libpng-dev
+RUN docker-php-ext-install gd
+
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
+
+RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
+    docker-php-ext-install sockets && \
+    apk del .phpize-deps
+RUN docker-php-ext-install bcmath
+
+# Install APCu extension
+ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu \
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
+  && docker-php-ext-configure apcu \
+  && docker-php-ext-install apcu \
+  && rm /tmp/apcu.tar.gz \
+  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
+  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
+
+# Install xdebug and sqlsrv driver
+RUN apk add --update linux-headers && \
+    wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} xdebug && \
+    docker-php-ext-enable pdo_sqlsrv xdebug && \
+    apk del .phpize-deps && \
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
+
+# Install composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
+
+# Make home directory writable by anyone
+RUN chmod 777 /home

data/infra/php.ini

@@ -0,0 +1,4 @@
+display_errors=On
+log_errors_max_len=0
+zend.assertions=1
+assert.exception=1

data/infra/redis/redis-acl.conf

@@ -0,0 +1,2 @@
+user foo allcommands allkeys on >bar
+requirepass barbar

data/infra/roadrunner.Dockerfile

@@ -0,0 +1,68 @@
+FROM php:8.4-alpine3.21
+MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
+
+ENV PDO_SQLSRV_VERSION='5.12.0'
+ENV MS_ODBC_DOWNLOAD='7/6/d/76de322a-d860-4894-9945-f0cc5d6a45f8'
+ENV MS_ODBC_SQL_VERSION='18_18.4.1.1'
+
+RUN apk update
+
+# Install common php extensions
+RUN docker-php-ext-install pdo_mysql
+RUN docker-php-ext-install calendar
+
+RUN apk add --no-cache oniguruma-dev
+RUN docker-php-ext-install mbstring
+
+RUN apk add --no-cache sqlite-libs
+RUN apk add --no-cache sqlite-dev
+RUN docker-php-ext-install pdo_sqlite
+
+RUN apk add --no-cache icu-dev
+RUN docker-php-ext-install intl
+
+RUN apk add --no-cache libzip-dev zlib-dev
+RUN docker-php-ext-install zip
+
+RUN apk add --no-cache libpng-dev
+RUN docker-php-ext-install gd
+
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
+
+RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
+    docker-php-ext-install sockets && \
+    apk del .phpize-deps
+RUN docker-php-ext-install bcmath
+
+# Install xdebug and sqlsrv driver
+RUN apk add --update linux-headers && \
+    wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} xdebug && \
+    docker-php-ext-enable pdo_sqlsrv xdebug && \
+    apk del .phpize-deps && \
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
+
+# Install composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
+
+# Make home directory writable by anyone
+RUN chmod 777 /home
+
+VOLUME /home/shlink
+WORKDIR /home/shlink
+
+# Expose roadrunner port
+EXPOSE 8080
+
+CMD \
+    # Install dependencies if the vendor dir does not exist
+    if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
+    # Download roadrunner binary
+    if [[ ! -f "./bin/rr" ]]; then ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr ; fi && \
+    # Create env file if it does not exist yet
+    if [[ ! -f "./config/params/shlink_dev_env.php" ]]; then cp ./config/params/shlink_dev_env.php.dist ./config/params/shlink_dev_env.php ; fi && \
+    # Run with `exec` so that signals are properly handled
+    exec ./bin/rr serve -c config/roadrunner/.rr.dev.yml

data/infra/vhost.conf

@@ -0,0 +1,21 @@
+server {
+    listen 80 default_server;
+    server_name shlink.local;
+    root /home/shlink/www/public;
+    index index.php;
+
+    charset utf-8;
+    error_log /home/shlink/www/data/infra/nginx/shlink.error.log;
+
+    location / {
+        try_files $uri $uri/ /index.php$is_args$args;
+    }
+
+    location ~ \.php$ {
+        root /home/shlink/www/public;
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass shlink_php:9000;
+        fastcgi_index index.php;
+        include fastcgi.conf;
+    }
+}

data/locks/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/migrations_template.txt

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace <namespace>;
+
+use Doctrine\DBAL\Platforms\MySQLPlatform;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class <className> extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+<up>
+    }
+
+    public function down(Schema $schema): void
+    {
+<down>
+    }
+
+    public function isTransactional(): bool
+    {
+        return ! ($this->connection->getDatabasePlatform() instanceof MySQLPlatform);
+    }
+}

docker-compose.ci.yml

@@ -0,0 +1,15 @@
+services:
+    shlink_db_mysql:
+        user: '0'
+        environment:
+            MYSQL_DATABASE: shlink_test
+
+    shlink_db_postgres:
+        user: '0'
+        environment:
+            POSTGRES_DB: shlink_test
+
+    shlink_db_maria:
+        user: '0'
+        environment:
+            MYSQL_DATABASE: shlink_test

docker-compose.yml

@@ -0,0 +1,190 @@
+services:
+    shlink_nginx:
+        container_name: shlink_nginx
+        image: nginx:1.25-alpine
+        ports:
+            - "8000:80"
+        volumes:
+            - ./:/home/shlink/www
+            - ./docs:/home/shlink/www/public/docs
+            - ./data/infra/vhost.conf:/etc/nginx/conf.d/default.conf
+        links:
+            - shlink_php
+
+    shlink_php:
+        container_name: shlink_php
+        user: 1000:1000
+        build:
+            context: .
+            dockerfile: ./data/infra/php.Dockerfile
+        ports:
+            - '8888:8888'
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/php.ini:/usr/local/etc/php/php.ini
+        links:
+            - shlink_db_mysql
+            - shlink_db_postgres
+            - shlink_db_maria
+            - shlink_db_ms
+            - shlink_redis
+            - shlink_redis_acl
+            - shlink_mercure
+            - shlink_mercure_proxy
+            - shlink_rabbitmq
+            - shlink_matomo
+        environment:
+            LC_ALL: C
+            DEFAULT_DOMAIN: localhost:8000
+        extra_hosts:
+            - 'host.docker.internal:host-gateway'
+
+    shlink_roadrunner:
+        container_name: shlink_roadrunner
+        user: 1000:1000
+        build:
+            context: .
+            dockerfile: ./data/infra/roadrunner.Dockerfile
+        ports:
+            - "8800:8080"
+        volumes:
+            - ./:/home/shlink
+            - ./data/infra/php.ini:/usr/local/etc/php/php.ini
+        links:
+            - shlink_db_mysql
+            - shlink_db_postgres
+            - shlink_db_maria
+            - shlink_db_ms
+            - shlink_redis
+            - shlink_redis_acl
+            - shlink_mercure
+            - shlink_mercure_proxy
+            - shlink_rabbitmq
+            - shlink_matomo
+        environment:
+            LC_ALL: C
+        extra_hosts:
+            - 'host.docker.internal:host-gateway'
+
+    shlink_db_mysql:
+        container_name: shlink_db_mysql
+        user: 1000:1000
+        image: mysql:8.0
+        ports:
+            - "3307:3306"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database:/var/lib/mysql
+        environment:
+            MYSQL_ROOT_PASSWORD: root
+            MYSQL_DATABASE: shlink
+
+    shlink_db_postgres:
+        container_name: shlink_db_postgres
+        user: 1000:1000
+        image: postgres:16.3-alpine
+        ports:
+            - "5434:5432"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database_pg:/var/lib/postgresql/data
+        environment:
+            POSTGRES_PASSWORD: root
+            POSTGRES_DB: shlink
+            PGDATA: /var/lib/postgresql/data/pgdata
+
+    shlink_db_maria:
+        container_name: shlink_db_maria
+        user: 1000:1000
+        image: mariadb:10.7
+        ports:
+            - "3308:3306"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database_maria:/var/lib/mysql
+        environment:
+            MYSQL_ROOT_PASSWORD: root
+            MYSQL_DATABASE: shlink
+            MYSQL_INITDB_SKIP_TZINFO: 1
+
+    shlink_db_ms:
+        container_name: shlink_db_ms
+        image: mcr.microsoft.com/mssql/server:2022-latest
+        ports:
+            - "1433:1433"
+        environment:
+            ACCEPT_EULA: Y
+            SA_PASSWORD: "Passw0rd!"
+
+    shlink_redis:
+        container_name: shlink_redis
+        image: redis:7.4-alpine
+        ports:
+            - "6380:6379"
+
+    shlink_redis_acl:
+        container_name: shlink_redis_acl
+        image: redis:7.4-alpine
+        command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
+        ports:
+            - "6382:6379"
+        volumes:
+            - ./data/infra/redis/redis-acl.conf:/usr/local/etc/redis/redis.conf
+
+    shlink_mercure_proxy:
+        container_name: shlink_mercure_proxy
+        image: nginx:1.25-alpine
+        ports:
+            - "8002:80"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/mercure_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
+        links:
+            - shlink_mercure
+
+    shlink_mercure:
+        container_name: shlink_mercure
+        image: dunglas/mercure:v0.18
+        ports:
+            - "3080:80"
+        environment:
+            SERVER_NAME: ":80"
+            MERCURE_PUBLISHER_JWT_KEY: mercure_jwt_key_long_enough_to_avoid_error
+            MERCURE_SUBSCRIBER_JWT_KEY: mercure_jwt_key_long_enough_to_avoid_error
+            MERCURE_EXTRA_DIRECTIVES: "cors_origins https://app.shlink.io http://localhost:3000 http://127.0.0.1:3000 http://localhost:3002 http://127.0.0.1:3002 http://localhost:3005 http://127.0.0.1:3005"
+
+    shlink_rabbitmq:
+        container_name: shlink_rabbitmq
+        image: rabbitmq:3.11-management-alpine
+        ports:
+            - "15673:15672"
+            - "5673:5672"
+        environment:
+            RABBITMQ_DEFAULT_USER: "rabbit"
+            RABBITMQ_DEFAULT_PASS: "rabbit"
+
+    shlink_swagger_ui:
+        container_name: shlink_swagger_ui
+        image: swaggerapi/swagger-ui:v5.11.3
+        ports:
+            - "8005:8080"
+        volumes:
+            - ./docs/swagger:/app
+
+    shlink_matomo:
+        container_name: shlink_matomo
+        image: matomo:5.0-apache
+        ports:
+            - "8003:80"
+        volumes:
+            # Matomo does not persist port in trusted hosts. This volume is needed to edit config afterward
+            # https://github.com/matomo-org/matomo/issues/9549
+            - ./data/infra/matomo:/var/www/html
+        links:
+            - shlink_db_mysql
+        environment:
+            MATOMO_DATABASE_HOST: "shlink_db_mysql"
+            MATOMO_DATABASE_ADAPTER: "mysql"
+            MATOMO_DATABASE_DBNAME: "matomo"
+            MATOMO_DATABASE_USERNAME: "root"
+            MATOMO_DATABASE_PASSWORD: "root"

docker/README.md

@@ -0,0 +1,34 @@
+# Shlink Docker image
+
+[![Docker build status](https://img.shields.io/github/workflow/status/shlinkio/shlink/Build%20docker%20image?logo=docker&style=flat-square)](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Build+docker+image%22)
+[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?logo=docker&style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
+
+This image provides an easy way to set up [shlink](https://shlink.io) on a container-based runtime.
+
+It exposes a shlink instance served with [RoadRunner](https://roadrunner.dev), which can be linked to external databases to persist data.
+
+## Usage
+
+The most basic way to run Shlink's docker image is by providing these mandatory env vars.
+
+* `DEFAULT_DOMAIN`: The default short domain used for this shlink instance. For example **s.test**.
+* `IS_HTTPS_ENABLED`: Either **true** or **false**. Tells if Shlink is being served with HTTPs or not.
+* `GEOLITE_LICENSE_KEY`: Your GeoLite2 license key. [Learn more](https://shlink.io/documentation/geolite-license-key/) about this.
+
+To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
+
+```bash
+docker run \
+    --name shlink \
+    -p 8080:8080 \
+    -e DEFAULT_DOMAIN=s.test \
+    -e IS_HTTPS_ENABLED=true \
+    -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
+    shlinkio/shlink:stable
+```
+
+## Full documentation
+
+All the features supported by Shlink are also supported by the docker image.
+
+If you want to learn more, visit the [full documentation](https://shlink.io/documentation/install-docker-image/).

docker/config/php.ini

@@ -0,0 +1,3 @@
+log_errors_max_len=0
+zend.assertions=1
+assert.exception=1

docker/docker-entrypoint.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env sh
+set -e
+
+cd /etc/shlink
+
+# Create data directories if they do not exist. This allows data dir to be mounted as an empty dir if needed
+mkdir -p data/cache data/locks data/log data/proxies
+
+flags="--no-interaction --clear-db-cache"
+
+# Read env vars through Shlink command, so that it applies the `_FILE` env var fallback logic
+geolite_license_key=$(bin/cli env-var:read GEOLITE_LICENSE_KEY)
+skip_initial_geolite_download=$(bin/cli env-var:read SKIP_INITIAL_GEOLITE_DOWNLOAD)
+initial_api_key=$(bin/cli env-var:read INITIAL_API_KEY)
+
+# Skip downloading GeoLite2 db file if the license key env var was not defined or skipping was explicitly set
+if [ -z "${geolite_license_key}" ] || [ "${skip_initial_geolite_download}" = "true" ]; then
+  flags="${flags} --skip-download-geolite"
+fi
+
+# If INITIAL_API_KEY was provided, create an initial API key
+if [ -n "${initial_api_key}" ]; then
+  flags="${flags} --initial-api-key=${initial_api_key}"
+fi
+
+php vendor/bin/shlink-installer init ${flags}
+
+if [ "$SHLINK_RUNTIME" = 'rr' ]; then
+  # Run with `exec` so that signals are properly handled
+  exec ./bin/rr serve -c config/roadrunner/.rr.yml
+fi

docs/adr/2021-01-17-support-restrictions-and-permissions-in-api-keys.md

@@ -0,0 +1,50 @@
+# Support restrictions and permissions in API keys
+
+* Status: Accepted
+* Date: 2021-01-17
+
+## Context and problem statement
+
+Historically, every API key generated for Shlink granted you access to all existing resources.
+
+The intention is to be able to apply some form of restriction to API keys, so that only a subset of "resources" can be accessed with it, naming:
+
+* Allowing interactions only with short URLs and related resources, that have been created with the same API key.
+* Allowing interactions only with short URLs and related resources, that have been attached to a specific domain.
+
+The intention is to implement a system that allows adding to API keys as many of these restrictions as wanted.
+
+Supporting more restrictions in the future is also desirable.
+
+## Considered options
+
+* Using an ACL/RBAC library, and checking roles in a middleware.
+* Using a service that, provided an API key, tells if certain resource is reachable while it also allows building queries dynamically.
+* Using some library implementing the specification pattern, to dynamically build queries transparently for outer layers.
+
+## Decision outcome
+
+The main difficulty on implementing this is that the entity conditioning the behavior (the API key) comes in the request in some form, but it can potentially affect database queries performed in the persistence layer.
+
+Because of this, it has to traverse all the application layers from top to bottom, in most of the cases.
+
+This motivated selecting the third option, as we can propagate the API key and delay its handling to the last step, without changing the behavior of the rest of the layers that much (except in some individual use cases).
+
+The domain term used to refer these "restrictions" is finally **roles**.
+
+It can be combined in the future with an ACL/RBAC library, if we want to restrict access to certain resources, but it didn't fulfil the initial requirements.
+
+## Pros and Cons of the Options
+
+### An ACL/RBAC library
+
+* Good, because there are many good libraries out there.
+* Bad, because when you need to filter resources lists this kind of libraries doesn't really work.
+
+### A service with the logic
+
+* Bad, because it would need to be used in many layers of the application, mixing unrelated concerns.
+
+### A library implementing the specification pattern
+
+* Good, because allows centralizing the generation of dynamic specs by the entity itself, that are later translated automatically into database queries.

docs/adr/2021-02-07-track-visits-to-base-url-invalid-short-url-and-regular-404.md

@@ -0,0 +1,35 @@
+# Track visits to 'base_url', 'invalid_short_url' and 'regular_404'
+
+* Status: Accepted
+* Date: 2021-02-07
+
+## Context and problem statement
+
+Shlink has the mechanism to return either custom errors or custom redirects when visiting the instance's base URL, an invalid short URL, or any other kind of URL that would result in a "Not found" error.
+
+However, it does not track visits to any of those, just to valid short URLs.
+
+The intention is to change that, and allow users to track the cases mentioned above.
+
+## Considered options
+
+* Create a new table to track visits o this kind.
+* Reuse the existing `visits` table, by making `short_url_id` nullable and adding a couple of other fields.
+
+## Decision outcome
+
+The decision is to use the existing table, as making the short URL nullable can be handled seamlessly by using named constructors, and it has a lot of benefits on regards of reusing existing components.
+
+Also, the domain name this kind of visits will receive is "Orphan Visits", as they are detached from any existing short URL.
+
+## Pros and Cons of the Options
+
+### New table
+
+* Good because we don't touch existing models and tables, reducing the risk to introduce a backwards compatibility break.
+* Bad because we will have to repeat data modeling and logic, or refactor some components to support both contexts. This in turn increases the options to introduce a BC break.
+
+### Reuse existing table
+
+* Good because all the mechanisms in place to handle visits will work out of the box, including locating visits and such.
+* Bad because we will have more optional properties, which means more double checks in many places.

docs/adr/2021-08-05-migrate-to-a-new-caching-library.md

@@ -0,0 +1,59 @@
+# Migrate to a new caching library
+
+* Status: Accepted
+* Date: 2021-08-05
+
+## Context and problem statement
+
+Shlink has always used the `doctrine/cache` library to handle anything related with cache.
+
+It was convenient, as it provided several adapters, and it was the library used by other doctrine packages.
+
+However, after the creation of the caching PSRs ([PSR-6 - Cache](https://www.php-fig.org/psr/psr-6) and [PSR-16 - Simple cache](https://www.php-fig.org/psr/psr-16)), most library authors have moved to those interfaces, and the doctrine team has decided to recommend using any other existing package and decommission their own solution.
+
+Also, Shlink needs support for Redis clusters and Redis sentinels, which is not supported by `doctrine/cache` Redis adapters.
+
+## Considered options
+
+After some research, the only packages that seem to support the capabilities required by Shlink and also seem healthy, are these:
+
+* [Symfony cache](https://symfony.com/doc/current/components/cache.html)
+    * 🟢 PSR-6 compliant: **yes**
+    * 🟢 PSR-16 compliant: **yes**
+    * 🟢 APCu support: **yes**
+    * 🟢 Redis support: **yes**
+    * 🟢 Redis cluster support: **yes**
+    * 🟢 Redis sentinel support: **yes**
+    * 🟢 Can use redis through Predis: **yes**
+    * 🔴 Individual packages per adapter: **no**
+* [Laminas cache](https://docs.laminas.dev/laminas-cache/)
+    * 🟢 PSR-6 compliant: **yes**
+    * 🟢 PSR-16 compliant: **yes**
+    * 🟢 APCu support: **yes**
+    * 🟢 Redis support: **yes**
+    * 🟢 Redis cluster support: **yes**
+    * 🔴 Redis sentinel support: **no**
+    * 🔴 Can use redis through Predis: **no**
+    * 🟢 Individual packages per adapter: **yes**
+
+## Decision outcome
+
+Even though Symfony packs all their adapters in a single component, which means we will install some code that will never be used, Laminas relies on the native redis extension for anything related with redis.
+
+That would make Shlink more complex to install, so it seems Symfony's package is the option where it's easier to migrate to.
+
+Also, it's important that the cache component can share the Redis integration (through `Predis`, in this case), as it's also used by other components (the lock component, to name one).
+
+## Pros and Cons of the Options
+
+### Symfony cache
+
+* Good because it supports Redis Sentinel.
+* Good because it allows using a external `Predis` instance.
+* Bad because it packs all the adapters in a single component.
+
+### Laminas cache
+
+* Good because allows installing only the adapters you are going to use, through separated packages.
+* Bad because it requires the php-redis native extension in order to interact with Redis.
+* Bad because it does ot seem to support Redis Sentinels.

docs/adr/2022-01-15-update-env-vars-behavior-to-have-precedence-over-installer-options.md

@@ -0,0 +1,51 @@
+# Update env vars behavior to have precedence over installer options
+
+* Status: Accepted
+* Date: 2022-01-15
+
+## Context and problem statement
+
+Shlink supports providing configuration via the installer tool that generates a config file that gets merged with the rest of the config, or via environment variables.
+
+It is potentially possible to combine both, but if you do so, you will find out the installer tool config has precedence over env vars, which is not very intuitive.
+
+A [Twitter survey](https://twitter.com/shlinkio/status/1480614855006732289) has also showed up all participants also found the behavior should be the opposite.
+
+## Considered options
+
+* Move the logic to read env vars to another config file which always overrides installer options.
+* Move the logic to read env vars to a config post-processor which overrides config dynamically, only if the appropriate env var had been defined.
+* Make the installer generate a config file which also includes the logic to load env vars on it.
+* Make the installer no longer generate the config structure, and instead generate a map with env vars and their values. Then Shlink would define those env vars if not defined already.
+
+## Decision outcome
+
+The most viable option was finally to re-think the installer tool, and make it generate a map of env vars and their values.
+
+Then Shlink reads this as the first config file, which sets the values as env vars if not yet defined, and later on, the values are read as usual wherever needed.
+
+## Pros and Cons of the Options
+
+### Read all env vars in a single config file
+
+* Bad: This option had to be discarded, as it would always override the installer config no matter what.
+
+### Read all env vars in a config post-processor
+
+* Good because it would not require any change in the installer.
+* Bad because it requires moving all env var reading logic somewhere else, while having it together with their contextual config is quite convenient.
+* Bad because it requires defining a map between the config path from the installer and the env var to set.
+
+### Make the installer generate a config file which also reads env vars
+
+* Good because it would not require changing Shlink.
+* Bad because it requires looking for a new way to generate the installer config.
+* Bad because it would mean reading the env vars in multiple places.
+
+### Re-think the installer to no longer generate internal config, and instead, just define values for regular env vars
+
+* Bad because it requires changes both in Shlink and the installer.
+* Bad because it's more error-prone, and the option with higher chances to introduce a regression.
+* Good because it finally decouples Shlink internal config (which is an implementation detail) from any external tool, including the installer, allowing to change it at will.
+* Good because it opens the door to eventually simplify the installer. For the moment, it requires a bit of extra logic to support importing the old config.
+* Good because it allows keeping the logic to read env vars next to the config where it applies.