Merge pull request #2052 from acelaya-forks/feature/fix-geolite-update-backport

Fix infinite GeoLite2 downloads - v3.x backport

.dockerignore

@@ -1,3 +1,4 @@
+bin/rr
 config/autoload/*local*
 data/infra
 data/cache/*
@@ -5,10 +6,11 @@ data/log/*
 data/locks/*
 data/proxies/*
 data/migrations_template.txt
-data/GeoLite2-City.*
+data/GeoLite2-City*
 data/database.sqlite
 data/shlink-tests.db
 CHANGELOG.md
+CONTRIBUTING.md
 UPGRADE.md
 composer.lock
 vendor
@@ -21,3 +23,4 @@ infection*
 **/test*
 build*
 **/.*
+!config/roadrunner/.rr.yml

.github/DISCUSSION_TEMPLATE/help-wanted.yml

@@ -0,0 +1,51 @@
+title: 'Help wanted'
+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 openswoole
+        - Self-hosted RoadRunner
+        - Openswoole Docker image
+        - 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: Summary
+      value: '<!-- Describe your issue, question or request here. -->'
+

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!--
 Before opening an issue, just take into account that this is a completely free of charge and open source project.
 I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
+I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personally if an issue gets eventually closed.
 You may also be asked to provide tests or ways to reproduce reported bugs.
 Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
 -->

.github/ISSUE_TEMPLATE/Bug.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Something on shlink is broken or not working as documented?
-labels: bug
----
-
-<!--
-Before opening an issue, just take into account that this is a completely free of charge and open source project.
-I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
-You may also be asked to provide tests or ways to reproduce reported bugs.
-Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
-
-With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
--->
-
-#### How Shlink is set-up
-
-* Shlink Version: x.y.z
-* PHP Version: x.y.z
-* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
-* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
-
-#### Summary
-
-<!-- Provide a summary describing the problem you are experiencing. -->
-
-#### Current behavior
-
-<!-- How is it actually behaving (and it shouldn't)? -->
-
-#### Expected behavior
-
-<!-- How did you expected to behave? -->
-
-#### How to reproduce
-
-<!-- Provide steps to reproduce the bug. -->

.github/ISSUE_TEMPLATE/Bug.yml

@@ -0,0 +1,64 @@
+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 openswoole
+        - Self-hosted RoadRunner
+        - Openswoole Docker image
+        - 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: How to reproduce
+      value: '<!-- Provide steps to reproduce the bug. -->'

.github/ISSUE_TEMPLATE/Feature_Request.md

@@ -1,19 +0,0 @@
----
-name: Feature request
-about: Do you find shlink is missing some important feature that would make it more useful?
-labels: feature
----
-
-<!--
-Before opening an issue, just take into account that this is a completely free of charge and open source project.
-I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
-You may also be asked to provide tests or ways to reproduce reported bugs.
-Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
-
-With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
--->
-
-#### Summary
-
-<!-- Describe the new feature you would like to request. -->

.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/Question_Support.md

@@ -1,26 +0,0 @@
----
-name: Question - Support
-about: Do you have a problem setting up or using shlink?
-labels: question
----
-
-<!--
-Before opening an issue, just take into account that this is a completely free of charge and open source project.
-I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
-You may also be asked to provide tests or ways to reproduce reported bugs.
-Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
-
-With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
--->
-
-#### How Shlink is set-up
-
-* Shlink Version: x.y.z
-* PHP Version: x.y.z
-* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
-* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
-
-#### Summary
-
-<!-- Describe the issue you are facing here. -->

.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/shlinkio/shlink/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
+    default: ''
+  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
+      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
+      uses: actions/cache@v3
+      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: pcov
+        ini-values: pcov.directory=module
+    - name: Install dependencies
+      if: ${{ inputs.install-deps == 'yes' }}
+      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.3' && '--ignore-platform-reqs' || '' }}
+      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-22.04
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
+    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: openswoole-22.1.0, pdo_sqlsrv-5.11.1
+          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-tools/bin/sqlcmd -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.2' && 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,14 @@
+name: Build docker image
+
+on:
+  pull_request:
+    paths:
+      - 'Dockerfile'
+
+jobs:
+  build-docker-image:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - run: docker build -t shlink-docker-image:temp .

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

@@ -0,0 +1,46 @@
+name: Mutation tests
+
+on:
+  workflow_call:
+    inputs:
+      test-group:
+        type: string
+        required: true
+        description: One of unit, db, api or cli
+
+jobs:
+  mutation-tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: './.github/actions/ci-setup'
+        with:
+          php-version: ${{ matrix.php-version }}
+          php-extensions: openswoole-22.1.0
+          extensions-cache-key: mutation-tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
+      - uses: actions/download-artifact@v4
+        with:
+          name: coverage-${{ inputs.test-group }}
+          path: build
+      - name: Resolve infection args
+        id: infection_args
+        run: echo "args=--logger-github=false" >> $GITHUB_OUTPUT
+#        TODO Try to filter mutation tests to improve execution times. Investigate why --git-diff-lines --git-diff-base=develop does not work
+#        run: |
+#          BRANCH="${GITHUB_REF#refs/heads/}" |
+#          if [[ $BRANCH == 'main' || $BRANCH == 'develop' ]]; then
+#            echo "args=--logger-github=false" >> $GITHUB_OUTPUT
+#          else
+#            echo "args=--logger-github=false --git-diff-lines --git-diff-base=develop" >> $GITHUB_OUTPUT
+#          fi;
+        shell: bash
+      - if: ${{ inputs.test-group == 'unit' }}
+        run: composer infect:ci:unit -- ${{ steps.infection_args.outputs.args }}
+        env:
+          INFECTION_BADGE_API_KEY: ${{ secrets.INFECTION_BADGE_API_KEY }}
+      - if: ${{ inputs.test-group != 'unit' }}
+        run: composer infect:ci:${{ inputs.test-group }} -- ${{ steps.infection_args.outputs.args }}

.github/workflows/ci-tests.yml

@@ -0,0 +1,38 @@
+name: Tests
+
+on:
+  workflow_call:
+    inputs:
+      test-group:
+        type: string
+        required: true
+        description: One of unit, api or cli
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
+    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 }}
+          php-extensions: openswoole-22.1.0
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
+      - run: composer test:${{ inputs.test-group }}:ci
+      - uses: actions/upload-artifact@v4
+        if: ${{ matrix.php-version == '8.2' }}
+        with:
+          name: coverage-${{ inputs.test-group }}
+          path: |
+            build/coverage-${{ inputs.test-group }}
+            build/coverage-${{ inputs.test-group }}.cov

.github/workflows/ci.yml

@@ -1,291 +1,160 @@
 name: Continuous integration
 
 on:
-  pull_request: null
+  pull_request:
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.json5'
+      - '*.neon'
   push:
     branches:
       - main
       - develop
+      - 2.x
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.json5'
+      - '*.neon'
 
 jobs:
-  lint:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php-version: ['7.4']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: none
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer cs
-
   static-analysis:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.2']
+        command: ['cs', 'stan', 'swagger:validate']
     steps:
-      - name: Checkout code
+      - uses: actions/checkout@v4
-        uses: actions/checkout@v2
+      - uses: './.github/actions/ci-setup'
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          tools: composer
+          php-extensions: openswoole-22.1.0
-          extensions: swoole-4.5.9
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ matrix.command }}
-          coverage: none
+      - run: composer ${{ matrix.command }}
-      - run: composer install --no-interaction --prefer-dist
-      - run: composer stan
 
   unit-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-tests.yml'
-    continue-on-error: ${{ matrix.php-version == '8.0' }}
+    with:
+      test-group: unit
+
+  cli-tests:
+    uses: './.github/workflows/ci-tests.yml'
+    with:
+      test-group: cli
+
+  openswoole-api-tests:
+    uses: './.github/workflows/ci-tests.yml'
+    with:
+      test-group: api
+
+  roadrunner-api-tests:
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:
-      - name: Checkout code
+      - uses: actions/checkout@v4
-        uses: actions/checkout@v2
+      - run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
-      - name: Use PHP
+      - uses: shivammathur/setup-php@v2
-        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer
-          extensions: swoole-4.5.9
+      - run: composer install --no-interaction --prefer-dist --ignore-platform-req=ext-openswoole ${{ matrix.php-version == '8.3' && '--ignore-platform-reqs' || '' }}
-          coverage: pcov
+      - run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
-          ini-values: pcov.directory=module
+      - run: composer test:api:rr
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: composer test:unit:ci
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
-        with:
-          name: coverage-unit
-          path: |
-            build/coverage-unit
-            build/coverage-unit.cov
 
-  db-tests-sqlite:
+  sqlite-db-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-db-tests.yml'
-    strategy:
+    with:
-      matrix:
+      platform: 'sqlite:ci'
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: pcov
-          ini-values: pcov.directory=module
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:sqlite:ci
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
-        with:
-          name: coverage-db
-          path: |
-            build/coverage-db
-            build/coverage-db.cov
 
-  db-tests-mysql:
+  mysql-db-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-db-tests.yml'
-    strategy:
+    with:
-      matrix:
+      platform: 'mysql'
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: none
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:mysql
 
-  db-tests-maria:
+  maria-db-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-db-tests.yml'
-    strategy:
+    with:
-      matrix:
+      platform: 'maria'
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: none
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:maria
 
-  db-tests-postgres:
+  postgres-db-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-db-tests.yml'
-    strategy:
+    with:
-      matrix:
+      platform: 'postgres'
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: none
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: composer test:db:postgres
 
-  db-tests-ms:
+  ms-db-tests:
-    runs-on: ubuntu-20.04
+    uses: './.github/workflows/ci-db-tests.yml'
-    strategy:
+    with:
-      matrix:
+      platform: 'ms'
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Install MSSQL ODBC
-        run: sudo ./data/infra/ci/install-ms-odbc.sh
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9, pdo_sqlsrv-5.9.0beta2
-          coverage: none
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - name: Create test database
-        run: docker-compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
-      - run: composer test:db:ms
 
-  api-tests:
+  unit-mutation-tests:
-    runs-on: ubuntu-20.04
-    continue-on-error: ${{ matrix.php-version == '8.0' }}
-    strategy:
-      matrix:
-        php-version: ['7.4', '8.0']
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Start database server
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db
-      - name: Use PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-          extensions: swoole-4.5.9
-          coverage: pcov
-          ini-values: pcov.directory=module
-      - if: ${{ matrix.php-version == '8.0' }}
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
-      - if: ${{ matrix.php-version != '8.0' }}
-        run: composer install --no-interaction --prefer-dist
-      - run: bin/test/run-api-tests.sh
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.php-version == '7.4' }}
-        with:
-          name: coverage-api
-          path: |
-            build/coverage-api
-            build/coverage-api.cov
-
-  mutation-tests:
     needs:
       - unit-tests
-      - db-tests-sqlite
+    uses: './.github/workflows/ci-mutation-tests.yml'
-      - api-tests
+    with:
-    runs-on: ubuntu-20.04
+      test-group: unit
-    strategy:
+
-      matrix:
+  db-mutation-tests:
-        php-version: ['7.4', '8.0']
+    needs:
-    steps:
+      - sqlite-db-tests
-      - name: Checkout code
+    uses: './.github/workflows/ci-mutation-tests.yml'
-        uses: actions/checkout@v2
+    with:
-      - name: Use PHP
+      test-group: db
-        uses: shivammathur/setup-php@v2
+
-        with:
+  api-mutation-tests:
-          php-version: ${{ matrix.php-version }}
+    needs:
-          tools: composer
+      - openswoole-api-tests
-          extensions: swoole-4.5.9
+    uses: './.github/workflows/ci-mutation-tests.yml'
-          coverage: pcov
+    with:
-          ini-values: pcov.directory=module
+      test-group: api
-      - if: ${{ matrix.php-version == '8.0' }}
+
-        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+  cli-mutation-tests:
-      - if: ${{ matrix.php-version != '8.0' }}
+    needs:
-        run: composer install --no-interaction --prefer-dist
+      - cli-tests
-      - uses: actions/download-artifact@v2
+    uses: './.github/workflows/ci-mutation-tests.yml'
-        with:
+    with:
-          path: build
+      test-group: cli
-      - run: composer infect:ci
 
   upload-coverage:
     needs:
       - unit-tests
-      - db-tests-sqlite
+      - openswoole-api-tests
-      - api-tests
+      - cli-tests
-    runs-on: ubuntu-20.04
+      - sqlite-db-tests
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.2']
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Use PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           coverage: pcov
           ini-values: pcov.directory=module
-      - uses: actions/download-artifact@v2
+      - 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: wget https://phar.phpunit.de/phpcov-8.2.0.phar
+      - run: mv build/coverage-cli/coverage-cli.cov build/coverage-cli.cov
-      - run: php phpcov-8.2.0.phar merge build --clover build/clover.xml
+      - run: wget https://phar.phpunit.de/phpcov-9.0.0.phar
+      - run: php phpcov-9.0.0.phar merge build --clover build/clover.xml
       - name: Publish coverage
         uses: codecov/codecov-action@v1
         with:
@@ -293,27 +162,14 @@ jobs:
 
   delete-artifacts:
     needs:
-      - mutation-tests
+      - unit-mutation-tests
+      - db-mutation-tests
+      - api-mutation-tests
+      - cli-mutation-tests
       - upload-coverage
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: geekyeggo/delete-artifact@v1
+      - uses: geekyeggo/delete-artifact@v2
         with:
           name: |
-            coverage-unit
+            coverage-*
-            coverage-db
-            coverage-api
-
-  build-docker-image:
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - uses: marceloprado/has-changed-path@v1
-        id: changed-dockerfile
-        with:
-          paths: ./Dockerfile
-      - if: ${{ steps.changed-dockerfile.outputs.changed == 'true' }}
-        run: docker build -t shlink-docker-image:temp .
-      - if: ${{ steps.changed-dockerfile.outputs.changed != 'true' }}
-        run: echo "Dockerfile didn't change. Skipped"

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

@@ -1,28 +0,0 @@
-name: Build docker image
-
-on:
-  push:
-    branches:
-      - develop
-    tags:
-      - 'v*'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-        with:
-          version: latest
-      - name: Login to docker hub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-      - name: Build the image
-        run: bash ./docker/build

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

@@ -0,0 +1,34 @@
+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'
+          - runtime: 'openswoole'
+            tag-suffix: 'openswoole'
+            platforms: 'linux/arm/v7,linux/arm64/v8,linux/amd64'
+          - runtime: 'rr'
+            tag-suffix: 'non-root'
+            platforms: 'linux/arm64/v8,linux/amd64'
+            user-id: '1001'
+    uses: shlinkio/github-actions/.github/workflows/docker-build-and-publish.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 }}
+        SHLINK_USER_ID=${{ matrix.user-id && matrix.user-id || 'root' }}

.github/workflows/publish-release.yml

@@ -7,24 +7,49 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3']
+        swoole: ['yes', 'no']
     steps:
-      - name: Checkout code
+      - uses: actions/checkout@v4
-        uses: actions/checkout@v2
+      - uses: './.github/actions/ci-setup'
-      - name: Use PHP 7.4
-        uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4' # Publish release with lowest supported PHP version
+          php-version: ${{ matrix.php-version }}
-          tools: composer
+          php-extensions: openswoole-22.1.0
-          extensions: swoole-4.5.9
+          extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
-      - name: Generate release assets
+          install-deps: 'no'
+      - if: ${{ matrix.swoole == 'yes' }}
         run: ./build.sh ${GITHUB_REF#refs/tags/v}
+      - if: ${{ matrix.swoole == 'no' }}
+        run: ./build.sh ${GITHUB_REF#refs/tags/v} --no-swoole
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}
+          path: build
+
+  publish:
+    needs: ['build']
+    runs-on: ubuntu-22.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_TAG_PREFIX: "true"
           ALLOW_EMPTY_CHANGELOG: "true"
         with:
           args: |
-            build/shlink_*_dist.zip
+            build/*/shlink*_dist.zip
+
+  delete-artifacts:
+    needs: ['publish']
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: geekyeggo/delete-artifact@v2
+        with:
+          name: dist-files-*

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

@@ -0,0 +1,36 @@
+name: Publish swagger spec
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php-version: ['8.2']
+    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 }}
+          php-extensions: openswoole-22.1.0
+          extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
+      - run: composer swagger:inline
+      - run: mkdir ${{ steps.determine_version.outputs.version }}
+      - run: mv docs/swagger/swagger-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

.gitignore

@@ -1,4 +1,6 @@
 .idea
+bin/rr
+config/roadrunner/.pid
 build
 !docker/build
 composer.lock
@@ -6,8 +8,10 @@ composer.phar
 vendor/
 data/database.sqlite
 data/shlink-tests.db
-data/GeoLite2-City.mmdb
+data/GeoLite2-City.*
-data/GeoLite2-City.mmdb.*
+data/infra/matomo
 docs/swagger-ui*
+docs/mercure.html
 docker-compose.override.yml
 .phpunit.result.cache
+docs/swagger/swagger-inlined.json

CONTRIBUTING.md

@@ -6,9 +6,9 @@ You will also see how to ensure the code fulfills the expected code checks, and
 
 ## System dependencies
 
-The project provides all its dependencies as docker containers through a docker-compose configuration.
+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/).
+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
 
@@ -21,7 +21,7 @@ Then you will have to follow these steps:
     For example the `common.local.php.dist` file should be copied as `common.local.php`.
 
 * Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension.
-* Start-up the project by running `docker-compose up`.
+* 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.
 
@@ -31,9 +31,9 @@ Then you will have to follow these steps:
 * 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 `8000` through nginx+php-fpm and `8080` through swoole.
+Once you finish this, you will have the project exposed in ports `8800` through RoadRunner, `8080` through openswoole and `8000` through nginx+php-fpm.
 
-> Note: The `indocker` shell script is a helper used to run commands inside the main docker container.
+> Note: The `indocker` shell script is a helper tool used to run commands inside the main docker container.
 
 ## Project structure
 
@@ -46,40 +46,41 @@ This is a simplified version of the project structure:
 ```
 shlink
 ├── bin
-│   ├── cli
+│   ├── cli
-│   ├── install
+│   └── [...]
-│   └── update
 ├── config
-│   ├── autoload
+│   ├── autoload
-│   ├── params
+│   ├── params
-│   ├── config.php
+│   ├── config.php
-│   └── container.php
+│   ├── container.php
+│   └── [...]
 ├── data
-│   ├── cache
+│   ├── cache
-│   ├── locks
+│   ├── locks
-│   ├── log
+│   ├── log
-│   ├── migrations
+│   └── proxies
-│   └── proxies
 ├── docs
-│   ├── async-api
+│   ├── adr
-│   └── swagger
+│   ├── async-api
+│   └── swagger
 ├── module
-│   ├── CLI
+│   ├── CLI
-│   ├── Core
+│   ├── Core
-│   └── Rest
+│   └── 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, while `install` and `update` are helper tools used to install and update shlink when not using the docker image.
+* `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 runtime-generated git-ignored assets, like logs, caches, etc.
+* `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.
+* `docs`: Any project documentation is stored here, like API spec definitions or architectural decision records.
-* `module`: Contains a subfolder for every module in the project. Modules contain the source code, tests and configurations for every context in the project.
+* `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 swoole.
+* `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 or openswoole.
 
 ## Project tests
 
@@ -87,21 +88,25 @@ In order to ensure stability and no regressions are introduced while developing
 
 * **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 entity repositories are excluded because of their nature.
+    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 entity repositories.
+* **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 and test it from the outside, by interacting with the REST API.
+* **API tests**: These are E2E tests that spin up an instance of the app with RoadRunner or openswoole, and test it from the outside by interacting with the REST API.
 
-    These are the best tests to catch regressions, and to verify everything interacts as expected.
+    These are the best tests to catch regressions, and to verify everything behaves as expected.
 
-    They use MySQL as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+    They use Postgres as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
 
-* **CLI tests**: *TBD. Once included, its purpose will be the same as API tests, but running through the command line*
+    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.
 
@@ -113,24 +118,35 @@ Depending on the kind of contribution, maybe not all kinds of tests are needed,
 * 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. 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.
+    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 MySQL database engine is used.
+* Run `./indocker composer test:api` to run API E2E tests. For these, the Postgres database engine is used.
-* Run `./indocker composer infect:test` ti run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/).
+* 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. This command is run during the project's continuous integration.
+* Run `./indocker composer infect:test` to run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/).
+* Run `./indocker composer ci` to run all previous commands together, parallelizing non-conflicting tasks as much as possible.
 
-> Note: Due to some limitations in the tooling used by shlink, the testing databases need to exist beforehand, both for db and api tests (except sqlite).
+## Testing endpoints
->
+
-> However, they just need to be created empty, with no tables. Also, once created, they are automatically reset before every new execution.
+The project provides a Swagger UI container for dev envs, which can be accessed in http://localhost:8005.
->
+
-> The testing database is always called `shlink_test`. You can create it using the database client of your choice. [DBeaver](https://dbeaver.io/) is a good multi-platform desktop database client which supports all the engines supported by shlink.
+It will automatically load the contents of `docs/swagger`, so you can make any updates and they will get reflected.
 
 ## Pull request process
 
-In order to provide pull requests to this project, you should always start by creating a new branch, where you will make all desired changes.
+**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

@@ -1,56 +1,60 @@
-FROM php:7.4.11-alpine3.12 as base
+FROM php:8.2-alpine3.17 as base
 
-ARG SHLINK_VERSION=2.4.0
+ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV SWOOLE_VERSION 4.5.9
+ARG SHLINK_RUNTIME=rr
-ENV LC_ALL "C"
+ENV SHLINK_RUNTIME ${SHLINK_RUNTIME}
+ARG SHLINK_USER_ID='root'
+ENV SHLINK_USER_ID ${SHLINK_USER_ID}
+
+ENV OPENSWOOLE_VERSION 22.1.0
+ENV PDO_SQLSRV_VERSION 5.11.1
+ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
+ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
+ENV LC_ALL 'C'
 
 WORKDIR /etc/shlink
 
 # Install required PHP extensions
 RUN \
-    # Install mysql and calendar
+    # Temp install dev dependencies needed to compile the extensions
-    docker-php-ext-install -j"$(nproc)" pdo_mysql calendar && \
+    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev linux-headers && \
-    # Install sqlite
+    docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip gd && \
-    apk add --no-cache sqlite-libs sqlite-dev && \
+    apk add --no-cache sqlite-libs && \
     docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
-    # Install postgres
+    # Remove temp dev extensions, and install prod equivalents that are required at runtime
-    apk add --no-cache postgresql-dev && \
+    apk del .dev-deps && \
-    docker-php-ext-install -j"$(nproc)" pdo_pgsql && \
+    apk add --no-cache postgresql icu libzip libpng
-    # Install intl
-    apk add --no-cache icu-dev && \
-    docker-php-ext-install -j"$(nproc)" intl && \
-    # Install zip and gd
-    apk add --no-cache libzip-dev zlib-dev libpng-dev && \
-    docker-php-ext-install -j"$(nproc)" zip gd && \
-    # Install gmp
-    apk add --no-cache gmp-dev && \
-    docker-php-ext-install -j"$(nproc)" gmp
 
-# Install sqlsrv driver
+# Install openswoole and sqlsrv driver for x86_64 builds
-RUN if [ $(uname -m) == "x86_64" ]; then \
+RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
-      wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+    if [ "$SHLINK_RUNTIME" == 'openswoole' ]; then \
-      apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+        # Openswoole is deprecated. Remove in v4.0.0
-      apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+        pecl install openswoole-${OPENSWOOLE_VERSION} && \
-      pecl install pdo_sqlsrv && \
+        docker-php-ext-enable openswoole ; \
+    fi; \
+    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 && \
-      apk del .phpize-deps && \
+      rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
-      rm msodbcsql17_17.5.1.1-1_amd64.apk ; \
+    fi; \
-    fi
-
-# Install swoole
-RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} && \
-    pecl install swoole-${SWOOLE_VERSION} && \
-    docker-php-ext-enable swoole && \
     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 --optimize-autoloader --prefer-dist --no-progress --no-interaction && \
+    # FIXME Ignoring ext-openswoole platform req, as it makes install fail with roadrunner, even though it's a dev dependency and we are passing --no-dev
+    php composer.phar install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction --ignore-platform-req=ext-openswoole && \
+    if [ "$SHLINK_RUNTIME" == 'openswoole' ]; then \
+        # Openswoole is deprecated. Remove in v4.0.0
+        php composer.phar remove spiral/roadrunner spiral/roadrunner-jobs spiral/roadrunner-cli spiral/roadrunner-http --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interaction ; \
+    elif [ "$SHLINK_RUNTIME" == 'rr' ]; then \
+        php composer.phar remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interaction --ignore-platform-req=ext-openswoole ; \
+    fi; \
     php composer.phar clear-cache && \
     rm -r docker composer.* && \
     sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
@@ -60,18 +64,20 @@ RUN apk add --no-cache git && \
 FROM base
 LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
 
-COPY --from=builder /etc/shlink .
+COPY --from=builder --chown=${SHLINK_USER_ID} /etc/shlink .
-RUN ln -s /etc/shlink/bin/cli /usr/local/bin/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 swoole port
+# Expose default port
 EXPOSE 8080
 
-# Expose params config dir, since the user is expected to provide custom config from there
-VOLUME /etc/shlink/config/params
-
 # Copy config specific for the image
 COPY docker/docker-entrypoint.sh docker-entrypoint.sh
 COPY docker/config/shlink_in_docker.local.php config/autoload/shlink_in_docker.local.php
 COPY docker/config/php.ini ${PHP_INI_DIR}/conf.d/
 
+USER ${SHLINK_USER_ID}
+
 ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2020 Alejandro Celaya
+Copyright (c) 2016-2023 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,46 +1,49 @@
 ![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png)
 
-[![Build Status](https://img.shields.io/github/workflow/status/shlinkio/shlink/Continuous%20integration/develop?logo=github&style=flat-square)](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Continuous+integration%22)
+[![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)
+[![Infection MSI](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fshlinkio%2Fshlink%2Fdevelop)](https://dashboard.stryker-mutator.io/reports/github.com/shlinkio/shlink/develop)
 [![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)
+[![Twitter](https://img.shields.io/badge/follow-shlinkio-blue.svg?style=flat-square&logo=x&color=black)](https://twitter.com/shlinkio)
+[![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)
 [![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 custom domain.
+A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.
-
-> This document references Shlink 2.x. If you are using an older version and want to upgrade, follow the [UPGRADE](UPGRADE.md) doc.
-
-> 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.
 
 ## Table of Contents
 
-- [Installation](#installation)
+- [Full documentation](#full-documentation)
+- [Docker image](#docker-image)
+- [Self-hosted](#self-hosted)
     - [Download](#download)
     - [Configure](#configure)
-    - [Serve](#serve)
-    - [Bonus](#bonus)
-- [Update to new version](#update-to-new-version)
-    - [Update a configuration option](#update-a-configuration-option)
-- [Using a docker image](#using-a-docker-image)
 - [Using shlink](#using-shlink)
-    - [Shlink CLI Help](#shlink-cli-help)
+- [Contributing](#contributing)
-- [Multiple domains](#multiple-domains)
-    - [Management](#management)
-    - [Visits](#visits)
-    - [Special redirects](#special-redirects)
 
-## Installation
+## Full documentation
 
-> These are the steps needed to install Shlink if you plan to manually host it. 
+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/).
->
+
-> Alternatively, you can use the official docker image. If that's your intention, jump directly to [Using a docker image](#using-a-docker-image)
+## 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 7.4 or greater with JSON, curl, PDO, intl and gd extensions enabled.
+* PHP 8.2 or 8.3
-* MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
+* The next PHP extensions: json, curl, pdo, intl, gd and gmp/bcmath.
-* The web server of your choice with PHP integration (Apache or Nginx recommended).
+    * apcu extension is recommended if you don't plan to use openswoole.
+    * 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`.
+* The [openswoole](https://openswoole.com/) PHP extension (if you plan to serve Shlink with openswoole) or the web server of your choice with PHP integration (like Apache or Nginx).
 
 ### Download
 
@@ -50,7 +53,7 @@ In order to run Shlink, you will need a built version of the project. There are
 
     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_x.x.x_dist.zip` file you will find there.
+    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 and with/without openswoole integration.
 
     Finally, decompress the file in the location of your choice.
 
@@ -60,11 +63,13 @@ In order to run Shlink, you will need a built version of the project. There are
 
     * 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 1.0.0`, replacing the version with the version number you are going to build (the version number is only used for the generated dist file).
+    * 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 `shlink_x.x.x_dist.zip` dist file inside the `build` directory, that you need to decompress in the location fo your choice.
+    After that, you will have a dist file inside the `build` directory, that you need to decompress in the location of your choice.
 
-    > This is the process used when releasing new shlink versions. After tagging the new version with git, the Github release is automatically created by [travis](https://travis-ci.com/shlinkio/shlink), attaching the generated dist file to it.
+    > **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
 
@@ -72,290 +77,28 @@ Despite how you built the project, you now need to configure it, by following th
 
 * 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.
-* Setup the application by running the `bin/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.**
+* 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.
+* 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.
-
-### Serve
-
-Once Shlink is configured, you need to expose it to the web, either by using a traditional web server + fast CGI approach, or by using a [swoole](https://www.swoole.co.uk/) non-blocking server.
-
-* **Using a web server:**
-
-    For example, assuming your domain is doma.in and shlink is in the `/path/to/shlink` folder, these would be the basic configurations for Nginx and Apache.
-
-    *Nginx:*
-
-    ```nginx
-    server {
-        server_name doma.in;
-        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/php7.4-fpm.sock;
-            fastcgi_index index.php;
-            include fastcgi.conf;
-        }
-
-        location ~ /\.ht {
-            deny all;
-        }
-    }
-    ```
-
-    *Apache:*
-
-    ```apache
-    <VirtualHost *:80>
-        ServerName doma.in
-        DocumentRoot "/path/to/shlink/public"
-
-        <Directory "/path/to/shlink/public">
-            Options FollowSymLinks Includes ExecCGI
-            AllowOverride all
-            Order allow,deny
-            Allow from all
-        </Directory>
-    </VirtualHost>
-    ```
-
-* **Using swoole:**
-
-    First you need to install the swoole PHP extension with [pecl](https://pecl.php.net/package/swoole), `pecl install swoole`.
-
-    Once installed, it's actually pretty easy to get shlink up and running with swoole. Run `./vendor/bin/mezzio-swoole start -d` and you will get shlink running on port 8080.
-
-    However, by doing it this way, you are loosing all the access logs, and the service won't be automatically run if the server has to be restarted.
-
-    For that reason, you should create a daemon script, in `/etc/init.d/shlink_swoole`, like this one, replacing `/path/to/shlink` by the path to your shlink installation:
-
-    ```bash
-    #!/bin/bash
-    ### BEGIN INIT INFO
-    # Provides:          shlink_swoole
-    # Required-Start:    $local_fs $network $named $time $syslog
-    # Required-Stop:     $local_fs $network $named $time $syslog
-    # Default-Start:     2 3 4 5
-    # Default-Stop:      0 1 6
-    # Description:       Shlink non-blocking server with swoole
-    ### END INIT INFO
-
-    SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
-    RUNAS=root
-
-    PIDFILE=/var/run/shlink_swoole.pid
-    LOGDIR=/var/log/shlink
-    LOGFILE=${LOGDIR}/shlink_swoole.log
-
-    start() {
-      if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
-        echo 'Shlink with swoole already running' >&2
-        return 1
-      fi
-      echo 'Starting shlink with swoole' >&2
-      mkdir -p "$LOGDIR"
-      touch "$LOGFILE"
-      local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
-      su -c "$CMD" $RUNAS > "$PIDFILE"
-      echo 'Shlink started' >&2
-    }
-
-    stop() {
-      if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
-        echo 'Shlink with swoole not running' >&2
-        return 1
-      fi
-      echo 'Stopping shlink with swoole' >&2
-      kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
-      echo 'Shlink stopped' >&2
-    }
-
-    case "$1" in
-      start)
-        start
-        ;;
-      stop)
-        stop
-        ;;
-      restart)
-        stop
-        start
-        ;;
-      *)
-        echo "Usage: $0 {start|stop|restart}"
-    esac
-    ```
-
-    Then run these commands to enable the service and start it:
-
-    * `sudo chmod +x /etc/init.d/shlink_swoole`
-    * `sudo update-rc.d shlink_swoole defaults`
-    * `sudo update-rc.d shlink_swoole enable`
-    * `/etc/init.d/shlink_swoole start`
-
-    Now again, you can access shlink on port 8080, but this time the service will be automatically run at system start-up, and all access logs will be written in `/var/log/shlink/shlink_swoole.log` (you will probably want to [rotate those logs](https://www.digitalocean.com/community/tutorials/how-to-manage-logfiles-with-logrotate-on-ubuntu-16-04). You can find an example logrotate config file [here](data/infra/examples/shlink-daemon-logrotate.conf)).
-
-Finally access to [https://app.shlink.io](https://app.shlink.io) and configure your server to start creating short URLs.
-
-### Bonus
-
-Geo-locating visits to your short links is a time-consuming task. When serving Shlink with swoole, the geo-location task is automatically run asynchronously just after a visit to a short URL happens.
-
-However, if you are not serving Shlink with swoole, you will have to schedule the geo-location task to be run regularly in the background (for example, using cron jobs):
-
-The command you need to run is `/path/to/shlink/bin/cli visit:locate`, and you can optionally provide the `-q` flag to remove any output and avoid your cron logs to be polluted.
-
-## Update to new version
-
-When a new Shlink version is available, you don't need to repeat the entire process. Instead, follow these steps:
-
-1. Rename your existing Shlink directory to something else (ie. `shlink` ---> `shlink-old`).
-2. Download and extract the new version of Shlink, and set the directory name to that of the old version (ie. `shlink`).
-3. Run the `bin/update` script in the new version's directory to migrate your configuration over. You will be asked to provide the path to the old instance (ie. `shlink-old`).
-4. If you are using shlink with swoole, restart the service by running `/etc/init.d/shlink_swoole restart`.
-
-The `bin/update` will use the location from previous shlink version to import the configuration. It will then update the database and generate some assets shlink needs to work.
-
-**Important!** It is recommended that you don't skip any version when using this process. The update tool gets better on every version, but older versions might make assumptions.
-
-### Update a configuration option
-
-Sometimes you need to update the configuration on your shlink instance. Maybe you want to change the GeoLite2 license key, or move from http to https.
-
-In order to do that, run `bin/set-option` and follow the instructions. You will be asked to select the option to change, and then you will be asked to provide the new value.
-
-This script will take care of updating that value without changing anything else, and it will also delete the configuration cache so that the new value is applied.
-
-> This script will fail if you didn't run `bin/install` at least once.
-
-## Using a docker image
-
-Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](docker/README.md).
-
-The idea is that you can just generate a container using the image and provide custom config via env vars.
 
 ## Using shlink
 
 Once shlink is installed, there are two main ways to interact with it:
 
-* **The command line**. Try running `bin/cli` and see all the [available commands](#shlink-cli-help).
+* **The command line**: Try running `bin/cli` to see all the available commands.
 
-    All of those commands can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
+    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.
+* **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 you can host it yourself too.
+    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 the same operations, except for API key management, which can be done from the command line interface only.
+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.
 
-### Shlink CLI Help
+## 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.
-Usage:
-  command [options] [arguments]
-
-Options:
-  -h, --help            Display this help message
-  -q, --quiet           Do not output any message
-  -V, --version         Display this application version
-      --ansi            Force ANSI output
-      --no-ansi         Disable ANSI output
-  -n, --no-interaction  Do not ask any interactive question
-  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
-Available commands:
-  help                Displays help for a command
-  list                Lists commands
- api-key
-  api-key:disable     Disables an API key.
-  api-key:generate    Generates a new valid API key.
-  api-key:list        Lists all the available API keys.
- db
-  db:create           Creates the database needed for shlink to work. It will do nothing if the database already exists
-  db:migrate          Runs database migrations, which will ensure the shlink database is up to date.
- short-url
-  short-url:delete    Deletes a short URL
-  short-url:generate  Generates a short URL for provided long URL and returns it
-  short-url:list      List all short URLs
-  short-url:parse     Returns the long URL behind a short code
-  short-url:visits    Returns the detailed visits information for provided short code
- tag
-  tag:create          Creates one or more tags.
-  tag:delete          Deletes one or more tags.
-  tag:list            Lists existing tags.
-  tag:rename          Renames one existing tag.
- visit
-  visit:locate        Resolves visits origin locations.
-```
-
-## Multiple domains
-
-While in many cases you will just have one short domain and you'll want all your short URLs to be served from it, there are some cases in which you might want to have multiple short domains served from the same Shlink instance.
-
-If that's the case, you need to understand how Shlink will behave when managing your short URLs or any of them is visited.
-
-### Management
-
-When you create a short URL it is possible to optionally pass a `domain` param. If you don't pass it, the short URL will be created for the default domain (the one provided during Shlink's installation or in the `SHORT_DOMAIN_HOST` env var when using the docker image).
-
-However, if you pass it, the short URL will be "linked" to that domain.
-
-> Note that, if the default domain is passed, Shlink will ignore it and will behave as if no `domain` param was provided.
-
-The main benefit of being able to pass the domain is that Shlink will allow the same custom slug to be used in multiple short URLs, as long as the domain is different (like `example.com/my-compaign`, `another.com/my-compaign` and `foo.com/my-compaign`).
-
-Then, each short URL will be tracked separately and you will be able to define specific tags and metadata for each one of them.
-
-However, this has a side effect. When you try to interact with an existing short URL (editing tags, editing meta, resolving it or deleting it), either from the REST API or the CLI tool, you will have to provide the domain appropriately.
-
-Let's imagine this situation. Shlink's default domain is `example.com`, and you have the next short URLs:
-
-* `https://example.com/abc123` -> a regular short URL where no domain was provided.
-* `https://example.com/my-campaign` -> a regular short URL where no domain was provided, but it has a custom slug.
-* `https://another.com/my-campaign` -> a short URL where the `another.com` domain was provided, and it has a custom slug.
-* `https://another.com/def456` -> a short URL where the `another.com` domain was provided.
-
-These are some of the results you will get when trying to interact with them, depending on the params you provide:
-
-* Providing just the `abc123` short code -> the first URL will be matched.
-* Providing just the `my-campaign` short code -> the second URL will be matched, since you did not specify a domain, therefor, Shlink looks for the one with the short code/slug `my-campaign` which is also linked to default domain (or not linked to any domain, to be more accurate).
-* Providing the `my-campaign` short code and the `another.com` domain -> The third one will be matched.
-* Providing just the `def456` short code -> Shlink will fail/not find any short URL, since there's none with the short code `def456` linked to default domain.
-* Providing the `def456` short code and the `another.com` domain -> The fourth short URL will be matched.
-* Providing any short code and the `foo.com` domain -> Again, no short URL will be found, as there's none linked to `foo.com` domain.
-
-### Visits
-
-Before adding support for multiple domains, you could point as many domains as you wanted to Shlink, and they would have always worked for existing short codes/slugs.
-
-In order to keep backwards compatibility, Shlink's behavior when a short URL is visited is slightly different, getting to fallback in some cases.
-
-Let's continue with previous example, and also consider we have three domains that will resolve to our Shlink instance, which are `example.com`, `another.com` and `foo.com`.
-
-With that in mind, this is how Shlink will behave when the next short URLs are visited:
-
-* `https://another.com/abc123` -> There was no short URL specifically defined for domain `another.com` and short code `abc123`, but it exists for default domain (`example.com`), so it will fall back to it and redirect to where `example.com/abc123` is configured to redirect.
-* `https://example.com/def456` -> The fall-back does not happen from default domain to specific ones, only the other way around (like in previous case). Because of that, this one will result in a not-found URL, even though the `def456` short code exists for `another.com` domain.
-* `https://foo.com/abc123` -> This will also fall-back to `example.com/abc123`, like in the first case.
-* `https://another.com/non-existing` -> The combination of `another.com` domain with the `non-existing` slug does not exist, so Shlink will try to fall-back to the same but for default domain (`example.com`). However, since that combination does not exist either, it will result in a not-found URL.
-* Any other short URL visited exactly as it was configured will, of course, resolve as expected.
-
-### Special redirects
-
-It is currently possible to configure some special redirects when the base domain is visited, a URL does not match, or an invalid/disabled short URL is visited.
-
-Those are configured during Shlink's installation or via env vars when using the docker image.
-
-Currently those are all shared for all domains serving the same Shlink instance, but the plan is to update that and allow specific ones for every existing domain.
 
 ---
 

UPGRADE.md

@@ -1,5 +1,53 @@
 # Upgrading
 
+## 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
@@ -28,7 +76,7 @@ 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 me returned now.
+When using the old ones, a 404 status will be returned now.
 
 ### Removed command and route aliases
 

bin/cli

@@ -3,5 +3,8 @@
 
 declare(strict_types=1);
 
-$run = require __DIR__ . '/../config/run.php';
+use Symfony\Component\Console\Application;
-$run(true);
+
+/** @var Application $app */
+$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/install

@@ -1,12 +0,0 @@
-#!/usr/bin/env php
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink;
-
-use function chdir;
-use function dirname;
-
-chdir(dirname(__DIR__));
-[$install] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$install();

bin/roadrunner-worker.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use Mezzio\Application;
+use Psr\Container\ContainerInterface;
+use Shlinkio\Shlink\EventDispatcher\RoadRunner\RoadRunnerTaskConsumerToListener;
+use Spiral\RoadRunner\Http\PSR7Worker;
+
+use function Shlinkio\Shlink\Config\env;
+
+(static function (): void {
+    /** @var ContainerInterface $container */
+    $container = include __DIR__ . '/../config/container.php';
+    $rrMode = env('RR_MODE');
+
+    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);
+            }
+        }
+    } else {
+        $container->get(RoadRunnerTaskConsumerToListener::class)->listenForTasks();
+    }
+})();

bin/set-option

@@ -1,14 +0,0 @@
-#!/usr/bin/env php
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink;
-
-use Shlinkio\Shlink\Installer\Command\SetOptionCommand;
-
-use function chdir;
-use function dirname;
-
-chdir(dirname(__DIR__));
-[,, $installer] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$installer(SetOptionCommand::NAME);

bin/test/run-api-tests.sh

@@ -1,19 +1,38 @@
 #!/usr/bin/env sh
+
 export APP_ENV=test
-export DB_DRIVER=mysql
 export TEST_ENV=api
+export TEST_RUNTIME="${TEST_RUNTIME:-"openswoole"}" # Openswoole is deprecated. Remove in v4.0.0
+export DB_DRIVER="${DB_DRIVER:-"postgres"}"
+export GENERATE_COVERAGE="${GENERATE_COVERAGE:-"no"}"
+
+# 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
-vendor/bin/mezzio-swoole stop
+[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:stop
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -f
 
 echo 'Starting server...'
-vendor/bin/mezzio-swoole start -d
+[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:start -d
-sleep 2
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr serve -p -c=config/roadrunner/.rr.dev.yml \
+  -o=http.address=0.0.0.0:9999 \
+  -o=logs.encoding=json \
+  -o=logs.channels.http.encoding=json \
+  -o=logs.channels.server.encoding=json \
+  -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 --colors=always --log-junit=build/coverage-api/junit.xml $*
 testsExitCode=$?
 
-vendor/bin/mezzio-swoole stop
+[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:stop
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -c config/roadrunner/.rr.dev.yml -o=http.address=0.0.0.0:9999
 
 # Exit this script with the same code as the tests. If tests failed, this script has to fail
 exit $testsExitCode

bin/update

@@ -1,12 +0,0 @@
-#!/usr/bin/env php
-<?php
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink;
-
-use function chdir;
-use function dirname;
-
-chdir(dirname(__DIR__));
-[, $update] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$update();

build.sh

@@ -1,46 +1,63 @@
 #!/usr/bin/env bash
 set -e
 
-if [[ "$#" -ne 1 ]]; then
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ] || ([ "$#" == 2 ] && [ "$2" != "--no-swoole" ]); then
   echo "Usage:" >&2
-  echo "   $0 {version}" >&2
+  echo "   $0 {version} [--no-swoole]" >&2
   exit 1
 fi
 
 version=$1
-builtcontent="./build/shlink_${version}_dist"
+noSwoole=$2
+phpVersion=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
+# Openswoole is deprecated. Remove in v4.0.0
+[[ $noSwoole ]] && swooleSuffix="" || swooleSuffix="_openswoole"
+distId="shlink${version}_php${phpVersion}${swooleSuffix}_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}"
+rm -rf "${builtContent}"
-mkdir -p "${builtcontent}"
+mkdir -p "${builtContent}"
-rsync -av * "${builtcontent}" \
+rsync -av * "${builtContent}" \
     --exclude=*docker* \
     --exclude=Dockerfile \
     --include=.htaccess \
+    --include=config/roadrunner/.rr.yml \
     --exclude-from=./.dockerignore
-cd "${builtcontent}"
+cd "${builtContent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
+# Deprecated. Do not ignore PHP platform req for Shlink v4.0.0
+composerFlags="--optimize-autoloader --no-progress --no-interaction --ignore-platform-req=php+"
 ${composerBin} self-update
-${composerBin} install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction
+${composerBin} install --no-dev --prefer-dist $composerFlags
+
+if [[ $noSwoole ]]; then
+  # If generating a dist not for openswoole, uninstall mezzio-swoole
+  ${composerBin} remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev $composerFlags
+else
+  # Deprecated. Remove in Shlink v4.0.0
+  # If generating a dist for openswoole, uninstall RoadRunner
+  ${composerBin} remove spiral/roadrunner spiral/roadrunner-jobs spiral/roadrunner-cli spiral/roadrunner-http --with-all-dependencies --update-no-dev $composerFlags
+fi
 
 # Delete development files
 echo 'Deleting dev files...'
 rm composer.*
 
-# Update shlink version in config
+# Update Shlink version in config
 sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php
 
 # Compressing file
 echo 'Compressing files...'
 cd "${projectdir}"/build
-rm -f ./shlink_${version}_dist.zip
+rm -f ./${distId}.zip
-zip -ry ./shlink_${version}_dist.zip ./shlink_${version}_dist
+zip -ry ./${distId}.zip ./${distId}
 cd "${projectdir}"
-rm -rf "${builtcontent}"
+rm -rf "${builtContent}"
 
 echo 'Done!'

composer.json

@@ -12,68 +12,75 @@
         }
     ],
     "require": {
-        "php": "^7.4",
+        "php": "^8.2",
+        "ext-curl": "*",
+        "ext-gd": "*",
         "ext-json": "*",
         "ext-pdo": "*",
-        "akrabat/ip-address-middleware": "^2.0",
+        "akrabat/ip-address-middleware": "^2.1",
-        "cakephp/chronos": "^2.0",
+        "cakephp/chronos": "^3.0.2",
-        "cocur/slugify": "^4.0",
+        "doctrine/migrations": "^3.6",
-        "doctrine/cache": "^1.9",
+        "doctrine/orm": "^2.16",
-        "doctrine/migrations": "^3.0.2",
+        "endroid/qr-code": "^4.8",
-        "doctrine/orm": "^2.8",
+        "friendsofphp/proxy-manager-lts": "^1.0",
-        "endroid/qr-code": "^3.6",
+        "geoip2/geoip2": "^3.0",
-        "geoip2/geoip2": "^2.9",
+        "guzzlehttp/guzzle": "^7.5",
-        "guzzlehttp/guzzle": "^7.0",
+        "happyr/doctrine-specification": "^2.0",
-        "happyr/doctrine-specification": "2.0.x-dev#cb116d3 as 2.0",
+        "jaybizzle/crawler-detect": "^1.2.116",
-        "laminas/laminas-config": "^3.3",
+        "laminas/laminas-config": "^3.8",
-        "laminas/laminas-config-aggregator": "^1.1",
+        "laminas/laminas-config-aggregator": "^1.13",
-        "laminas/laminas-diactoros": "^2.1.3",
+        "laminas/laminas-diactoros": "^3.3",
-        "laminas/laminas-inputfilter": "^2.10",
+        "laminas/laminas-inputfilter": "^2.27",
-        "laminas/laminas-paginator": "^2.8",
+        "laminas/laminas-servicemanager": "^3.21",
-        "laminas/laminas-servicemanager": "^3.6",
+        "laminas/laminas-stdlib": "^3.17",
-        "laminas/laminas-stdlib": "^3.2",
+        "league/uri": "^6.8",
-        "lcobucci/jwt": "^4.0",
+        "matomo/matomo-php-tracker": "^3.2",
-        "league/uri": "^6.2",
+        "mezzio/mezzio": "^3.17",
-        "lstrojny/functional-php": "^1.15",
+        "mezzio/mezzio-fastroute": "^3.10",
-        "mezzio/mezzio": "^3.2",
+        "mezzio/mezzio-problem-details": "^1.13",
-        "mezzio/mezzio-fastroute": "^3.1",
+        "mezzio/mezzio-swoole": "^4.7",
-        "mezzio/mezzio-helpers": "^5.3",
+        "mlocati/ip-lib": "^1.18",
-        "mezzio/mezzio-problem-details": "^1.1",
+        "mobiledetect/mobiledetectlib": "^4.8",
-        "mezzio/mezzio-swoole": "^2.6.4",
+        "pagerfanta/core": "^3.8",
-        "monolog/monolog": "^2.0",
-        "nikolaposa/monolog-factory": "^3.1",
-        "ocramius/proxy-manager": "^2.11",
         "php-middleware/request-id": "^4.1",
-        "predis/predis": "^1.1",
+        "pugx/shortid-php": "^1.1",
-        "pugx/shortid-php": "^0.7",
+        "ramsey/uuid": "^4.7",
-        "ramsey/uuid": "^3.9",
+        "shlinkio/shlink-common": "^5.7.1",
-        "shlinkio/shlink-common": "dev-main#1311861 as 3.4",
+        "shlinkio/shlink-config": "^2.5",
-        "shlinkio/shlink-config": "^1.0",
+        "shlinkio/shlink-event-dispatcher": "^3.1",
-        "shlinkio/shlink-event-dispatcher": "^1.6",
+        "shlinkio/shlink-importer": "^5.2.1",
-        "shlinkio/shlink-importer": "^2.1",
+        "shlinkio/shlink-installer": "^8.7",
-        "shlinkio/shlink-installer": "^5.3",
+        "shlinkio/shlink-ip-geolocation": "^4.0",
-        "shlinkio/shlink-ip-geolocation": "^1.5",
+        "shlinkio/shlink-json": "^1.1",
-        "symfony/console": "^5.1",
+        "spiral/roadrunner": "^2023.2",
-        "symfony/filesystem": "^5.1",
+        "spiral/roadrunner-cli": "^2.5",
-        "symfony/lock": "^5.1",
+        "spiral/roadrunner-http": "^3.1",
-        "symfony/mercure": "^0.4.1",
+        "spiral/roadrunner-jobs": "^4.0",
-        "symfony/process": "^5.1",
+        "symfony/console": "^6.3",
-        "symfony/string": "^5.1"
+        "symfony/filesystem": "^6.3",
+        "symfony/lock": "^6.3",
+        "symfony/process": "^6.3",
+        "symfony/string": "^6.3"
     },
     "require-dev": {
+        "devizzent/cebe-php-openapi": "^1.0.1",
         "devster/ubench": "^2.1",
-        "dms/phpunit-arraysubset-asserts": "^0.2.1",
+        "infection/infection": "^0.27",
-        "eaglewu/swoole-ide-helper": "dev-master",
+        "openswoole/ide-helper": "~22.0.0",
-        "infection/infection": "^0.20.2",
+        "phpstan/phpstan": "^1.10",
-        "phpspec/prophecy-phpunit": "^2.0",
+        "phpstan/phpstan-doctrine": "^1.3",
-        "phpstan/phpstan": "^0.12.64",
+        "phpstan/phpstan-phpunit": "^1.3",
-        "phpunit/php-code-coverage": "^9.2",
+        "phpstan/phpstan-symfony": "^1.3",
-        "phpunit/phpunit": "^9.5",
+        "phpunit/php-code-coverage": "^10.1",
+        "phpunit/phpunit": "^10.4",
         "roave/security-advisories": "dev-master",
-        "shlinkio/php-coding-standard": "~2.1.1",
+        "shlinkio/php-coding-standard": "~2.3.0",
-        "shlinkio/shlink-test-utils": "^1.7",
+        "shlinkio/shlink-test-utils": "^3.8.1",
-        "symfony/var-dumper": "^5.2",
+        "symfony/var-dumper": "^6.3",
-        "veewee/composer-run-parallel": "^0.1.0"
+        "veewee/composer-run-parallel": "^1.3"
+    },
+    "conflict": {
+        "symfony/var-exporter": ">=6.3.9,<=6.4.0"
     },
     "autoload": {
         "psr-4": {
@@ -82,18 +89,21 @@
             "Shlinkio\\Shlink\\Core\\": "module/Core/src"
         },
         "files": [
+            "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",
-            "ShlinkioTest\\Shlink\\Core\\": [
+            "ShlinkioDbTest\\Shlink\\Rest\\": "module/Rest/test-db",
-                "module/Core/test",
+            "ShlinkioTest\\Shlink\\Core\\": "module/Core/test",
-                "module/Core/test-db"
+            "ShlinkioDbTest\\Shlink\\Core\\": "module/Core/test-db",
-            ]
+            "ShlinkioApiTest\\Shlink\\Core\\": "module/Core/test-api"
         },
         "files": [
             "config/test/constants.php"
@@ -101,30 +111,19 @@
     },
     "scripts": {
         "ci": [
-            "@cs",
+            "@parallel cs stan swagger:validate test:unit:ci test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
-            "@stan",
+            "@parallel infect:test:api infect:test:cli infect:ci:unit infect:ci:db"
-            "@test:ci",
-            "@infect:ci"
         ],
-        "ci:parallel": [
+        "cs": "phpcs -s",
-            "@parallel cs stan test:unit:ci test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
-            "@parallel test:api infect:ci:unit infect:ci:db"
-        ],
-        "cs": "phpcs",
         "cs:fix": "phpcbf",
-        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config data/migrations --level=6",
+        "stan": "APP_ENV=test php vendor/bin/phpstan analyse module/*/src module/*/test* module/*/config module/*/migrations config docker/config --level=8",
         "test": [
-            "@test:unit",
+            "@parallel test:unit test:db",
-            "@test:db",
+            "@parallel test:api test:cli"
-            "@test:api"
         ],
-        "test:ci": [
+        "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --testdox",
-            "@test:unit:ci",
+        "test:unit:ci": "@test:unit --coverage-php=build/coverage-unit.cov --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
-            "@test:db",
+        "test:unit:pretty": "@test:unit --coverage-html build/coverage-unit/coverage-html",
-            "@test:api"
-        ],
-        "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
-        "test:unit:ci": "@test:unit --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
         "test:db": "@parallel test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
         "test:db:sqlite": "APP_ENV=test php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-db.xml",
         "test:db:sqlite:ci": "@test:db:sqlite --coverage-php build/coverage-db.cov --coverage-xml=build/coverage-db/coverage-xml --log-junit=build/coverage-db/junit.xml",
@@ -133,44 +132,80 @@
         "test:db:postgres": "DB_DRIVER=postgres composer test:db:sqlite",
         "test:db:ms": "DB_DRIVER=mssql composer test:db:sqlite",
         "test:api": "bin/test/run-api-tests.sh",
-        "test:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
+        "test:api:rr": "TEST_RUNTIME=rr bin/test/run-api-tests.sh",
-        "infect:ci:base": "infection --threads=4 --log-verbosity=default --only-covered --skip-initial-tests",
+        "test:api:ci": "GENERATE_COVERAGE=yes composer test:api",
+        "test:api:pretty": "GENERATE_COVERAGE=pretty composer test:api",
+        "test:cli": "APP_ENV=test DB_DRIVER=maria TEST_ENV=cli php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-cli.xml --log-junit=build/coverage-cli/junit.xml",
+        "test:cli:ci": "GENERATE_COVERAGE=yes composer test:cli",
+        "test:cli:pretty": "GENERATE_COVERAGE=pretty composer test:cli",
+        "infect:ci:base": "infection --threads=max --only-covered --skip-initial-tests",
         "infect:ci:unit": "@infect:ci:base --coverage=build/coverage-unit --min-msi=80",
-        "infect:ci:db": "@infect:ci:base --coverage=build/coverage-db --min-msi=95 --configuration=infection-db.json",
+        "infect:ci:db": "@infect:ci:base --coverage=build/coverage-db --min-msi=95 --configuration=infection-db.json5",
-        "infect:ci": "@parallel infect:ci:unit infect:ci:db",
+        "infect:ci:api": "@infect:ci:base --coverage=build/coverage-api --min-msi=95 --configuration=infection-api.json5",
+        "infect:ci:cli": "@infect:ci:base --coverage=build/coverage-cli --min-msi=90 --configuration=infection-cli.json5",
+        "infect:ci": "@parallel infect:ci:unit infect:ci:db infect:ci:api infect:ci:cli",
         "infect:test": [
-            "@parallel test:unit:ci test:db:sqlite:ci",
+            "@parallel test:unit:ci test:db:sqlite:ci test:api:ci",
             "@infect:ci"
         ],
+        "infect:test:unit": [
+            "@test:unit:ci",
+            "@infect:ci:unit"
+        ],
+        "infect:test:db": [
+            "@test:db:sqlite:ci",
+            "@infect:ci:db"
+        ],
+        "infect:test:api": [
+            "@test:api:ci",
+            "@infect:ci:api"
+        ],
+        "infect:test:cli": [
+            "@test:cli:ci",
+            "@infect:ci:cli"
+        ],
+        "swagger:validate": "php-openapi validate docs/swagger/swagger.json",
+        "swagger:inline": "php-openapi inline docs/swagger/swagger.json docs/swagger/swagger-inlined.json",
         "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
     },
     "scripts-descriptions": {
-        "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test:ci\" and \"infect:ci\"</>",
+        "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"swagger:validate\", \"test:ci\" and \"infect:ci\"</>",
-        "ci:parallel": "<fg=blue;options=bold>Same as \"ci\", but parallelizing tasks as much as possible</>",
         "cs": "<fg=blue;options=bold>Checks coding styles</>",
         "cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
         "stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
         "test": "<fg=blue;options=bold>Runs all test suites</>",
-        "test:ci": "<fg=blue;options=bold>Runs all test suites, generating all needed reports and logs for CI envs</>",
         "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
         "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
+        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
         "test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB, PostgreSQL and MsSQL</>",
         "test:db:sqlite": "<fg=blue;options=bold>Runs database test suites on a SQLite database</>",
         "test:db:sqlite:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite database, generating all needed reports and logs for CI envs</>",
         "test:db:mysql": "<fg=blue;options=bold>Runs database test suites on a MySQL database</>",
         "test:db:maria": "<fg=blue;options=bold>Runs database test suites on a MariaDB database</>",
         "test:db:postgres": "<fg=blue;options=bold>Runs database test suites on a PostgreSQL database</>",
-        "test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Miscrosoft SQL Server database</>",
+        "test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Microsoft SQL Server database</>",
         "test:api": "<fg=blue;options=bold>Runs API test suites</>",
-        "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
+        "test:api:ci": "<fg=blue;options=bold>Runs API test suites, and generates code coverage for CI</>",
+        "test:api:pretty": "<fg=blue;options=bold>Runs API test suites, and generates code coverage in HTML format</>",
+        "test:cli": "<fg=blue;options=bold>Runs CLI test suites</>",
+        "test:cli:ci": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage for CI</>",
+        "test:cli:pretty": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage in HTML format</>",
         "infect:ci": "<fg=blue;options=bold>Checks unit and db tests quality applying mutation testing with existing reports and logs</>",
         "infect:ci:unit": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
         "infect:ci:db": "<fg=blue;options=bold>Checks db tests quality applying mutation testing with existing reports and logs</>",
         "infect:test": "<fg=blue;options=bold>Runs unit and db tests, then checks tests quality applying mutation testing</>",
+        "swagger:validate": "<fg=blue;options=bold>Validates the swagger docs, making sure they fulfil the spec</>",
+        "swagger:inline": "<fg=blue;options=bold>Inlines swagger docs in a single file</>",
         "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
     },
     "config": {
         "sort-packages": true,
-        "platform-check": false
+        "platform-check": false,
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "infection/extension-installer": true,
+            "veewee/composer-run-parallel": true
+        }
     }
 }

config/autoload/app_options.global.php

@@ -7,7 +7,6 @@ return [
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'disable_track_param' => null,
     ],
 
 ];

config/autoload/app_options.local.php.dist

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'app_options' => [
+        'version' => 'latest',
+    ],
+
+];

config/autoload/cache.global.php

@@ -0,0 +1,25 @@
+<?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(false)];
+    $cacheRedisBlock = $redisServers === null ? [] : [
+        'redis' => [
+            'servers' => $redisServers,
+            'sentinel_service' => EnvVars::REDIS_SENTINEL_SERVICE->loadFromEnv(),
+            'decode_credentials' => (bool) EnvVars::REDIS_DECODE_CREDENTIALS->loadFromEnv(false),
+        ],
+    ];
+
+    return [
+        'cache' => [
+            'namespace' => EnvVars::CACHE_NAMESPACE->loadFromEnv('Shlink'),
+            ...$cacheRedisBlock,
+        ],
+        'redis' => $redis,
+    ];
+})();

config/autoload/common.global.php

@@ -8,8 +8,8 @@ return [
 
     'debug' => false,
 
-    // Disabling config cache for cli, ensures it's never used for swoole and also that console commands don't generate
+    // Disabling config cache for cli, ensures it's never used for openswoole/RoadRunner, and also that console
-    // a cache file that's then used by non-swoole web executions
+    // commands don't generate a cache file that's then used by php-fpm web executions
     ConfigAggregator::ENABLE_CACHE => PHP_SAPI !== 'cli',
 
 ];

config/autoload/delete_short_urls.global.php

@@ -4,11 +4,17 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-return [
+use Shlinkio\Shlink\Core\Config\EnvVars;
 
-    'delete_short_urls' => [
+return (static function (): array {
-        'visits_threshold' => 15,
+    $threshold = EnvVars::DELETE_SHORT_URL_THRESHOLD->loadFromEnv();
-        'check_visits_threshold' => true,
-    ],
 
-];
+    return [
+
+        'delete_short_urls' => [
+            'check_visits_threshold' => $threshold !== null,
+            'visits_threshold' => (int) ($threshold ?? DEFAULT_DELETE_SHORT_URL_THRESHOLD),
+        ],
+
+    ];
+})();

config/autoload/dependencies.global.php

@@ -3,14 +3,25 @@
 declare(strict_types=1);
 
 use GuzzleHttp\Client;
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+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 Spiral\RoadRunner\Http\PSR7Worker;
+use Spiral\RoadRunner\WorkerInterface;
 
 return [
 
     'dependencies' => [
+        'factories' => [
+            PSR7Worker::class => ConfigAbstractFactory::class,
+        ],
+
         'delegators' => [
-            Mezzio\Application::class => [
+            Application::class => [
                 Container\ApplicationConfigInjectionDelegator::class,
             ],
         ],
@@ -26,4 +37,13 @@ return [
         ],
     ],
 
+    ConfigAbstractFactory::class => [
+        PSR7Worker::class => [
+            WorkerInterface::class,
+            ServerRequestFactoryInterface::class,
+            StreamFactoryInterface::class,
+            UploadedFileFactoryInterface::class,
+        ],
+    ],
+
 ];

config/autoload/entity-manager.global.php

@@ -2,24 +2,62 @@
 
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common;
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
+use Shlinkio\Shlink\Core\Config\EnvVars;
 
-use Happyr\DoctrineSpecification\EntitySpecificationRepository;
+use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 
-return [
+return (static function (): array {
+    $driver = EnvVars::DB_DRIVER->loadFromEnv();
+    $isMysqlCompatible = contains($driver, ['maria', 'mysql']);
 
-    'entity_manager' => [
+    $resolveDriver = static fn () => match ($driver) {
-        'orm' => [
+        'postgres' => 'pdo_pgsql',
-            'proxies_dir' => 'data/proxies',
+        'mssql' => 'pdo_sqlsrv',
-            'load_mappings_using_functional_style' => true,
+        default => 'pdo_mysql',
-            'default_repository_classname' => EntitySpecificationRepository::class,
+    };
+    $resolveDefaultPort = static fn () => match ($driver) {
+        'postgres' => '5432',
+        'mssql' => '1433',
+        default => '3306',
+    };
+    $resolveCharset = static fn () => 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,
+    };
+    $resolveConnection = static fn () => match ($driver) {
+        null, 'sqlite' => [
+            'driver' => 'pdo_sqlite',
+            'path' => 'data/database.sqlite',
         ],
-        'connection' => [
+        default => [
-            'user' => '',
+            'driver' => $resolveDriver(),
-            'password' => '',
+            'dbname' => EnvVars::DB_NAME->loadFromEnv('shlink'),
-            'dbname' => 'shlink',
+            'user' => EnvVars::DB_USER->loadFromEnv(),
-            'charset' => 'utf8',
+            'password' => EnvVars::DB_PASSWORD->loadFromEnv(),
+            'host' => EnvVars::DB_HOST->loadFromEnv(EnvVars::DB_UNIX_SOCKET->loadFromEnv()),
+            'port' => EnvVars::DB_PORT->loadFromEnv($resolveDefaultPort()),
+            'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
+            'charset' => $resolveCharset(),
+            'driverOptions' => $driver !== 'mssql' ? [] : [
+                'TrustServerCertificate' => 'true',
+            ],
         ],
-    ],
+    };
 
-];
+    return [
+
+        'entity_manager' => [
+            'orm' => [
+                'proxies_dir' => 'data/proxies',
+                'load_mappings_using_functional_style' => true,
+                'default_repository_classname' => EntitySpecificationRepository::class,
+            ],
+            'connection' => $resolveConnection(),
+        ],
+
+    ];
+})();

config/autoload/entity-manager.local.php.dist

@@ -2,23 +2,44 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Common\env;
-
-// When running tests, any mysql-specific option can interfere with other drivers
-$driverOptions = env('APP_ENV') === 'test' ? [] : [
-    PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-    PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
-];
-
 return [
 
     'entity_manager' => [
         'connection' => [
+            // MySQL
             'user' => 'root',
             'password' => 'root',
             'driver' => 'pdo_mysql',
-            'host' => 'shlink_db',
+            'host' => 'shlink_db_mysql',
-            'driverOptions' => $driverOptions,
+            'dbname' => 'shlink',
+//            'dbname' => 'shlink_foo',
+            'charset' => 'utf8mb4',
+
+            // MariaDB
+//            'user' => 'root',
+//            'password' => 'root',
+//            'driver' => 'pdo_mysql',
+//            'host' => 'shlink_db_maria',
+//            'dbname' => 'shlink_foo',
+//            'charset' => 'utf8mb4',
+
+            // Postgres
+//            'user' => 'postgres',
+//            'password' => 'root',
+//            'driver' => 'pdo_pgsql',
+//            'host' => 'shlink_db_postgres',
+//            'dbname' => 'shlink_foo',
+//            'charset' => 'utf8',
+
+            // MSSQL
+//            'user' => 'sa',
+//            'password' => 'Passw0rd!',
+//            'driver' => 'pdo_sqlsrv',
+//            'host' => 'shlink_db_ms',
+//            'dbname' => 'shlink_foo',
+//            'driverOptions' => [
+//                'TrustServerCertificate' => 'true',
+//            ],
         ],
     ],
 

config/autoload/error-handler.global.php

@@ -6,12 +6,14 @@ 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 => 'NOT_FOUND',
+            404 => toProblemDetailsType('not-found'),
-            500 => 'INTERNAL_SERVER_ERROR',
+            500 => toProblemDetailsType('internal-server-error'),
         ],
     ],
 

config/autoload/geolite2.global.php

@@ -2,12 +2,14 @@
 
 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' => 'G4Lm0C60yJsnkdPi', // Deprecated. Remove hardcoded license on v3
+        'license_key' => EnvVars::GEOLITE_LICENSE_KEY->loadFromEnv(),
     ],
 
 ];

config/autoload/installer.global.php

@@ -2,12 +2,16 @@
 
 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\Database\DatabaseDriverConfigOption::class,
             Option\Database\DatabaseNameConfigOption::class,
             Option\Database\DatabaseHostConfigOption::class,
@@ -15,39 +19,84 @@ return [
             Option\Database\DatabaseUserConfigOption::class,
             Option\Database\DatabasePasswordConfigOption::class,
             Option\Database\DatabaseUnixSocketConfigOption::class,
-            Option\Database\DatabaseSqlitePathConfigOption::class,
-            Option\Database\DatabaseMySqlOptionsConfigOption::class,
             Option\UrlShortener\ShortDomainHostConfigOption::class,
             Option\UrlShortener\ShortDomainSchemaConfigOption::class,
-            Option\UrlShortener\ValidateUrlConfigOption::class,
             Option\Visit\VisitsWebhooksConfigOption::class,
+            Option\Visit\OrphanVisitsWebhooksConfigOption::class,
             Option\Redirect\BaseUrlRedirectConfigOption::class,
             Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
             Option\Redirect\Regular404RedirectConfigOption::class,
-            Option\DisableTrackParamConfigOption::class,
-            Option\Visit\CheckVisitsThresholdConfigOption::class,
             Option\Visit\VisitsThresholdConfigOption::class,
             Option\BasePathConfigOption::class,
+            Option\TimezoneConfigOption::class,
+            Option\Cache\CacheNamespaceConfigOption::class,
             Option\Worker\TaskWorkerNumConfigOption::class,
             Option\Worker\WebWorkerNumConfigOption::class,
-            Option\RedisServersConfigOption::class,
+            Option\Redis\RedisServersConfigOption::class,
+            Option\Redis\RedisDecodeCredentialsConfigOption::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\IpAnonymizationConfigOption::class,
             Option\UrlShortener\RedirectStatusCodeConfigOption::class,
             Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
+            Option\UrlShortener\AutoResolveTitlesConfigOption::class,
+            Option\UrlShortener\AppendExtraPathConfigOption::class,
+            Option\UrlShortener\EnableMultiSegmentSlugsConfigOption::class,
+            Option\UrlShortener\EnableTrailingSlashConfigOption::class,
+            Option\UrlShortener\ShortUrlModeConfigOption::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\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,
         ],
 
         'installation_commands' => [
-            'db_create_schema' => [
+            InstallationCommand::DB_CREATE_SCHEMA->value => [
-                'command' => 'bin/cli db:create',
+                'command' => 'bin/cli ' . Command\Db\CreateDatabaseCommand::NAME,
             ],
-            'db_migrate' => [
+            InstallationCommand::DB_MIGRATE->value => [
-                'command' => 'bin/cli db:migrate',
+                '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/locks.global.php

@@ -4,11 +4,12 @@ declare(strict_types=1);
 
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Shlinkio\Shlink\Common\Cache\RedisFactory;
-use Shlinkio\Shlink\Common\Lock\RetryLockStoreDelegatorFactory;
+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\Core\LOCAL_LOCK_FACTORY;
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 return [
 
@@ -22,18 +23,15 @@ return [
             Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
             Lock\LockFactory::class => ConfigAbstractFactory::class,
             LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
+            NamespacedStore::class => ConfigAbstractFactory::class,
         ],
         'aliases' => [
-            // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
+            'lock_store' => EnvVars::REDIS_SERVERS->existsInEnv() ? 'redis_lock_store' : 'local_lock_store',
-            'lock_store' => 'local_lock_store',
 
-            'redis_lock_store' => Lock\Store\RedisStore::class,
+            'redis_lock_store' => NamespacedStore::class,
             'local_lock_store' => Lock\Store\FlockStore::class,
         ],
         'delegators' => [
-            Lock\Store\RedisStore::class => [
-                RetryLockStoreDelegatorFactory::class,
-            ],
             Lock\LockFactory::class => [
                 LoggerAwareDelegatorFactory::class,
             ],
@@ -43,6 +41,8 @@ return [
     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

@@ -4,87 +4,64 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Monolog\Formatter;
+use Laminas\ServiceManager\Factory\InvokableFactory;
-use Monolog\Handler;
+use Monolog\Level;
 use Monolog\Logger;
-use Monolog\Processor;
-use MonologFactory\DiContainerLoggerFactory;
 use PhpMiddleware\RequestId;
 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 const PHP_EOL;
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
-$processors = [
+return (static function (): array {
-    'exception_with_new_line' => [
+    $common = [
-        'name' => Common\Logger\Processor\ExceptionWithNewLineProcessor::class,
+        'level' => Level::Info->value,
-    ],
+        'processors' => [RequestId\MonologProcessor::class],
-    'psr3' => [
+        'line_format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%',
-        'name' => Processor\PsrLogMessageProcessor::class,
+    ];
-    ],
-    'request_id' => RequestId\MonologProcessor::class,
-];
-$formatter = [
-    'name' => Formatter\LineFormatter::class,
-    'params' => [
-        'format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%' . PHP_EOL,
-        'allow_inline_line_breaks' => true,
-    ],
-];
 
-return [
+    return [
 
-    'logger' => [
+        'logger' => [
-        'Shlink' => [
+            'Shlink' => [
-            'name' => 'Shlink',
+                'type' => LoggerType::FILE->value,
-            'handlers' => [
+                ...$common,
-                'shlink_handler' => [
+            ],
-                    'name' => Handler\RotatingFileHandler::class,
+            'Access' => [
-                    'params' => [
+                'type' => LoggerType::STREAM->value,
-                        'level' => Logger::INFO,
+                'destination' => 'php://stderr',
-                        'filename' => 'data/log/shlink_log.log',
+                'add_new_line' => ! runningInRoadRunner(),
-                        'max_files' => 30,
+                ...$common,
-                        'file_permission' => 0666,
+            ],
-                    ],
+        ],
-                    'formatter' => $formatter,
+
+        'dependencies' => [
+            'factories' => [
+                'Logger_Shlink' => [LoggerFactory::class, 'Shlink'],
+                'Logger_Access' => [LoggerFactory::class, 'Access'],
+                NullLogger::class => InvokableFactory::class,
+            ],
+            'aliases' => [
+                'logger' => 'Logger_Shlink',
+                Logger::class => 'Logger_Shlink',
+                LoggerInterface::class => 'Logger_Shlink',
+                AccessLogMiddleware::LOGGER_SERVICE_NAME => 'Logger_Access',
+            ],
+        ],
+
+        // Deprecated. Remove in Shlink 4.0.0
+        'mezzio-swoole' => [
+            'swoole-http-server' => [
+                'logger' => [
+                    // Let's disable mezio-swoole access logging, so that we can provide our own implementation,
+                    // consistent for roadrunner and openswoole
+                    'logger-name' => NullLogger::class,
                 ],
             ],
-            'processors' => $processors,
         ],
-        'Access' => [
-            'name' => 'Access',
-            'handlers' => [
-                'access_handler' => [
-                    'name' => Handler\StreamHandler::class,
-                    'params' => [
-                        'level' => Logger::INFO,
-                        'stream' => 'php://stdout',
-                    ],
-                    'formatter' => $formatter,
-                ],
-            ],
-            'processors' => $processors,
-        ],
-    ],
 
-    'dependencies' => [
+    ];
-        'factories' => [
+})();
-            'Logger_Shlink' => [DiContainerLoggerFactory::class, 'Shlink'],
-            'Logger_Access' => [DiContainerLoggerFactory::class, 'Access'],
-        ],
-        'aliases' => [
-            'logger' => 'Logger_Shlink',
-            Logger::class => 'Logger_Shlink',
-            LoggerInterface::class => 'Logger_Shlink',
-        ],
-    ],
-
-    'mezzio-swoole' => [
-        'swoole-http-server' => [
-            'logger' => [
-                'logger-name' => 'Logger_Access',
-                'format' => '%h %l %u "%r" %>s %b',
-            ],
-        ],
-    ],
-
-];

config/autoload/logger.local.php.dist

@@ -2,33 +2,16 @@
 
 declare(strict_types=1);
 
-use Monolog\Handler\StreamHandler;
+use Monolog\Level;
-use Monolog\Logger;
+use Shlinkio\Shlink\Common\Logger\LoggerType;
-
-$isSwoole = extension_loaded('swoole');
-
-// For swoole, send logs to standard output
-$handler = $isSwoole
-    ? [
-        'name' => StreamHandler::class,
-        'params' => [
-            'level' => Logger::DEBUG,
-            'stream' => 'php://stdout',
-        ],
-    ]
-    : [
-        'params' => [
-            'level' => Logger::DEBUG,
-        ],
-    ];
 
 return [
 
     'logger' => [
         'Shlink' => [
-            'handlers' => [
+            'type' => LoggerType::STREAM->value,
-                'shlink_handler' => $handler,
+            'destination' => 'php://stderr',
-            ],
+            'level' => Level::Debug->value,
         ],
     ],
 

config/autoload/matomo.global.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'matomo' => [
+        'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(false),
+        'base_url' => EnvVars::MATOMO_BASE_URL->loadFromEnv(),
+        'site_id' => EnvVars::MATOMO_SITE_ID->loadFromEnv(),
+        'api_token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),
+    ],
+
+];

config/autoload/matomo.local.php.dist

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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 `site_id` field 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 `api_token` field below.
+ */
+
+return [
+
+    'matomo' => [
+//        'enabled' => true,
+//        'base_url' => 'http://shlink_matomo',
+//        'site_id' => '...',
+//        'api_token' => '...',
+    ],
+
+];

config/autoload/mercure.global.php

@@ -4,33 +4,38 @@ declare(strict_types=1);
 
 use Laminas\ServiceManager\Proxy\LazyServiceFactory;
 use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
-use Symfony\Component\Mercure\Publisher;
+use Shlinkio\Shlink\Core\Config\EnvVars;
-use Symfony\Component\Mercure\PublisherInterface;
+use Symfony\Component\Mercure\Hub;
+use Symfony\Component\Mercure\HubInterface;
 
-return [
+return (static function (): array {
+    $publicUrl = EnvVars::MERCURE_PUBLIC_HUB_URL->loadFromEnv();
 
-    'mercure' => [
+    return [
-        'public_hub_url' => null,
-        'internal_hub_url' => null,
-        'jwt_secret' => null,
-        'jwt_issuer' => 'Shlink',
-    ],
 
-    'dependencies' => [
+        'mercure' => [
-        'delegators' => [
+            'public_hub_url' => $publicUrl,
-            LcobucciJwtProvider::class => [
+            'internal_hub_url' => EnvVars::MERCURE_INTERNAL_HUB_URL->loadFromEnv($publicUrl),
-                LazyServiceFactory::class,
+            'jwt_secret' => EnvVars::MERCURE_JWT_SECRET->loadFromEnv(),
+            'jwt_issuer' => 'Shlink',
+        ],
+
+        'dependencies' => [
+            'delegators' => [
+                LcobucciJwtProvider::class => [
+                    LazyServiceFactory::class,
+                ],
+                Hub::class => [
+                    LazyServiceFactory::class,
+                ],
             ],
-            Publisher::class => [
+            'lazy_services' => [
-                LazyServiceFactory::class,
+                'class_map' => [
+                    LcobucciJwtProvider::class => LcobucciJwtProvider::class,
+                    Hub::class => HubInterface::class,
+                ],
             ],
         ],
-        'lazy_services' => [
-            'class_map' => [
-                LcobucciJwtProvider::class => LcobucciJwtProvider::class,
-                Publisher::class => PublisherInterface::class,
-            ],
-        ],
-    ],
 
-];
+    ];
+})();

config/autoload/mercure.local.php.dist

@@ -7,7 +7,7 @@ return [
     'mercure' => [
         'public_hub_url' => 'http://localhost:8001',
         'internal_hub_url' => 'http://shlink_mercure_proxy',
-        'jwt_secret' => 'mercure_jwt_key',
+        'jwt_secret' => 'mercure_jwt_key_long_enough_to_avoid_error',
     ],
 
 ];

config/autoload/middleware-pipeline.global.php

@@ -5,25 +5,28 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\Stratigility\Middleware\ErrorHandler;
-use Mezzio\Helper;
 use Mezzio\ProblemDetails;
 use Mezzio\Router;
 use PhpMiddleware\RequestId\RequestIdMiddleware;
+use RKA\Middleware\IpAddress;
+use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
+use Shlinkio\Shlink\Common\Middleware\ContentLengthMiddleware;
 
 return [
 
     'middleware_pipeline' => [
         'error-handler' => [
             'middleware' => [
-                Helper\ContentLengthMiddleware::class,
+                AccessLogMiddleware::class,
+                ContentLengthMiddleware::class,
+                RequestIdMiddleware::class,
                 ErrorHandler::class,
+                Rest\Middleware\CrossDomainMiddleware::class,
             ],
         ],
         'error-handler-rest' => [
             'path' => '/rest',
             'middleware' => [
-                Rest\Middleware\CrossDomainMiddleware::class,
-                RequestIdMiddleware::class,
                 ProblemDetails\ProblemDetailsMiddleware::class,
             ],
         ],
@@ -44,6 +47,7 @@ return [
         'rest' => [
             'path' => '/rest',
             'middleware' => [
+                Rest\Middleware\ErrorHandler\BackwardsCompatibleProblemDetailsHandler::class,
                 Router\Middleware\ImplicitOptionsMiddleware::class,
                 Rest\Middleware\BodyParserMiddleware::class,
                 Rest\Middleware\AuthenticationMiddleware::class,
@@ -64,6 +68,11 @@ return [
         ],
         'not-found' => [
             'middleware' => [
+                // This middleware is in front of tracking actions explicitly. Putting here for orphan visits tracking
+                IpAddress::class,
+                Core\ErrorHandler\NotFoundTypeResolverMiddleware::class,
+                Core\ShortUrl\Middleware\ExtraPathRedirectMiddleware::class,
+                Core\ErrorHandler\NotFoundTrackerMiddleware::class,
                 Core\ErrorHandler\NotFoundRedirectHandler::class,
                 Core\ErrorHandler\NotFoundTemplateHandler::class,
             ],

config/autoload/qr-codes.global.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_ERROR_CORRECTION;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_FORMAT;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_MARGIN;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_ROUND_BLOCK_SIZE;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_SIZE;
+
+return [
+
+    'qr_codes' => [
+        'size' => (int) EnvVars::DEFAULT_QR_CODE_SIZE->loadFromEnv(DEFAULT_QR_CODE_SIZE),
+        'margin' => (int) EnvVars::DEFAULT_QR_CODE_MARGIN->loadFromEnv(DEFAULT_QR_CODE_MARGIN),
+        'format' => EnvVars::DEFAULT_QR_CODE_FORMAT->loadFromEnv(DEFAULT_QR_CODE_FORMAT),
+        'error_correction' => EnvVars::DEFAULT_QR_CODE_ERROR_CORRECTION->loadFromEnv(
+            DEFAULT_QR_CODE_ERROR_CORRECTION,
+        ),
+        'round_block_size' => (bool) EnvVars::DEFAULT_QR_CODE_ROUND_BLOCK_SIZE->loadFromEnv(
+            DEFAULT_QR_CODE_ROUND_BLOCK_SIZE,
+        ),
+        'enabled_for_disabled_short_urls' => (bool) EnvVars::QR_CODE_FOR_DISABLED_SHORT_URLS->loadFromEnv(
+            DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS,
+        ),
+    ],
+
+];

config/autoload/rabbit.global.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'rabbitmq' => [
+        'enabled' => (bool) EnvVars::RABBITMQ_ENABLED->loadFromEnv(false),
+        'host' => EnvVars::RABBITMQ_HOST->loadFromEnv(),
+        'use_ssl' => (bool) EnvVars::RABBITMQ_USE_SSL->loadFromEnv(false),
+        'port' => (int) EnvVars::RABBITMQ_PORT->loadFromEnv('5672'),
+        'user' => EnvVars::RABBITMQ_USER->loadFromEnv(),
+        'password' => EnvVars::RABBITMQ_PASSWORD->loadFromEnv(),
+        'vhost' => EnvVars::RABBITMQ_VHOST->loadFromEnv('/'),
+
+        // Deprecated
+        'legacy_visits_publishing' => (bool) EnvVars::RABBITMQ_LEGACY_VISITS_PUBLISHING->loadFromEnv(false),
+    ],
+
+];

config/autoload/rabbit.local.php.dist

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'rabbitmq' => [
+        'enabled' => true,
+        'host' => 'shlink_rabbitmq',
+        'user' => 'rabbit',
+        'password' => 'rabbit',
+    ],
+
+];

config/autoload/redirects.global.php

@@ -2,12 +2,24 @@
 
 declare(strict_types=1);
 
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+use const Shlinkio\Shlink\DEFAULT_REDIRECT_CACHE_LIFETIME;
+use const Shlinkio\Shlink\DEFAULT_REDIRECT_STATUS_CODE;
+
 return [
 
     'not_found_redirects' => [
-        'invalid_short_url' => null,
+        'invalid_short_url' => EnvVars::DEFAULT_INVALID_SHORT_URL_REDIRECT->loadFromEnv(),
-        'regular_404' => null,
+        'regular_404' => EnvVars::DEFAULT_REGULAR_404_REDIRECT->loadFromEnv(),
-        'base_url' => null,
+        'base_url' => EnvVars::DEFAULT_BASE_URL_REDIRECT->loadFromEnv(),
+    ],
+
+    'redirects' => [
+        'redirect_status_code' => (int) EnvVars::REDIRECT_STATUS_CODE->loadFromEnv(DEFAULT_REDIRECT_STATUS_CODE->value),
+        'redirect_cache_lifetime' => (int) EnvVars::REDIRECT_CACHE_LIFETIME->loadFromEnv(
+            DEFAULT_REDIRECT_CACHE_LIFETIME,
+        ),
     ],
 
 ];

config/autoload/redis.local.php.local

@@ -7,12 +7,15 @@ return [
     'cache' => [
         'redis' => [
             'servers' => 'tcp://shlink_redis:6379',
-//            'servers' => [
+//            'servers' => 'tcp://barbar@shlink_redis_acl:6379',
-//                'tcp://shlink_redis:6379',
+//            'servers' => 'tcp://foo:bar@shlink_redis_acl:6379',
-//            ],
         ],
     ],
 
+    'redis' => [
+        'pub_sub_enabled' => true,
+    ],
+
     'dependencies' => [
         'aliases' => [
             // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default

config/autoload/request_id.global.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use PhpMiddleware\RequestId;
+use Shlinkio\Shlink\Common\Logger\Processor\BackwardsCompatibleMonologProcessorDelegator;
 
 return [
 
@@ -20,6 +21,11 @@ return [
             RequestId\RequestIdMiddleware::class => ConfigAbstractFactory::class,
             RequestId\MonologProcessor::class => ConfigAbstractFactory::class,
         ],
+        'delegators' => [
+            RequestId\MonologProcessor::class => [
+                BackwardsCompatibleMonologProcessorDelegator::class,
+            ],
+        ],
     ],
 
     ConfigAbstractFactory::class => [

config/autoload/router.global.php

@@ -3,14 +3,17 @@
 declare(strict_types=1);
 
 use Mezzio\Router\FastRouteRouter;
+use Shlinkio\Shlink\Core\Config\EnvVars;
 
 return [
 
     'router' => [
-        'base_path' => '',
+        'base_path' => EnvVars::BASE_PATH->loadFromEnv(''),
 
         'fastroute' => [
-            FastRouteRouter::CONFIG_CACHE_ENABLED => true,
+            // Disabling config cache for cli, ensures it's never used for openswoole/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 => PHP_SAPI !== 'cli',
             FastRouteRouter::CONFIG_CACHE_FILE => 'data/cache/fastroute_cached_routes.php',
         ],
     ],

config/autoload/routes.config.php

@@ -0,0 +1,115 @@
+<?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\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 {
+    $contentNegotiationMiddleware = Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class;
+    $dropDomainMiddleware = Middleware\ShortUrl\DropDefaultDomainFromRequestMiddleware::class;
+    $overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class;
+
+    // TODO This should be based on config, not the env var
+    $shortUrlRouteSuffix = EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(false) ? '[/]' : '';
+
+    return [
+
+        // The order of the routes defined here matters. Changing it might cause path conflicts
+        'routes' => [
+            // Rest
+            ...ConfigProvider::applyRoutesPrefix([
+                Action\HealthAction::getRouteDef(),
+
+                // Visits.
+                // These 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
+                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(),
+
+                // Short URLs
+                Action\ShortUrl\CreateShortUrlAction::getRouteDef([
+                    $contentNegotiationMiddleware,
+                    $dropDomainMiddleware,
+                    $overrideDomainMiddleware,
+                    Middleware\ShortUrl\DefaultShortCodesLengthMiddleware::class,
+                ]),
+                Action\ShortUrl\SingleStepCreateShortUrlAction::getRouteDef([
+                    $contentNegotiationMiddleware,
+                    $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,
+                    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,
+                    TrimTrailingSlashMiddleware::class,
+                    CoreAction\RedirectAction::class,
+                ],
+                'allowed_methods' => [RequestMethodInterface::METHOD_GET],
+            ],
+        ],
+
+    ];
+})();

config/autoload/swoole.global.php

@@ -2,21 +2,33 @@
 
 declare(strict_types=1);
 
-return [
+use Shlinkio\Shlink\Core\Config\EnvVars;
 
-    'mezzio-swoole' => [
+use function Shlinkio\Shlink\Config\getOpenswooleConfigFromEnv;
-        // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
-        'enable_coroutine' => false,
 
-        'swoole-http-server' => [
+use const Shlinkio\Shlink\MIN_TASK_WORKERS;
-            'host' => '0.0.0.0',
-            'process-name' => 'shlink',
 
-            'options' => [
+return (static function (): array {
-                'worker_num' => 16,
+    $taskWorkers = (int) EnvVars::TASK_WORKER_NUM->loadFromEnv(16);
-                'task_worker_num' => 16,
+
+    return [
+
+        'mezzio-swoole' => [
+            // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
+            'enable_coroutine' => false,
+
+            'swoole-http-server' => [
+                'host' => '0.0.0.0',
+                'port' => (int) EnvVars::PORT->loadFromEnv(8080),
+                'process-name' => 'shlink',
+
+                'options' => [
+                    ...getOpenswooleConfigFromEnv(),
+                    'worker_num' => (int) EnvVars::WEB_WORKER_NUM->loadFromEnv(16),
+                    'task_worker_num' => max($taskWorkers, MIN_TASK_WORKERS),
+                ],
             ],
         ],
-    ],
 
-];
+    ];
+})();

config/autoload/tracking.global.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return (static function (): array {
+    /** @var string|null $disableTrackingFrom */
+    $disableTrackingFrom = EnvVars::DISABLE_TRACKING_FROM->loadFromEnv();
+
+    return [
+
+        'tracking' => [
+            // Tells if IP addresses should be anonymized before persisting, to fulfil data protection regulations
+            // This applies only if IP address tracking is enabled
+            'anonymize_remote_addr' => (bool) EnvVars::ANONYMIZE_REMOTE_ADDR->loadFromEnv(true),
+
+            // Tells if visits to not-found URLs should be tracked. The disable_tracking option takes precedence
+            'track_orphan_visits' => (bool) EnvVars::TRACK_ORPHAN_VISITS->loadFromEnv(true),
+
+            // A query param that, if provided, will disable tracking of one particular visit. Always takes precedence
+            'disable_track_param' => EnvVars::DISABLE_TRACK_PARAM->loadFromEnv(),
+
+            // If true, visits will not be tracked at all
+            'disable_tracking' => (bool) EnvVars::DISABLE_TRACKING->loadFromEnv(false),
+
+            // If true, visits will be tracked, but neither the IP address, nor the location will be resolved
+            'disable_ip_tracking' => (bool) EnvVars::DISABLE_IP_TRACKING->loadFromEnv(false),
+
+            // If true, the referrer will not be tracked
+            'disable_referrer_tracking' => (bool) EnvVars::DISABLE_REFERRER_TRACKING->loadFromEnv(false),
+
+            // If true, the user agent will not be tracked
+            'disable_ua_tracking' => (bool) EnvVars::DISABLE_UA_TRACKING->loadFromEnv(false),
+
+            // A list of IP addresses, patterns or CIDR blocks from which tracking is disabled by default
+            'disable_tracking_from' => $disableTrackingFrom === null
+                ? []
+                : array_map(trim(...), explode(',', $disableTrackingFrom)),
+        ],
+
+    ];
+})();

config/autoload/url-shortener.global.php

@@ -2,23 +2,34 @@
 
 declare(strict_types=1);
 
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
+use Shlinkio\Shlink\Core\Config\EnvVars;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlMode;
-use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
 
-return [
+use const Shlinkio\Shlink\DEFAULT_SHORT_CODES_LENGTH;
+use const Shlinkio\Shlink\MIN_SHORT_CODES_LENGTH;
 
-    'url_shortener' => [
+return (static function (): array {
-        'domain' => [
+    $shortCodesLength = max(
-            'schema' => 'https',
+        (int) EnvVars::DEFAULT_SHORT_CODES_LENGTH->loadFromEnv(DEFAULT_SHORT_CODES_LENGTH),
-            'hostname' => '',
+        MIN_SHORT_CODES_LENGTH,
+    );
+    $modeFromEnv = EnvVars::SHORT_URL_MODE->loadFromEnv(ShortUrlMode::STRICT->value);
+    $mode = ShortUrlMode::tryDeprecated($modeFromEnv) ?? ShortUrlMode::STRICT;
+
+    return [
+
+        'url_shortener' => [
+            'domain' => [ // TODO Refactor this structure to url_shortener.schema and url_shortener.default_domain
+                'schema' => ((bool) EnvVars::IS_HTTPS_ENABLED->loadFromEnv(true)) ? 'https' : 'http',
+                'hostname' => EnvVars::DEFAULT_DOMAIN->loadFromEnv(''),
+            ],
+            'default_short_codes_length' => $shortCodesLength,
+            'auto_resolve_titles' => (bool) EnvVars::AUTO_RESOLVE_TITLES->loadFromEnv(false),
+            'append_extra_path' => (bool) EnvVars::REDIRECT_APPEND_EXTRA_PATH->loadFromEnv(false),
+            'multi_segment_slugs_enabled' => (bool) EnvVars::MULTI_SEGMENT_SLUGS_ENABLED->loadFromEnv(false),
+            'trailing_slash_enabled' => (bool) EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(false),
+            'mode' => $mode,
         ],
-        'validate_url' => false,
-        'anonymize_remote_addr' => true,
-        'visits_webhooks' => [],
-        'default_short_codes_length' => DEFAULT_SHORT_CODES_LENGTH,
-        'redirect_status_code' => DEFAULT_REDIRECT_STATUS_CODE,
-        'redirect_cache_lifetime' => DEFAULT_REDIRECT_CACHE_LIFETIME,
-    ],
 
-];
+    ];
+})();

config/autoload/url-shortener.local.php.dist

@@ -2,13 +2,23 @@
 
 declare(strict_types=1);
 
+use function Shlinkio\Shlink\Config\runningInOpenswoole;
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
+
 return [
 
     'url_shortener' => [
         'domain' => [
             'schema' => 'http',
-            'hostname' => 'localhost:8080',
+            'hostname' => sprintf('localhost:%s', match (true) {
+                runningInRoadRunner() => '8800',
+                runningInOpenswoole() => '8080',
+                default => '8000',
+            }),
         ],
+        'auto_resolve_titles' => true,
+//        'multi_segment_slugs_enabled' => true,
+//        'trailing_slash_enabled' => true,
     ],
 
 ];

config/autoload/webhooks.global.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+// Deprecated. Webhooks are no longer supported. To be removed in Shlink 4.0.0
+return (static function (): array {
+    $webhooks = EnvVars::VISITS_WEBHOOKS->loadFromEnv();
+
+    return [
+
+        'visits_webhooks' => [
+            'webhooks' => $webhooks === null ? [] : explode(',', $webhooks),
+            'notify_orphan_visits_to_webhooks' =>
+                (bool) EnvVars::NOTIFY_ORPHAN_VISITS_TO_WEBHOOKS->loadFromEnv(false),
+        ],
+
+    ];
+})();

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

@@ -2,14 +2,26 @@
 
 declare(strict_types=1);
 
-use Doctrine\ORM\EntityManager;
+use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
-use Doctrine\ORM\Tools\Console\ConsoleRunner;
+use Doctrine\Migrations\Configuration\Migration\ConfigurationArray;
-use Psr\Container\ContainerInterface;
+use Doctrine\Migrations\DependencyFactory;
 
-return (function () {
+// This file is currently used by doctrine migrations only
-    /** @var ContainerInterface $container */
-    $container = include __DIR__ . '/container.php';
-    $em = $container->get(EntityManager::class);
 
-    return ConsoleRunner::createHelperSet($em);
+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

@@ -8,30 +8,53 @@ use Laminas\ConfigAggregator;
 use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
+use Mezzio\Swoole;
+use Shlinkio\Shlink\Config\ConfigAggregator\EnvVarLoaderProvider;
 
-use function Shlinkio\Shlink\Common\env;
+use function class_exists;
+use function Shlinkio\Shlink\Config\env;
+use function Shlinkio\Shlink\Config\openswooleIsInstalled;
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
+use function Shlinkio\Shlink\Core\enumValues;
 
-return (new ConfigAggregator\ConfigAggregator([
+use const PHP_SAPI;
-    Mezzio\ConfigProvider::class,
+
-    Mezzio\Router\ConfigProvider::class,
+$isTestEnv = env('APP_ENV') === 'test';
-    Mezzio\Router\FastRouteRouter\ConfigProvider::class,
+$enableSwoole = PHP_SAPI === 'cli' && openswooleIsInstalled() && ! runningInRoadRunner();
-    Mezzio\Swoole\ConfigProvider::class,
+
-    ProblemDetails\ConfigProvider::class,
+return (new ConfigAggregator\ConfigAggregator(
-    Diactoros\ConfigProvider::class,
+    providers: [
-    Common\ConfigProvider::class,
+        ! $isTestEnv
-    Config\ConfigProvider::class,
+            ? new EnvVarLoaderProvider('config/params/generated_config.php', enumValues(Core\Config\EnvVars::class))
-    Importer\ConfigProvider::class,
+            : new ConfigAggregator\ArrayProvider([]),
-    IpGeolocation\ConfigProvider::class,
+        Mezzio\ConfigProvider::class,
-    EventDispatcher\ConfigProvider::class,
+        Mezzio\Router\ConfigProvider::class,
-    Core\ConfigProvider::class,
+        Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-    CLI\ConfigProvider::class,
+        $enableSwoole && class_exists(Swoole\ConfigProvider::class)
-    Rest\ConfigProvider::class,
+            ? Swoole\ConfigProvider::class
-    new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
+            : new ConfigAggregator\ArrayProvider([]),
-    env('APP_ENV') === 'test'
+        ProblemDetails\ConfigProvider::class,
-        ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
+        Diactoros\ConfigProvider::class,
-        : new ConfigAggregator\LaminasConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
+        Common\ConfigProvider::class,
-], 'data/cache/app_config.php', [
+        Config\ConfigProvider::class,
-    Core\Config\SimplifiedConfigParser::class,
+        Importer\ConfigProvider::class,
-    Core\Config\BasePathPrefixer::class,
+        IpGeolocation\ConfigProvider::class,
-    Core\Config\DeprecatedConfigParser::class,
+        EventDispatcher\ConfigProvider::class,
-]))->getMergedConfig();
+        Core\ConfigProvider::class,
+        CLI\ConfigProvider::class,
+        Rest\ConfigProvider::class,
+        new ConfigAggregator\PhpFileProvider('config/autoload/{,*.}global.php'),
+        // Local config should not be loaded during tests, whereas test config should be loaded ONLY during tests
+        new ConfigAggregator\PhpFileProvider(
+            $isTestEnv ? 'config/test/*.global.php' : 'config/autoload/{,*.}local.php',
+        ),
+        // 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,24 @@
+<?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; // Deprecated. Default to 307 for Shlink v4
+const DEFAULT_REDIRECT_CACHE_LIFETIME = 30;
+const LOCAL_LOCK_FACTORY = 'Shlinkio\Shlink\LocalLockFactory';
+const TITLE_TAG_VALUE = '/<title[^>]*>(.*?)<\/title>/i'; // Matches the value inside a html title tag
+const LOOSE_URI_MATCHER = '/(.+)\:(.+)/i'; // Matches anything starting with a schema.
+const DEFAULT_QR_CODE_SIZE = 300;
+const DEFAULT_QR_CODE_MARGIN = 0;
+const DEFAULT_QR_CODE_FORMAT = 'png';
+const DEFAULT_QR_CODE_ERROR_CORRECTION = 'l';
+const DEFAULT_QR_CODE_ROUND_BLOCK_SIZE = true;
+// Deprecated. Shlink 4.0.0 should change default value to `true`
+const DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS = false;
+const MIN_TASK_WORKERS = 4;

config/container.php

@@ -3,22 +3,36 @@
 declare(strict_types=1);
 
 use Laminas\ServiceManager\ServiceManager;
+use Shlinkio\Shlink\Core\Config\EnvVars;
 use Symfony\Component\Lock;
 
-use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
+// Workaround to make this compatible with both openswoole 22 and earlier versions.
+// Openswoole support is deprecated. Remove in v4.0.0
+if (! function_exists('swoole_set_process_name')) {
+    // phpcs:disable
+    function swoole_set_process_name(string $name): void
+    {
+        OpenSwoole\Util::setProcessName($name);
+    }
+    // phpcs:enable
+}
+
+// This is one of the first files loaded. Configure the timezone here
+date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv(date_default_timezone_get()));
+
 // 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
+return (static function (): ServiceManager {
-return (function () {
     $config = require __DIR__ . '/config.php';
     $container = new ServiceManager($config['dependencies']);
     $container->setService('config', $config);

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/roadrunner/.rr.dev.yml

@@ -0,0 +1,42 @@
+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:
+  mode: development
+  channels:
+    http:
+      mode: 'off' # Disable logging as Shlink handles it internally
+    server:
+      level: info
+    metrics:
+      level: debug
+    jobs:
+      level: debug

config/roadrunner/.rr.yml

@@ -0,0 +1,38 @@
+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: '0.0.0.0:${PORT:-8080}'
+  middleware: ['static']
+  static:
+    dir: '../../public'
+    forbid: ['.php', '.htaccess']
+  pool:
+    num_workers: ${WEB_WORKER_NUM:-0}
+
+jobs:
+  timeout: 300 # 5 minutes
+  pool:
+    num_workers: ${TASK_WORKER_NUM:-0}
+  consume: ['shlink']
+  pipelines:
+    shlink:
+      driver: memory
+      config:
+        priority: 10
+        prefetch: 10
+
+logs:
+  mode: production
+  channels:
+    http:
+      mode: 'off' # Disable logging as Shlink handles it internally
+    server:
+      level: info
+    jobs:
+      level: debug

config/run.php

@@ -4,12 +4,11 @@ declare(strict_types=1);
 
 use Mezzio\Application;
 use Psr\Container\ContainerInterface;
-use Symfony\Component\Console\Application as CliApp;
 
-return function (bool $isCli = false): void {
+return static function (): void {
     /** @var ContainerInterface $container */
     $container = include __DIR__ . '/container.php';
-    $app = $container->get($isCli ? CliApp::class : Application::class);
+    $app = $container->get(Application::class);
 
     $app->run();
 };

config/test/bootstrap_api_tests.php

@@ -10,8 +10,8 @@ use Psr\Container\ContainerInterface;
 use function register_shutdown_function;
 use function sprintf;
 
-use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\API_TESTS_HOST;
-use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
+use const ShlinkioTest\Shlink\API_TESTS_PORT;
 
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
@@ -20,15 +20,19 @@ $config = $container->get('config');
 $em = $container->get(EntityManager::class);
 $httpClient = $container->get('shlink_test_api_client');
 
-// Start code coverage collecting on swoole process, and stop it when process shuts down
+// Dump code coverage when process shuts down
-$httpClient->request('GET', sprintf('http://%s:%s/api-tests/start-coverage', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT));
 register_shutdown_function(function () use ($httpClient): void {
     $httpClient->request(
         'GET',
-        sprintf('http://%s:%s/api-tests/stop-coverage', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT),
+        sprintf('http://%s:%s/api-tests/stop-coverage', API_TESTS_HOST, API_TESTS_PORT),
     );
 });
 
-$testHelper->createTestDb();
+$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

@@ -8,5 +8,10 @@ use Psr\Container\ContainerInterface;
 
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
-$container->get(Helper\TestHelper::class)->createTestDb();
+$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

@@ -4,5 +4,12 @@ declare(strict_types=1);
 
 namespace ShlinkioTest\Shlink;
 
-const SWOOLE_TESTING_HOST = '127.0.0.1';
+const API_TESTS_HOST = '127.0.0.1';
-const SWOOLE_TESTING_PORT = 9999;
+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 DESKTOP_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like '
+    . 'Gecko) Chrome/109.0.0.0 Safari/537.36 Edg/109.0.1518.61';

config/test/test_config.global.php

@@ -8,55 +8,83 @@ use GuzzleHttp\Client;
 use Laminas\ConfigAggregator\ConfigAggregator;
 use Laminas\Diactoros\Response\EmptyResponse;
 use Laminas\ServiceManager\Factory\InvokableFactory;
-use Laminas\Stdlib\Glob;
+use League\Event\EventDispatcher;
-use PDO;
+use Monolog\Level;
 use PHPUnit\Runner\Version;
+use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Driver\Selector;
 use SebastianBergmann\CodeCoverage\Filter;
+use SebastianBergmann\CodeCoverage\Report\Html\Facade as Html;
 use SebastianBergmann\CodeCoverage\Report\PHP;
 use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;
+use Shlinkio\Shlink\Common\Logger\LoggerType;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+use function file_exists;
 use function Laminas\Stratigility\middleware;
-use function Shlinkio\Shlink\Common\env;
+use function Shlinkio\Shlink\Config\env;
+use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 use function sprintf;
 use function sys_get_temp_dir;
 
-use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\API_TESTS_HOST;
-use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
+use const ShlinkioTest\Shlink\API_TESTS_PORT;
 
 $isApiTest = env('TEST_ENV') === 'api';
-if ($isApiTest) {
+$isCliTest = env('TEST_ENV') === 'cli';
+$isE2eTest = $isApiTest || $isCliTest;
+$coverageType = env('GENERATE_COVERAGE');
+$generateCoverage = contains($coverageType, ['yes', 'pretty']);
+
+$coverage = null;
+if ($isE2eTest && $generateCoverage) {
     $filter = new Filter();
-    foreach (Glob::glob(__DIR__ . '/../../module/*/src') as $item) {
+    $filter->includeDirectory(__DIR__ . '/../../module/Core/src');
-        $filter->includeDirectory($item);
+    $filter->includeDirectory(__DIR__ . '/../../module/' . ($isApiTest ? 'Rest' : 'CLI') . '/src');
-    }
     $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
 }
 
-$buildDbConnection = function (): array {
+/**
+ * @param 'api'|'cli' $type
+ */
+$exportCoverage = static function (string $type = 'api') use (&$coverage, $coverageType): void {
+    if ($coverage === null) {
+        return;
+    }
+
+    $basePath = __DIR__ . '/../../build/coverage-' . $type;
+    $covPath = $basePath . '.cov';
+
+    // Every CLI test runs on its own process and dumps the coverage afterwards.
+    // Try to load it and merge it, so that we end up with the whole coverage at the end.
+    if ($type === 'cli' && file_exists($covPath)) {
+        $coverage->merge(require $covPath);
+    }
+
+    if ($coverageType === 'pretty') {
+        (new Html())->process($coverage, $basePath . '/coverage-html');
+    } else {
+        (new PHP())->process($coverage, $covPath);
+        (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
+    }
+};
+
+$buildDbConnection = static function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
     $isCi = env('CI', false);
-    $getMysqlHost = fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
+    $getCiMysqlPort = static fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
-    $getCiMysqlPort = fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
 
-    $driverConfigMap = [
+    return match ($driver) {
         'sqlite' => [
             'driver' => 'pdo_sqlite',
-            'path' => sys_get_temp_dir() . '/shlink-tests.db',
+            'memory' => true,
-        ],
-        'mysql' => [
-            'driver' => 'pdo_mysql',
-            'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
-            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
-            'user' => 'root',
-            'password' => 'root',
-            'dbname' => 'shlink_test',
-            'charset' => 'utf8',
-            'driverOptions' => [
-                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-                PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
-            ],
         ],
         'postgres' => [
             'driver' => 'pdo_pgsql',
@@ -73,13 +101,29 @@ $buildDbConnection = function (): array {
             'user' => 'sa',
             'password' => 'Passw0rd!',
             'dbname' => 'shlink_test',
+            'driverOptions' => [
+                'TrustServerCertificate' => 'true',
+            ],
         ],
-    ];
+        default => [ // mysql and maria
-    $driverConfigMap['maria'] = $driverConfigMap['mysql'];
+            'driver' => 'pdo_mysql',
-
+            'host' => $isCi ? '127.0.0.1' : sprintf('shlink_db_%s', $driver),
-    return $driverConfigMap[$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,
@@ -88,19 +132,19 @@ return [
     'url_shortener' => [
         'domain' => [
             'schema' => 'http',
-            'hostname' => 'doma.in',
+            'hostname' => 's.test',
         ],
-        'validate_url' => true,
     ],
 
     'mezzio-swoole' => [
         'enable_coroutine' => false,
         'swoole-http-server' => [
-            'host' => SWOOLE_TESTING_HOST,
+            'host' => API_TESTS_HOST,
-            'port' => SWOOLE_TESTING_PORT,
+            'port' => API_TESTS_PORT,
             'process-name' => 'shlink_test',
             'options' => [
                 'pid_file' => sys_get_temp_dir() . '/shlink-test-swoole.pid',
+                'log_file' => __DIR__ . '/../../data/log/api-tests/output.log',
                 'enable_coroutine' => false,
             ],
         ],
@@ -108,30 +152,33 @@ return [
 
     'routes' => !$isApiTest ? [] : [
         [
-            'name' => 'start_collecting_coverage',
+            'name' => 'dump_coverage',
-            'path' => '/api-tests/start-coverage',
+            'path' => '/api-tests/stop-coverage',
-            'middleware' => middleware(static function () use (&$coverage) {
+            'middleware' => middleware(static function () use ($exportCoverage) {
-                if ($coverage) {
+                // TODO I have tried moving this block to a listener so that it's invoked automatically,
-                    $coverage->start('API tests');
+                //      but then the coverage is generated empty ¯\_(ツ)_/¯
-                }
+                $exportCoverage();
                 return new EmptyResponse();
             }),
             'allowed_methods' => ['GET'],
         ],
-        [
+    ],
-            'name' => 'dump_coverage',
-            'path' => '/api-tests/stop-coverage',
-            'middleware' => middleware(static function () use (&$coverage) {
-                if ($coverage) {
-                    $basePath = __DIR__ . '/../../build/coverage-api';
-                    $coverage->stop();
-                    (new PHP())->process($coverage, $basePath . '.cov');
-                    (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
-                }
 
-                return new EmptyResponse();
+    'middleware_pipeline' => !$isApiTest ? [] : [
+        'capture_code_coverage' => [
+            'middleware' => middleware(static function (
+                ServerRequestInterface $req,
+                RequestHandlerInterface $handler,
+            ) use (&$coverage): ResponseInterface {
+                $coverage?->start($req->getHeaderLine('x-coverage-id'));
+
+                try {
+                    return $handler->handle($req);
+                } finally {
+                    $coverage?->stop();
+                }
             }),
-            'allowed_methods' => ['GET'],
+            'priority' => 9999,
         ],
     ],
 
@@ -144,13 +191,69 @@ return [
     'dependencies' => [
         'services' => [
             'shlink_test_api_client' => new Client([
-                'base_uri' => sprintf('http://%s:%s/', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT),
+                '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 => [
+                static function (
+                    ContainerInterface $c,
+                    string $serviceName,
+                    callable $callback,
+                ) use (
+                    &$coverage,
+                    $exportCoverage,
+                ) {
+                    /** @var Application $app */
+                    $app = $callback();
+                    $wrappedEventDispatcher = new EventDispatcher();
+
+                    // When the command starts, start collecting coverage
+                    $wrappedEventDispatcher->subscribeTo(
+                        ConsoleCommandEvent::class,
+                        static function () use (&$coverage): void {
+                            $id = env('COVERAGE_ID');
+                            if ($id === null) {
+                                return;
+                            }
+
+                            $coverage?->start($id);
+                        },
+                    );
+                    // When the command ends, stop collecting coverage
+                    $wrappedEventDispatcher->subscribeTo(
+                        ConsoleTerminateEvent::class,
+                        static function () use (&$coverage, $exportCoverage): void {
+                            $id = env('COVERAGE_ID');
+                            if ($id === null) {
+                                return;
+                            }
+
+                            $coverage?->stop();
+                            $exportCoverage('cli');
+                        },
+                    );
+
+                    $app->setDispatcher(new class ($wrappedEventDispatcher) implements EventDispatcherInterface {
+                        public function __construct(private EventDispatcher $wrappedDispatcher)
+                        {
+                        }
+
+                        public function dispatch(object $event, ?string $eventName = null): object
+                        {
+                            $this->wrappedDispatcher->dispatch($event);
+                            return $event;
+                        }
+                    });
+
+                    return $app;
+                },
+            ],
+        ] : [],
     ],
 
     'entity_manager' => [
@@ -159,8 +262,14 @@ return [
 
     'data_fixtures' => [
         'paths' => [
+            // TODO These are used for CLI tests too, 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

@@ -3,7 +3,7 @@
 set -ex
 
 curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
-curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
 apt-get update
-ACCEPT_EULA=Y apt-get install msodbcsql17
+ACCEPT_EULA=Y apt-get install msodbcsql18
-apt-get install unixodbc-dev
+# apt-get install unixodbc-dev

data/infra/examples/apache-vhost.conf

@@ -1,5 +1,5 @@
 <VirtualHost *:80>
-    ServerName doma.in
+    ServerName s.test
     DocumentRoot "/path/to/shlink/public"
 
     <Directory "/path/to/shlink/public">

data/infra/examples/nginx-vhost.conf

@@ -1,5 +1,5 @@
 server {
-    server_name doma.in;
+    server_name s.test;
     listen 80;
     root /path/to/shlink/public;
     index index.php;
@@ -11,7 +11,7 @@ server {
 
     location ~ \.php$ {
         fastcgi_split_path_info ^(.+\.php)(/.+)$;
-        fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
+        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
         fastcgi_index index.php;
         include fastcgi.conf;
     }

data/infra/examples/shlink-daemon-logrotate.conf

@@ -1,4 +1,4 @@
-/var/log/shlink/shlink_swoole.log {
+/var/log/shlink/shlink_openswoole.log {
     su root root
     daily
     missingok
@@ -8,6 +8,6 @@
     notifempty
     create 0640 root root
     postrotate
-        /etc/init.d/shlink_swoole restart
+        /etc/init.d/shlink_openswoole restart
     endscript
 }

data/infra/examples/shlink-daemon.sh

@@ -1,26 +1,26 @@
 #!/bin/bash
 ### BEGIN INIT INFO
-# Provides:          shlink_swoole
+# Provides:          shlink_openswoole
 # Required-Start:    $local_fs $network $named $time $syslog
 # Required-Stop:     $local_fs $network $named $time $syslog
 # Default-Start:     2 3 4 5
 # Default-Stop:      0 1 6
-# Description:       Shlink non-blocking server with swoole
+# Description:       Shlink non-blocking server with openswoole
 ### END INIT INFO
 
-SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
+SCRIPT=/path/to/shlink/vendor/bin/laminas\ mezzio:swoole:start
 RUNAS=root
 
-PIDFILE=/var/run/shlink_swoole.pid
+PIDFILE=/var/run/shlink_openswoole.pid
 LOGDIR=/var/log/shlink
-LOGFILE=${LOGDIR}/shlink_swoole.log
+LOGFILE=${LOGDIR}/shlink_openswoole.log
 
 start() {
   if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
-    echo 'Shlink with swoole already running' >&2
+    echo 'Shlink with openswoole already running' >&2
     return 1
   fi
-  echo 'Starting shlink with swoole' >&2
+  echo 'Starting shlink with openswoole' >&2
   mkdir -p "$LOGDIR"
   touch "$LOGFILE"
   local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
@@ -30,10 +30,10 @@ start() {
 
 stop() {
   if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
-    echo 'Shlink with swoole not running' >&2
+    echo 'Shlink with openswoole not running' >&2
     return 1
   fi
-  echo 'Stopping shlink with swoole' >&2
+  echo 'Stopping shlink with openswoole' >&2
   kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
   echo 'Shlink stopped' >&2
 }

data/infra/php.Dockerfile

@@ -1,14 +1,15 @@
-FROM php:7.4.11-fpm-alpine3.12
+FROM php:8.2-fpm-alpine3.17
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.18
+ENV APCU_VERSION 5.1.21
-ENV APCU_BC_VERSION 1.0.5
+ENV PDO_SQLSRV_VERSION 5.11.1
+ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
+ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
 
 RUN apk update
 
 # Install common php extensions
 RUN docker-php-ext-install pdo_mysql
-RUN docker-php-ext-install iconv
 RUN docker-php-ext-install calendar
 
 RUN apk add --no-cache oniguruma-dev
@@ -30,41 +31,29 @@ 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 gmp-dev
+RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
-RUN docker-php-ext-install gmp
+    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\
+RUN mkdir -p /usr/src/php/ext/apcu \
-  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
-# configure and install
+  && docker-php-ext-configure apcu \
-RUN docker-php-ext-configure apcu\
+  && docker-php-ext-install apcu \
-  && docker-php-ext-install apcu
+  && rm /tmp/apcu.tar.gz \
-# cleanup
+  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
-RUN rm /tmp/apcu.tar.gz
+  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
-
-# Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
-RUN mkdir -p /usr/src/php/ext/apcu-bc\
-  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu-bc\
-  && docker-php-ext-install apcu-bc
-# cleanup
-RUN rm /tmp/apcu_bc.tar.gz
-
-# Load APCU.ini before APC.ini
-RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
-RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install pcov and sqlsrv driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+RUN wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_17.5.1.1-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 pcov && \
+    pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
     docker-php-ext-enable pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer

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,76 @@
+FROM php:8.2-alpine3.17
+MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
+
+ENV APCU_VERSION 5.1.21
+ENV PDO_SQLSRV_VERSION 5.11.1
+ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
+ENV MS_ODBC_SQL_VERSION 18_18.1.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 pcov and sqlsrv driver
+RUN 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} pcov && \
+    docker-php-ext-enable pdo_sqlsrv pcov && \
+    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 && \
+    # This forces the app to be started every second until the exit code is 0
+    until ./bin/rr serve -c config/roadrunner/.rr.dev.yml; do sleep 1 ; done

data/infra/swoole.Dockerfile

@@ -1,16 +1,17 @@
-FROM php:7.4.11-alpine3.12
+FROM php:8.2-alpine3.17
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.18
+ENV APCU_VERSION 5.1.21
-ENV APCU_BC_VERSION 1.0.5
+ENV INOTIFY_VERSION 3.0.0
-ENV INOTIFY_VERSION 2.0.0
+ENV OPENSWOOLE_VERSION 22.1.0
-ENV SWOOLE_VERSION 4.5.9
+ENV PDO_SQLSRV_VERSION 5.11.1
+ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
+ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
 
 RUN apk update
 
 # Install common php extensions
 RUN docker-php-ext-install pdo_mysql
-RUN docker-php-ext-install iconv
 RUN docker-php-ext-install calendar
 
 RUN apk add --no-cache oniguruma-dev
@@ -32,51 +33,37 @@ 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 gmp-dev
+RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
-RUN docker-php-ext-install gmp
+    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\
+RUN mkdir -p /usr/src/php/ext/apcu \
-  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
-# configure and install
+  && docker-php-ext-configure apcu \
-RUN docker-php-ext-configure apcu\
+  && docker-php-ext-install apcu \
-  && docker-php-ext-install apcu
+  && rm /tmp/apcu.tar.gz \
-# cleanup
+  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
-RUN rm /tmp/apcu.tar.gz
+  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
-
-# Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
-RUN mkdir -p /usr/src/php/ext/apcu-bc\
-  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu-bc\
-  && docker-php-ext-install apcu-bc
-# cleanup
-RUN rm /tmp/apcu_bc.tar.gz
-
-# Load APCU.ini before APC.ini
-RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
-RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install inotify extension
 ADD https://pecl.php.net/get/inotify-$INOTIFY_VERSION.tgz /tmp/inotify.tar.gz
-RUN mkdir -p /usr/src/php/ext/inotify\
+RUN mkdir -p /usr/src/php/ext/inotify \
-  && tar xf /tmp/inotify.tar.gz -C /usr/src/php/ext/inotify --strip-components=1
+  && tar xf /tmp/inotify.tar.gz -C /usr/src/php/ext/inotify --strip-components=1 \
-# configure and install
+  && docker-php-ext-configure inotify \
-RUN docker-php-ext-configure inotify\
+  && docker-php-ext-install inotify \
-  && docker-php-ext-install inotify
+  && rm /tmp/inotify.tar.gz
-# cleanup
-RUN rm /tmp/inotify.tar.gz
 
-# Install swoole, pcov and mssql driver
+# Install openswoole, pcov and mssql driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+RUN wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_17.5.1.1-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 swoole-${SWOOLE_VERSION} pdo_sqlsrv pcov && \
+    pecl install openswoole-${OPENSWOOLE_VERSION} pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
-    docker-php-ext-enable swoole pdo_sqlsrv pcov && \
+    docker-php-ext-enable openswoole pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
@@ -87,12 +74,12 @@ RUN chmod 777 /home
 VOLUME /home/shlink
 WORKDIR /home/shlink
 
-# Expose swoole port
+# Expose openswoole port
 EXPOSE 8080
 
 CMD \
     # Install dependencies if the vendor dir does not exist
     if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
-    # When restarting the container, swoole might think it is already in execution
+    # When restarting the container, openswoole might think it is already in execution
     # This forces the app to be started every second until the exit code is 0
-    until php ./vendor/bin/mezzio-swoole start; do sleep 1 ; done
+    until php ./vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done

data/migrations/Version20160819142757.php

@@ -1,44 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkMigrations;
-
-use Doctrine\DBAL\DBALException;
-use Doctrine\DBAL\Schema\Schema;
-use Doctrine\DBAL\Schema\SchemaException;
-use Doctrine\Migrations\AbstractMigration;
-
-/**
- * Auto-generated Migration: Please modify to your needs!
- */
-class Version20160819142757 extends AbstractMigration
-{
-    private const MYSQL = 'mysql';
-    private const SQLITE = 'sqlite';
-
-    /**
-     * @throws DBALException
-     * @throws SchemaException
-     */
-    public function up(Schema $schema): void
-    {
-        $db = $this->connection->getDatabasePlatform()->getName();
-        $table = $schema->getTable('short_urls');
-        $column = $table->getColumn('short_code');
-
-        if ($db === self::MYSQL) {
-            $column->setPlatformOption('collation', 'utf8_bin');
-        } elseif ($db === self::SQLITE) {
-            $column->setPlatformOption('collate', 'BINARY');
-        }
-    }
-
-    /**
-     * @throws DBALException
-     */
-    public function down(Schema $schema): void
-    {
-        $db = $this->connection->getDatabasePlatform()->getName();
-    }
-}

data/migrations_template.txt

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace <namespace>;
 
+use Doctrine\DBAL\Platforms\MySQLPlatform;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 
@@ -18,4 +19,9 @@ final class <className> extends AbstractMigration
     {
 <down>
     }
+
+    public function isTransactional(): bool
+    {
+        return ! ($this->connection->getDatabasePlatform() instanceof MySQLPlatform);
+    }
 }

docker-compose.ci.yml

@@ -1,7 +1,7 @@
 version: '3'
 
 services:
-    shlink_db:
+    shlink_db_mysql:
         environment:
             MYSQL_DATABASE: shlink_test
 

docker-compose.override.yml.dist

@@ -13,7 +13,13 @@ services:
             - /etc/passwd:/etc/passwd:ro
             - /etc/group:/etc/group:ro
 
-    shlink_db:
+    shlink_roadrunner:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db_mysql:
         user: 1000:1000
         volumes:
             - /etc/passwd:/etc/passwd:ro

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.17.10-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8000:80"
         volumes:
@@ -18,23 +18,30 @@ services:
         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
+            - 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_swoole_proxy:
         container_name: shlink_swoole_proxy
-        image: nginx:1.17.10-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8002:80"
         volumes:
@@ -55,19 +62,50 @@ services:
             - ./:/home/shlink
             - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
-            - shlink_db
+            - 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:
+    shlink_roadrunner:
-        container_name: shlink_db
+        container_name: shlink_roadrunner
-        image: mysql:5.7
+        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
+        image: mysql:8.0
         ports:
             - "3307:3306"
         volumes:
@@ -92,7 +130,7 @@ services:
 
     shlink_db_maria:
         container_name: shlink_db_maria
-        image: mariadb:10.5
+        image: mariadb:10.7
         ports:
             - "3308:3306"
         volumes:
@@ -114,13 +152,22 @@ services:
 
     shlink_redis:
         container_name: shlink_redis
-        image: redis:6.0-alpine
+        image: redis:6.2-alpine
         ports:
             - "6380:6379"
 
+    shlink_redis_acl:
+        container_name: shlink_redis_acl
+        image: redis:6.2-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.17.10-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8001:80"
         volumes:
@@ -131,10 +178,47 @@ services:
 
     shlink_mercure:
         container_name: shlink_mercure
-        image: dunglas/mercure:v0.10
+        image: dunglas/mercure:v0.15
         ports:
             - "3080:80"
         environment:
-            CORS_ALLOWED_ORIGINS: "*"
+            SERVER_NAME: ":80"
-            JWT_KEY: "mercure_jwt_key"
+            MERCURE_PUBLISHER_JWT_KEY: mercure_jwt_key_long_enough_to_avoid_error
-            USE_FORWARDED_HEADERS: "1"
+            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"
+
+    shlink_rabbitmq:
+        container_name: shlink_rabbitmq
+        image: rabbitmq:3.11-management-alpine
+        ports:
+            - "15672:15672"
+            - "5672:5672"
+        environment:
+            RABBITMQ_DEFAULT_USER: "rabbit"
+            RABBITMQ_DEFAULT_PASS: "rabbit"
+
+    shlink_swagger_ui:
+        container_name: shlink_swagger_ui
+        image: swaggerapi/swagger-ui:v5.10.3
+        ports:
+            - "8005:8080"
+        volumes:
+            - ./docs/swagger:/app
+
+    shlink_matomo:
+        container_name: shlink_matomo
+        image: matomo:4.15-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

@@ -1,304 +1,34 @@
 # Shlink Docker image
 
-[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
+[![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 [swoole](https://www.swoole.co.uk/), which persists data in a local [sqlite](https://www.sqlite.org/index.html) database.
+It exposes a shlink instance served with [RoadRunner](https://roadrunner.dev) or [openswoole](https://openswoole.com/), which can be linked to external databases to persist data.
 
 ## Usage
 
-Shlink docker image exposes port `8080` in order to interact with its HTTP interface.
+The most basic way to run Shlink's docker image is by providing these mandatory env vars.
 
-It also expects these two env vars to be provided, in order to properly generate short URLs at runtime.
+* `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.
 
-* `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
+To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
-* `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
-
-So based on this, to run shlink on a local docker service, you should run a command like this:
-
-```bash
-docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 shlinkio/shlink:stable
-```
-
-### Interact with shlink's CLI on a running container.
-
-Once the shlink container is running, you can interact with the CLI tool by running `shlink` with any of the supported commands.
-
-For example, if the container is called `shlink_container`, you can generate a new API key with:
-
-```bash
-docker exec -it shlink_container shlink api-key:generate
-```
-
-Or you can list all tags with:
-
-```bash
-docker exec -it shlink_container shlink tag:list
-```
-
-Or locate remaining visits with:
-
-```bash
-docker exec -it shlink_container shlink visit:locate
-```
-
-All shlink commands will work the same way.
-
-You can also list all available commands just by running this:
-
-```bash
-docker exec -it shlink_container shlink
-```
-
-## Use an external DB
-
-The image comes with a working sqlite database, but in production, it's strongly recommended using a distributed database.
-
-It is possible to use a set of env vars to make this shlink instance interact with an external MySQL, MariaDB, PostgreSQL or Microsoft SQL Server database.
-
-* `DB_DRIVER`: **[Mandatory]**. Use the value **mysql**, **maria**, **postgres** or **mssql** to prevent the sqlite database to be used.
-* `DB_NAME`: [Optional]. The database name to be used. Defaults to **shlink**.
-* `DB_USER`: **[Mandatory]**. The username credential for the database server.
-* `DB_PASSWORD`: **[Mandatory]**. The password credential for the database server.
-* `DB_HOST`: **[Mandatory]**. The host name of the server running the database engine.
-* `DB_PORT`: [Optional]. The port in which the database service is running.
-    * Default value is based on the value provided for `DB_DRIVER`:
-        * **mysql** or **maria** -> `3306`
-        * **postgres** -> `5432`
-        * **mssql** -> `1433`
-
-> PostgreSQL is supported since v1.16.1 and Microsoft SQL server since v2.1.0. Do not try to use them with previous versions.
-
-Taking this into account, you could run shlink on a local docker service like this:
 
 ```bash
 docker run \
     --name shlink \
     -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
+    -e DEFAULT_DOMAIN=s.test \
-    -e SHORT_DOMAIN_SCHEMA=https \
+    -e IS_HTTPS_ENABLED=true \
-    -e DB_DRIVER=mysql \
-    -e DB_USER=root \
-    -e DB_PASSWORD=123abc \
-    -e DB_HOST=something.rds.amazonaws.com \
-    shlinkio/shlink:stable
-```
-
-You could even link to a local database running on a different container:
-
-```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    [...] \
-    -e DB_HOST=some_mysql_container \
-    --link some_mysql_container \
-    shlinkio/shlink:stable
-```
-
-> If you have considered using SQLite but sharing the database file with a volume, read [this issue](https://github.com/shlinkio/shlink-docker-image/issues/40) first.
-
-## Other integrations
-
-### Use an external redis server
-
-If you plan to run more than one Shlink instance, there are some resources that should be shared ([Multi instance considerations](#multi-instance-considerations)).
-
-One of those resources are the locks Shlink generates to prevent some operations to be run more than once in parallel (in the future, these redis servers could be used for other caching operations).
-
-In order to share those locks, you should use an external redis server (or a cluster of redis servers), by providing the `REDIS_SERVERS` env var.
-
-It can be either one server name or a comma-separated list of servers.
-
-> If more than one redis server is provided, Shlink will expect them to be configured as a [redis cluster](https://redis.io/topics/cluster-tutorial).
-
-### Integrate with a mercure hub server
-
-One way to get real time updates when certain events happen in Shlink is by integrating it with a [mercure hub](https://mercure.rocks/) server.
-
-If you do that, Shlink will publish updates and other clients can subscribe to those.
-
-There are three env vars you need to provide if you want to enable this:
-
-* `MERCURE_PUBLIC_HUB_URL`: **[Mandatory]**. The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: **[Optional]**. An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided, the `MERCURE_PUBLIC_HUB_URL` one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: **[Mandatory]**. The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
-
-So in order to run shlink with mercure integration, you would do it like this:
-
-```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com"
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local"
-    -e MERCURE_JWT_SECRET=super_secret_key
-    shlinkio/shlink:stable
-```
-
-## All supported env vars
-
-A few env vars have been already used in previous examples, but this image supports others that can be used to customize its behavior.
-
-This is the complete list of supported env vars:
-
-* `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
-* `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
-* `DB_DRIVER`: **sqlite** (which is the default value), **mysql**, **maria**, **postgres** or **mssql**.
-* `DB_NAME`: The database name to be used when using an external database driver. Defaults to **shlink**.
-* `DB_USER`: The username credential to be used when using an external database driver.
-* `DB_PASSWORD`: The password credential to be used when using an external database driver.
-* `DB_HOST`: The host name of the database server  when using an external database driver.
-* `DB_PORT`: The port in which the database service is running when using an external database driver.
-    * Default value is based on the value provided for `DB_DRIVER`:
-        * **mysql** or **maria** -> `3306`
-        * **postgres** -> `5432`
-        * **mssql** -> `1433`
-* `DB_UNIX_SOCKET`: Alternatively to the `DB_HOST`, you can provide this to connect through unix sockets when using `mysql`, `maria` or `postgres` drivers.
-* `DISABLE_TRACK_PARAM`: The name of a query param that can be used to visit short URLs avoiding the visit to be tracked. This feature won't be available if not value is provided.
-* `DELETE_SHORT_URL_THRESHOLD`: The amount of visits on short URLs which will not allow them to be deleted. Defaults to `15`.
-* `VALIDATE_URLS`: Boolean which tells if shlink should validate a status 20x is returned (after following redirects) when trying to shorten a URL. Defaults to `false`.
-* `INVALID_SHORT_URL_REDIRECT_TO`: If a URL is provided here, when a user tries to access an invalid short URL, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `REGULAR_404_REDIRECT_TO`: If a URL is provided here, when a user tries to access a URL not matching any one supported by the router, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `BASE_URL_REDIRECT_TO`: If a URL is provided here, when a user tries to access Shlink's base URL, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `BASE_PATH`: The base path from which you plan to serve shlink, in case you don't want to serve it from the root of the domain. Defaults to `''`.
-* `WEB_WORKER_NUM`: The amount of concurrent http requests this shlink instance will be able to server. Defaults to 16.
-* `TASK_WORKER_NUM`: The amount of concurrent background tasks this shlink instance will be able to execute. Defaults to 16.
-* `VISITS_WEBHOOKS`: A comma-separated list of URLs that will receive a `POST` request when a short URL receives a visit.
-* `DEFAULT_SHORT_CODES_LENGTH`: The length you want generated short codes to have. It defaults to 5 and has to be at least 4, so any value smaller than that will fall back to 4.
-* `GEOLITE_LICENSE_KEY`: The license key used to download new GeoLite2 database files. This is not mandatory, as a default license key is provided, but it is **strongly recommended** that you provide your own. Go to [https://shlink.io/documentation/geolite-license-key](https://shlink.io/documentation/geolite-license-key) to know how to generate it.
-* `REDIS_SERVERS`: A comma-separated list of redis servers where Shlink locks are stored (locks are used to prevent some operations to be run more than once in parallel).
-* `MERCURE_PUBLIC_HUB_URL`: The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided but `MERCURE_PUBLIC_HUB_URL` was, the former one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
-* `ANONYMIZE_REMOTE_ADDR`: Tells if IP addresses from visitors should be obfuscated before storing them in the database. Default value is `true`. **Careful!** Setting this to `false` will make your Shlink instance no longer be in compliance with the GDPR and other similar data protection regulations. 
-* `REDIRECT_STATUS_CODE`: Either **301** or **302**. Used to determine if redirects from short to long URLs should be done with a 301 or 302 status. Defaults to 302.
-* `REDIRECT_CACHE_LIFETIME`: Allows to set the amount of seconds that redirects should be cached when redirect status is 301. Default values is 30. 
-* `PORT`: Can be used to set the port in which shlink listens. Defaults to 8080 (Some cloud providers, like Google cloud or Heroku, expect to be able to customize exposed port by providing this env var). 
-
-An example using all env vars could look like this:
-
-```bash
-docker run \
-    --name shlink \
-    -p 8080:8888 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
-    -e PORT=8888 \
-    -e DB_DRIVER=mysql \
-    -e DB_NAME=shlink \
-    -e DB_USER=root \
-    -e DB_PASSWORD=123abc \
-    -e DB_HOST=something.rds.amazonaws.com \
-    -e DB_PORT=3306 \
-    -e DISABLE_TRACK_PARAM="no-track" \
-    -e DELETE_SHORT_URL_THRESHOLD=30 \
-    -e VALIDATE_URLS=true \
-    -e "INVALID_SHORT_URL_REDIRECT_TO=https://my-landing-page.com" \
-    -e "REGULAR_404_REDIRECT_TO=https://my-landing-page.com" \
-    -e "BASE_URL_REDIRECT_TO=https://my-landing-page.com" \
-    -e "REDIS_SERVERS=tcp://172.20.0.1:6379,tcp://172.20.0.2:6379" \
-    -e "BASE_PATH=/my-campaign" \
-    -e WEB_WORKER_NUM=64 \
-    -e TASK_WORKER_NUM=32 \
-    -e "VISITS_WEBHOOKS=http://my-api.com/api/v2.3/notify,https://third-party.io/foo" \
-    -e DEFAULT_SHORT_CODES_LENGTH=6 \
     -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com" \
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local" \
-    -e MERCURE_JWT_SECRET=super_secret_key \
-    -e ANONYMIZE_REMOTE_ADDR=false \
-    -e REDIRECT_STATUS_CODE=301 \
-    -e REDIRECT_CACHE_LIFETIME=90 \
     shlinkio/shlink:stable
 ```
 
-## [DEPRECATED] Provide config via volumes
+## Full documentation
 
-> As of v2.5.0, providing config through volumes is deprecated, and no new options will be added anymore. Use env vars instead.
+All the features supported by Shlink are also supported by the docker image.
->
-> Support for config options through volumes will be removed in Shlink v3.0.0
 
-Rather than providing custom configuration via env vars, it is also possible ot provide config files in json format.
+If you want to learn more, visit the [full documentation](https://shlink.io/documentation/install-docker-image/).
-
-Mounting a volume at `config/params` you will make shlink load all the files on it with the `.config.json` suffix.
-
-The whole configuration should have this format, but it can be split into multiple files that will be merged:
-
-```json
-{
-    "disable_track_param": "my_param",
-    "delete_short_url_threshold": 30,
-    "short_domain_schema": "https",
-    "short_domain_host": "doma.in",
-    "validate_url": true,
-    "invalid_short_url_redirect_to": "https://my-landing-page.com",
-    "regular_404_redirect_to": "https://my-landing-page.com",
-    "base_url_redirect_to": "https://my-landing-page.com",
-    "base_path": "/my-campaign",
-    "web_worker_num": 64,
-    "task_worker_num": 32,
-    "default_short_codes_length": 6,
-    "redis_servers": [
-        "tcp://172.20.0.1:6379",
-        "tcp://172.20.0.2:6379"
-    ],
-    "visits_webhooks": [
-        "http://my-api.com/api/v2.3/notify",
-        "https://third-party.io/foo"
-    ],
-    "db_config": {
-        "driver": "pdo_mysql",
-        "dbname": "shlink",
-        "user": "root",
-        "password": "123abc",
-        "host": "something.rds.amazonaws.com",
-        "port": "3306"
-    },
-    "geolite_license_key": "kjh23ljkbndskj345",
-    "mercure_public_hub_url": "https://example.com",
-    "mercure_internal_hub_url": "http://my-mercure-hub.prod.svc.cluster.local",
-    "mercure_jwt_secret": "super_secret_key",
-    "anonymize_remote_addr": false,
-    "redirect_status_code": 301,
-    "redirect_cache_lifetime": 90,
-    "port": 8888
-}
-```
-
-> This is internally parsed to how shlink expects the config. If you are using a version previous to 1.17.0, this parser is not present and you need to provide a config structure like the one [documented previously](https://github.com/shlinkio/shlink-docker-image/tree/v1.16.3#provide-config-via-volumes).
-
-Once created just run shlink with the volume:
-
-```bash
-docker run --name shlink -p 8080:8080 -v ${PWD}/my/config/dir:/etc/shlink/config/params shlinkio/shlink:stable
-```
-
-## Multi-architecture
-
-Starting on v2.3.0, Shlink's docker image is built for multiple architectures.
-
-The only limitation is that images for architectures other than `amd64` will not have support for Microsoft SQL databases, since there are no official binaries.
-
-## Multi-instance considerations
-
-These are some considerations to take into account when running multiple instances of shlink.
-
-* Some operations performed by Shlink should never be run more than once at the same time (like creating the database for the first time, or downloading the GeoLite2 database). For this reason, Shlink uses a locking system.
-
-    However, these locks are locally scoped to each Shlink instance by default.
-
-    You can (and should) make the locks to be shared by all Shlink instances by using a redis server/cluster. Just define the `REDIS_SERVERS` env var with the list of servers.
-
-## Versions
-
-Versioning on this docker image works as follows:
-
-* `X.X.X`:  when providing a specific version number, the image version will match the shlink version it contains. For example, installing `shlinkio/shlink:1.15.0`, you will get an image containing shlink v1.15.0.
-* `stable`: always holds the latest stable tag. For example, if latest shlink version is 2.0.0, installing `shlinkio/shlink:stable`, you will get an image containing shlink v2.0.0
-* `latest`: always holds the latest contents, and it's considered unstable and not suitable for production.
-
-> **Important**: The docker image was introduced with shlink v1.15.0, so there are no official images previous to that versions.

docker/build

@@ -1,25 +0,0 @@
-#!/bin/bash
-
-set -ex
-
-PLATFORMS="linux/arm/v7,linux/arm64/v8,linux/amd64"
-DOCKER_IMAGE="shlinkio/shlink"
-
-# If ref is not develop, then this is a tag. Build that docker tag and also "stable"
-if [[ "$GITHUB_REF" != *"develop"* ]]; then
-  VERSION=${GITHUB_REF#refs/tags/v}
-  TAGS="-t ${DOCKER_IMAGE}:${VERSION}"
-  # Push stable tag only if this is not an alpha or beta tag
-  [[ $GITHUB_REF != *"alpha"* && $GITHUB_REF != *"beta"* ]] && TAGS="${TAGS} -t ${DOCKER_IMAGE}:stable"
-
-  docker buildx build --push \
-    --build-arg SHLINK_VERSION=${VERSION} \
-    --platform ${PLATFORMS} \
-    ${TAGS} .
-
-# If build branch is develop, build latest
-elif [[ "$GITHUB_REF" == *"develop"* ]]; then
-  docker buildx build --push \
-    --platform ${PLATFORMS} \
-    -t ${DOCKER_IMAGE}:latest .
-fi

docker/config/php.ini

@@ -1,3 +1,4 @@
 log_errors_max_len=0
 zend.assertions=1
 assert.exception=1
+memory_limit=512M

docker/config/shlink_in_docker.local.php

@@ -4,173 +4,15 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Monolog\Handler\StreamHandler;
+use Shlinkio\Shlink\Common\Logger\LoggerType;
-use Monolog\Logger;
-
-use function explode;
-use function Functional\contains;
-use function Shlinkio\Shlink\Common\env;
-
-use const Shlinkio\Shlink\Core\DEFAULT_DELETE_SHORT_URL_THRESHOLD;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
-use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
-use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
-use const Shlinkio\Shlink\Core\MIN_SHORT_CODES_LENGTH;
-
-$helper = new class {
-    private const DB_DRIVERS_MAP = [
-        'mysql' => 'pdo_mysql',
-        'maria' => 'pdo_mysql',
-        'postgres' => 'pdo_pgsql',
-        'mssql' => 'pdo_sqlsrv',
-    ];
-    private const DB_PORTS_MAP = [
-        'mysql' => '3306',
-        'maria' => '3306',
-        'postgres' => '5432',
-        'mssql' => '1433',
-    ];
-
-    public function getDbConfig(): array
-    {
-        $driver = env('DB_DRIVER');
-        $isMysql = contains(['maria', 'mysql'], $driver);
-        if ($driver === null || $driver === 'sqlite') {
-            return [
-                'driver' => 'pdo_sqlite',
-                'path' => 'data/database.sqlite',
-            ];
-        }
-
-        $driverOptions = ! $isMysql ? [] : [
-            // 1002 -> PDO::MYSQL_ATTR_INIT_COMMAND
-            1002 => 'SET NAMES utf8',
-            // 1000 -> PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
-            1000 => true,
-        ];
-        return [
-            'driver' => self::DB_DRIVERS_MAP[$driver],
-            'dbname' => env('DB_NAME', 'shlink'),
-            'user' => env('DB_USER'),
-            'password' => env('DB_PASSWORD'),
-            'host' => env('DB_HOST', $driver === 'postgres' ? env('DB_UNIX_SOCKET') : null),
-            'port' => env('DB_PORT', self::DB_PORTS_MAP[$driver]),
-            'driverOptions' => $driverOptions,
-            'unix_socket' => $isMysql ? env('DB_UNIX_SOCKET') : null,
-        ];
-    }
-
-    public function getNotFoundRedirectsConfig(): array
-    {
-        return [
-            'invalid_short_url' => env('INVALID_SHORT_URL_REDIRECT_TO'),
-            'regular_404' => env('REGULAR_404_REDIRECT_TO'),
-            'base_url' => env('BASE_URL_REDIRECT_TO'),
-        ];
-    }
-
-    public function getVisitsWebhooks(): array
-    {
-        $webhooks = env('VISITS_WEBHOOKS');
-        return $webhooks === null ? [] : explode(',', $webhooks);
-    }
-
-    public function getRedisConfig(): ?array
-    {
-        $redisServers = env('REDIS_SERVERS');
-        return $redisServers === null ? null : ['servers' => $redisServers];
-    }
-
-    public function getDefaultShortCodesLength(): int
-    {
-        $value = (int) env('DEFAULT_SHORT_CODES_LENGTH', DEFAULT_SHORT_CODES_LENGTH);
-        return $value < MIN_SHORT_CODES_LENGTH ? MIN_SHORT_CODES_LENGTH : $value;
-    }
-
-    public function getMercureConfig(): array
-    {
-        $publicUrl = env('MERCURE_PUBLIC_HUB_URL');
-
-        return [
-            'public_hub_url' => $publicUrl,
-            'internal_hub_url' => env('MERCURE_INTERNAL_HUB_URL', $publicUrl),
-            'jwt_secret' => env('MERCURE_JWT_SECRET'),
-        ];
-    }
-};
 
 return [
 
-    'app_options' => [
-        'disable_track_param' => env('DISABLE_TRACK_PARAM'),
-    ],
-
-    'delete_short_urls' => [
-        'check_visits_threshold' => true,
-        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD),
-    ],
-
-    'entity_manager' => [
-        'connection' => $helper->getDbConfig(),
-    ],
-
-    'url_shortener' => [
-        'domain' => [
-            'schema' => env('SHORT_DOMAIN_SCHEMA', 'http'),
-            'hostname' => env('SHORT_DOMAIN_HOST', ''),
-        ],
-        'validate_url' => (bool) env('VALIDATE_URLS', false),
-        'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true),
-        'visits_webhooks' => $helper->getVisitsWebhooks(),
-        'default_short_codes_length' => $helper->getDefaultShortCodesLength(),
-        'redirect_status_code' => (int) env('REDIRECT_STATUS_CODE', DEFAULT_REDIRECT_STATUS_CODE),
-        'redirect_cache_lifetime' => (int) env('REDIRECT_CACHE_LIFETIME', DEFAULT_REDIRECT_CACHE_LIFETIME),
-    ],
-
-    'not_found_redirects' => $helper->getNotFoundRedirectsConfig(),
-
     'logger' => [
         'Shlink' => [
-            'handlers' => [
+            'type' => LoggerType::STREAM->value,
-                'shlink_handler' => [
+            'destination' => 'php://stderr',
-                    'name' => StreamHandler::class,
-                    'params' => [
-                        'level' => Logger::INFO,
-                        'stream' => 'php://stdout',
-                    ],
-                ],
-            ],
         ],
     ],
 
-    'dependencies' => [
-        'aliases' => env('REDIS_SERVERS') === null ? [] : [
-            'lock_store' => 'redis_lock_store',
-        ],
-    ],
-
-    'cache' => [
-        'redis' => $helper->getRedisConfig(),
-    ],
-
-    'router' => [
-        'base_path' => env('BASE_PATH', ''),
-    ],
-
-    'mezzio-swoole' => [
-        'swoole-http-server' => [
-            'port' => (int) env('PORT', 8080),
-            'options' => [
-                'worker_num' => (int) env('WEB_WORKER_NUM', 16),
-                'task_worker_num' => (int) env('TASK_WORKER_NUM', 16),
-            ],
-        ],
-    ],
-
-    'geolite2' => [
-        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
-    ],
-
-    'mercure' => $helper->getMercureConfig(),
-
 ];

docker/docker-entrypoint.sh

@@ -3,18 +3,36 @@ set -e
 
 cd /etc/shlink
 
-echo "Creating fresh database if needed..."
+# Create data directories if they do not exist. This allows data dir to be mounted as an empty dir if needed
-php bin/cli db:create -n -q
+mkdir -p data/cache data/locks data/log data/proxies
 
-echo "Updating database..."
+flags="--no-interaction --clear-db-cache"
-php bin/cli db:migrate -n -q
 
-echo "Generating proxies..."
+# Skip downloading GeoLite2 db file if the license key env var was not defined or skipping was explicitly set
-php vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies -n -q
+if [ -z "${GEOLITE_LICENSE_KEY}" ] || [ "${SKIP_INITIAL_GEOLITE_DOWNLOAD}" = "true" ]; then
+  flags="${flags} --skip-download-geolite"
+fi
 
-echo "Clearing entities cache..."
+# If INITIAL_API_KEY was provided, create an initial API key
-php vendor/doctrine/orm/bin/doctrine.php orm:clear-cache:metadata -n -q
+if [ -n "${INITIAL_API_KEY}" ]; then
+  flags="${flags} --initial-api-key=${INITIAL_API_KEY}"
+fi
 
-# When restarting the container, swoole might think it is already in execution
+php vendor/bin/shlink-installer init ${flags}
-# This forces the app to be started every second until the exit code is 0
+
-until php vendor/mezzio/mezzio-swoole/bin/mezzio-swoole start; do sleep 1 ; done
+# Periodically run visit:locate every hour, if ENABLE_PERIODIC_VISIT_LOCATE=true was provided and running as root
+# FIXME: ENABLE_PERIODIC_VISIT_LOCATE is deprecated. Remove cron support in Shlink 4.0.0
+if [ "${ENABLE_PERIODIC_VISIT_LOCATE}" = "true" ] && [ "${SHLINK_USER_ID}" = "root" ]; then
+  echo "Configuring periodic visit location..."
+  echo "0 * * * * php /etc/shlink/bin/cli visit:locate -q" > /etc/crontabs/root
+  /usr/sbin/crond &
+fi
+
+if [ "$SHLINK_RUNTIME" = 'openswoole' ]; then
+  # Openswoole is deprecated. Remove in Shlink 4.0.0
+  # When restarting the container, openswoole might think it is already in execution
+  # This forces the app to be started every second until the exit code is 0
+  until php vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done
+elif [ "$SHLINK_RUNTIME" = 'rr' ]; then
+  ./bin/rr serve -c config/roadrunner/.rr.yml
+fi