Merge pull request #889 from shlinkio/develop

Release v2.4.0

.dockerignore

@@ -8,17 +8,16 @@ data/migrations_template.txt
 data/GeoLite2-City.*
 data/database.sqlite
 data/shlink-tests.db
-**/.gitignore
 CHANGELOG.md
+UPGRADE.md
 composer.lock
 vendor
 docs
 indocker
 docker-*
-php*
-infection.json
 phpstan.neon
+php*xml*
+infection.json
 **/test*
 build*
-.github
-hooks
+**/.*

.env.dist

@@ -1,10 +0,0 @@
-# Application
-APP_ENV=
-SECRET_KEY=
-SHORTENED_URL_SCHEMA=
-SHORTENED_URL_HOSTNAME=
-
-# Database
-DB_USER=
-DB_PASSWORD=
-DB_NAME=

.gitattributes

@@ -5,11 +5,8 @@
 /module/CLI/test-resources export-ignore
 /module/Core/test export-ignore
 /module/Core/test-db export-ignore
-/module/PreviewGenerator/test export-ignore
-/module/PreviewGenerator/test-db export-ignore
 /module/Rest/test export-ignore
 /module/Rest/test-api export-ignore
-.env.dist export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 .phpstorm.meta.php export-ignore

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,7 @@
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+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.
 -->

.github/ISSUE_TEMPLATE/Bug.md

@@ -5,9 +5,10 @@ labels: bug
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+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).
@@ -18,7 +19,7 @@ With that said, please fill in the information requested next. More information
 * 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|SQLite (x.y.z)
+* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary
 

.github/ISSUE_TEMPLATE/Feature_Request.md

@@ -5,9 +5,10 @@ labels: feature
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+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).

.github/ISSUE_TEMPLATE/Question_Support.md

@@ -5,9 +5,10 @@ labels: question
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+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).
@@ -18,7 +19,7 @@ With that said, please fill in the information requested next. More information
 * 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|SQLite (x.y.z)
+* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary
 

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

@@ -0,0 +1,24 @@
+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: Install buildx
+        id: buildx
+        uses: crazy-max/ghaction-docker-buildx@v1
+        with:
+          buildx-version: latest
+      - name: Login to docker hub
+        run: echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_USERNAME }}" --password-stdin
+      - name: Build the image
+        run: bash ./docker/build

.github/workflows/publish-release.yml

@@ -0,0 +1,30 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP 7.4
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4' # Publish release with lowest supported PHP version
+          tools: composer
+          extensions: swoole-4.5.5
+      - name: Generate release assets
+        run: ./build.sh ${GITHUB_REF#refs/tags/v}
+      - 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

.gitignore

@@ -1,10 +1,9 @@
 .idea
 build
-!hooks/build
+!docker/build
 composer.lock
 composer.phar
 vendor/
-.env
 data/database.sqlite
 data/shlink-tests.db
 data/GeoLite2-City.mmdb

.phpstorm.meta.php

@@ -2,7 +2,7 @@
 namespace PHPSTORM_META;
 
 use Psr\Container\ContainerInterface;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use Laminas\ServiceManager\ServiceLocatorInterface;
 
 /**
  * PhpStorm Container Interop code completion

.scrutinizer.yml

@@ -6,6 +6,9 @@ checks:
     code_rating: true
     duplication: true
 build:
+  dependencies:
+    override:
+      - composer install --no-interaction --no-scripts --ignore-platform-reqs
   nodes:
     analysis:
       tests:

.travis.yml

@@ -1,63 +1,56 @@
+dist: bionic
+
 language: php
 
 branches:
   only:
     - /.*/
 
-php:
-  - '7.2'
-  - '7.3'
-  - '7.4snapshot'
-
-matrix:
-  allow_failures:
-    - php: '7.4snapshot'
-
 services:
-  - mysql
-  - postgresql
   - docker
 
 cache:
   directories:
     - $HOME/.composer/cache/files
 
+jobs:
+  fast_finish: true
+  allow_failures:
+    - php: 'nightly'
+  include:
+    - name: "CI - 8.0"
+      php: 'nightly'
+      env:
+        - COMPOSER_FLAGS='--ignore-platform-reqs'
+    - name: "CI - 7.4"
+      php: '7.4'
+      env:
+        - COMPOSER_FLAGS=''
+
 before_install:
   - echo 'extension = apcu.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
-  - yes | pecl install swoole
   - phpenv config-rm xdebug.ini || return 0
+  - sudo ./data/infra/ci/install-ms-odbc.sh
+  - docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms shlink_db shlink_db_postgres shlink_db_maria
+  - yes | pecl install pdo_sqlsrv-5.9.0preview1 swoole-4.5.5 pcov
 
 install:
   - composer self-update
-  - composer install --no-interaction --prefer-dist
+  - composer install --no-interaction --prefer-dist $COMPOSER_FLAGS
 
 before_script:
-  - mysql -e 'CREATE DATABASE shlink_test;'
-  - psql -c 'create database shlink_test;' -U postgres
+  - docker-compose exec shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
   - mkdir build
-  - export DOCKERFILE_CHANGED=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/master} --name-only | grep Dockerfile)
+  - export DOCKERFILE_CHANGED=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/main} --name-only | grep Dockerfile)
 
 script:
   - composer ci
-  - if [[ ! -z "$DOCKERFILE_CHANGED" && "${TRAVIS_PHP_VERSION}" == "7.2" ]]; then docker build -t shlink-docker-image:temp . ; fi
+  - bin/test/run-api-tests.sh
+  - if [[ ! -z "${DOCKERFILE_CHANGED}" && "${TRAVIS_PHP_VERSION}" == "7.4" ]]; then docker build -t shlink-docker-image:temp . ; fi
 
 after_success:
   - rm -f build/clover.xml
-  - phpdbg -qrr vendor/bin/phpcov merge build --clover build/clover.xml
+  - wget https://phar.phpunit.de/phpcov-7.0.2.phar
+  - php phpcov-7.0.2.phar merge build --clover build/clover.xml
   - wget https://scrutinizer-ci.com/ocular.phar
   - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
-
-# Before deploying, build dist file for current travis tag
-before_deploy:
-  - rm -f ocular.phar
-  - ./build.sh ${TRAVIS_TAG#?}
-
-deploy:
-  - provider: releases
-    api_key:
-      secure: a9dbZchocqeuOViwUeNH54bQR5Sz7rEYXx5b9WPFtnFn9LGKKUaLbA2U91UQ9QKPrcTpsALubUYbw2CnNmvCwzaY+R8lCD3gkU4ohsEnbpnw3deOeixI74sqBHJAuCH9FSaRDGILoBMtUKx2xlzIymFxkIsgIukkGbdkWHDlRWY3oTUUuw1SQ2Xk9KDsbJQtjIc1+G/O6gHaV4qv/R9W8NPmJExKTNDrAZbC1vIUnxqp4UpVo1hst8qPd1at94CndDYM5rG+7imGbdtxTxzamt819qdTO1OfvtctKawNAm7YXZrrWft6c7gI6j6SI4hxd+ZrrPBqbaRFHkZHjnNssO/yn4SaOHFFzccmu0MzvpPCf0qWZwd3sGHVYer1MnR2mHYqU84QPlW3nrHwJjkrpq3+q0JcBY6GsJs+RskHNtkMTKV05Iz6QUI5YZGwTpuXaRm036SmavjGc4IDlMaYCk/NmbB9BKpthJxLdUpczOHpnjXXHziotWD6cfEnbjU3byfD8HY5WrxSjsNT7SKmXN3hRof7bk985ewQVjGT42O3NbnfnqjQQWr/B7/zFTpLR4f526Bkq12CdCyf5lvrbq+POkLVdJ+uFfR7ds248Ue/jBQy6kM1tWmKF9QiwisFlA84eQ4CW3I93Rp97URv+AQa9zmbD0Ve3Udp+g6nF5I=
-    file: "./build/shlink_${TRAVIS_TAG#?}_dist.zip"
-    skip_cleanup: true
-    on:
-      tags: true
-      php: '7.2'

CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing
+
+This file will guide you through the process of getting to project up and running, in case you want to provide coding contributions.
+
+You will also see how to ensure the code fulfills the expected code checks, and how to create a pull request.
+
+## System dependencies
+
+The project provides all its dependencies as docker containers through a docker-compose configuration.
+
+Because of this, the only actual dependencies are [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
+
+## Setting up the project
+
+The first thing you need to do is fork the repository, and clone it in your local machine.
+
+Then you will have to follow these steps:
+
+* Copy all files with `.local.php.dist` extension from `config/autoload` by removing the dist extension.
+
+    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`.
+
+    The first time this command is run, it will create several containers that are used during development, so it may take some time.
+
+    It will also create some empty databases and install the project dependencies with composer.
+
+* Run `./indocker bin/cli db:create` to create the initial database.
+* Run `./indocker bin/cli db:migrate` to get database migrations up to date.
+* Run `./indocker bin/cli api-key:generate` to get your first API key generated.
+
+Once you finish this, you will have the project exposed in ports `8000` through nginx+php-fpm and `8080` through swoole.
+
+> Note: The `indocker` shell script is a helper used to run commands inside the main docker container.
+
+## Project structure
+
+This project is structured as a modular application, using [laminas/laminas-config-aggregator](https://github.com/laminas/laminas-config-aggregator) to merge the configuration provided by every module.
+
+All modules are inside the `module` folder, and each one has its own `src`, `test` and `config` folders, with the source code, tests and configuration. They also have their own `ConfigProvider` class, which is consumed by the config aggregator.
+
+This is a simplified version of the project structure:
+
+```
+shlink
+├── bin
+│   ├── cli
+│   ├── install
+│   └── update
+├── config
+│   ├── autoload
+│   ├── params
+│   ├── config.php
+│   └── container.php
+├── data
+│   ├── cache
+│   ├── locks
+│   ├── log
+│   ├── migrations
+│   └── proxies
+├── docs
+│   ├── async-api
+│   └── swagger
+├── module
+│   ├── CLI
+│   ├── Core
+│   └── Rest
+├── public
+├── composer.json
+└── README.md
+```
+
+The purposes of every folder are:
+
+* `bin`: It contains the CLI tools. The `cli` one is the main entry point to run shlink from the command line, while `install` and `update` are helper tools used to install and update shlink when not using the docker image.
+* `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.
+* `docs`: Any project documentation is stored here, like API spec definitions.
+* `module`: Contains a subfolder 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.
+
+## Project tests
+
+In order to ensure stability and no regressions are introduced while developing new features, this project has different types of tests.
+
+* **Unit tests**: These are the simplest to run, and usually test individual pieces of code, replacing any external dependency by mocks.
+
+    The code coverage of unit tests is pretty high, and only 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.
+
+    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.
+
+    These are the best tests to catch regressions, and to verify everything interacts 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.
+
+* **CLI tests**: *TBD. Once included, its purpose will be the same as API tests, but running through the command line*
+
+Depending on the kind of contribution, maybe not all kinds of tests are needed, but the more you provide, the better.
+
+## Running code checks
+
+* Run `./indocker composer cs` to check coding styles are fulfilled.
+* Run `./indocker composer cs:fix` to fix coding styles (some may not be fixable from the CLI)
+* Run `./indocker composer stan` to statically analyze the code with [phpstan](https://phpstan.org/). This tool is the closest to "compile" PHP and verify everything would work as expected.
+* Run `./indocker composer test:unit` to run the unit tests.
+* Run `./indocker composer test:db` to run the database integration tests.
+
+    This command runs the same test suite against all supported database engines. 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 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 ci` to run all previous commands together. This command is run during the project's continuous integration.
+
+> 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).
+>
+> However, they just need to be created empty, with no tables. Also, once created, they are automatically reset before every new execution.
+>
+> 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.
+
+## 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.
+
+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.

Dockerfile

@@ -1,15 +1,15 @@
-FROM php:7.3.11-alpine3.10
-LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+FROM php:7.4.11-alpine3.12 as base
 
-ARG SHLINK_VERSION=1.20.0
+ARG SHLINK_VERSION=2.3.0
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV SWOOLE_VERSION 4.4.12
-ENV COMPOSER_VERSION 1.9.1
+ENV SWOOLE_VERSION 4.5.5
+ENV LC_ALL "C"
 
 WORKDIR /etc/shlink
 
+# Install required PHP extensions
 RUN \
-    # Install mysl and calendar
+    # Install mysql and calendar
     docker-php-ext-install -j"$(nproc)" pdo_mysql calendar && \
     # Install sqlite
     apk add --no-cache sqlite-libs sqlite-dev && \
@@ -22,28 +22,48 @@ RUN \
     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
+    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
+RUN if [ $(uname -m) == "x86_64" ]; then \
+      wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+      apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+      apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+      pecl install pdo_sqlsrv && \
+      docker-php-ext-enable pdo_sqlsrv && \
+      apk del .phpize-deps && \
+      rm msodbcsql17_17.5.1.1-1_amd64.apk ; \
+    fi
 
 # Install swoole
-# First line fixes an error when installing pecl extensions. Found in https://github.com/docker-library/php/issues/233
 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 . .
-RUN rm -rf ./docker && \
-    wget https://getcomposer.org/download/${COMPOSER_VERSION}/composer.phar && \
+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 && \
     php composer.phar clear-cache && \
-    rm composer.*
+    rm -r docker composer.* && \
+    sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
 
-# Add shlink to the path to ease running it after container is created
+
+# Prepare final image
+FROM base
+LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+
+COPY --from=builder /etc/shlink .
 RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink
-RUN sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
 
-# Expose swoole port
+# Expose default swoole port
 EXPOSE 8080
 
 # Expose params config dir, since the user is expected to provide custom config from there
@@ -52,5 +72,6 @@ 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/
 
 ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2019 Alejandro Celaya
+Copyright (c) 2016-2020 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,37 +1,56 @@
-# Shlink
+![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png)
 
-[![Build Status](https://img.shields.io/travis/shlinkio/shlink.svg?style=flat-square)](https://travis-ci.org/shlinkio/shlink)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Build Status](https://img.shields.io/travis/com/shlinkio/shlink.svg?style=flat-square)](https://travis-ci.com/shlinkio/shlink)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/)
 [![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
-[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/master/LICENSE)
-[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://acel.me/donate)
+[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?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)
+[![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.
 
+> 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)
+    - [Download](#download)
+    - [Configure](#configure)
+    - [Serve](#serve)
+    - [Bonus](#bonus)
 - [Update to new version](#update-to-new-version)
 - [Using a docker image](#using-a-docker-image)
 - [Using shlink](#using-shlink)
-  - [Shlink CLI Help](#shlink-cli-help)
+    - [Shlink CLI Help](#shlink-cli-help)
+- [Multiple domains](#multiple-domains)
+    - [Management](#management)
+    - [Visits](#visits)
+    - [Special redirects](#special-redirects)
 
 ## Installation
 
-First make sure the host where you are going to run shlink fulfills these requirements:
+> These are the steps needed to install Shlink if you plan to manually host it. 
+>
+> Alternatively, you can use the official docker image. If that's your intention, jump directly to [Using a docker image](#using-a-docker-image)
 
-* PHP 7.2 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
-* MySQL, MariaDB, PostgreSQL or SQLite.
+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.
+* MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
 * The web server of your choice with PHP integration (Apache or Nginx recommended).
 
-Then, you will need a built version of the project. There are a few ways to get it.
+### Download
+
+In order to run Shlink, you will need a built version of the project. There are two ways to get it.
 
 * **Using a dist file**
 
     The easiest way to install shlink is by using one of the pre-bundled distributable packages.
 
-    Just 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_x.x.x_dist.zip` file you will find there.
 
     Finally, decompress the file in the location of your choice.
 
@@ -43,183 +62,168 @@ Then, you will need a built version of the project. There are a few ways to get
     * 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).
 
-    After that, you will have a `shlink_x.x.x_dist.zip` dist file inside the `build` directory.
+    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.
 
-    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.org/shlinkio/shlink), attaching generated dist file to it.
+    > 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.
 
-Despite how you built the project, you are going to need to install it now, by following these steps:
+### Configure
 
-* If you are going to use MySQL, MariaDB or PostgreSQL, create an empty database with the name of your choice.
+Despite how you built the project, you now need to configure it, by following these steps:
+
+* If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
 * Recursively grant write permissions to the `data` directory. Shlink uses it to cache some information.
 * 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.**
-* Expose shlink 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.2-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. Just run `./vendor/bin/zend-expressive-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/zend-expressive-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)).
-
 * 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.
-* Finally access to [https://app.shlink.io](https://app.shlink.io) and configure your server to start creating short URLs.
 
-**Bonus**
+### Serve
 
-There are a couple of time-consuming tasks that shlink expects you to do manually, or at least it is recommended, since it will improve runtime performance.
+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.
 
-Those tasks can be performed using shlink's CLI, so it should be easy to schedule them to be run in the background (for example, using cron jobs):
+* **Using a web server:**
 
-* **For shlink older than 1.18.0 or not using swoole as the web server**: Resolve IP address locations: `/path/to/shlink/bin/cli visit:locate`
+    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.
 
-    If you don't run this command regularly, the stats will say all visits come from *unknown* locations.
+    *Nginx:*
 
-* Generate website previews: `/path/to/shlink/bin/cli short-url:process-previews`
+    ```nginx
+    server {
+        server_name doma.in;
+        listen 80;
+        root /path/to/shlink/public;
+        index index.php;
+        charset utf-8;
 
-    Running this will improve the performance of the `doma.in/abc123/preview` URLs, which return a preview of the site.
+        location / {
+            try_files $uri $uri/ /index.php$is_args$args;
+        }
 
-    > **Important!** Generating previews is considered deprecated and the feature will be removed in Shlink v2.
+        location ~ \.php$ {
+            fastcgi_split_path_info ^(.+\.php)(/.+)$;
+            fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
+            fastcgi_index index.php;
+            include fastcgi.conf;
+        }
 
-* **For shlink older than v1.17.0**: Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
+        location ~ /\.ht {
+            deny all;
+        }
+    }
+    ```
 
-    When shlink is installed it downloads a fresh [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) db file. Running this command will update this file.
+    *Apache:*
 
-    The file is updated the first Tuesday of every month, so it should be enough running this command the first Wednesday.
+    ```apache
+    <VirtualHost *:80>
+        ServerName doma.in
+        DocumentRoot "/path/to/shlink/public"
 
-*Any of these commands accept the `-q` flag, which makes it not display any output. This is recommended when configuring the commands as cron jobs.*
+        <Directory "/path/to/shlink/public">
+            Options FollowSymLinks Includes ExecCGI
+            AllowOverride all
+            Order allow,deny
+            Allow from all
+        </Directory>
+    </VirtualHost>
+    ```
 
-> In future versions, it is planed that, when using **swoole** to serve shlink, some of these tasks are automatically run without blocking the request and also, without having to configure cron jobs. Probably resolving IP locations and generating previews.
+* **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 yourself. Instead, follow these steps:
+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 directories 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.
+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` script will ask you for the location from previous shlink version, and use it in order to import the configuration. It will then update the database and generate some assets shlink needs to work.
+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.
 
-Right now, it does not import cached info (like website previews), but it will. For now you will need to regenerate them again.
-
-**Important!** It is recommended that you don't skip any version when using this process. The update gets better on every version, but older versions might make assumptions.
+**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.
 
 ## Using a docker image
 
@@ -237,7 +241,7 @@ Once shlink is installed, there are two main ways to interact with it:
 
     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/api-docs), and a sandbox which also documents every endpoint can be found [here](https://shlink.io/swagger-ui/index.html).
+* **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.
 
@@ -259,33 +263,90 @@ Options:
   -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
+  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.
- config
-  config:generate-charset     [DEPRECATED] Generates a character set sample just by shuffling the default one, "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Then it can be set in the SHORTCODE_CHARS environment variable
-  config:generate-secret      [DEPRECATED] Generates a random secret string that can be used for JWT token encryption
+  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.
+  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            [short-code:delete] Deletes a short URL
-  short-url:generate          [shortcode:generate|short-code:generate] Generates a short URL for provided long URL and returns it
-  short-url:list              [shortcode:list|short-code:list] List all short URLs
-  short-url:parse             [shortcode:parse|short-code:parse] Returns the long URL behind a short code
-  short-url:process-previews  [shortcode:process-previews|short-code:process-previews] [DEPRECATED] Processes and generates the previews for every URL, improving performance for later web requests.
-  short-url:visits            [shortcode:visits|short-code:visits] Returns the detailed visits information for provided short code
+  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.
+  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                [visit:process] Resolves visits origin locations.
-  visit:update-db             [DEPRECATED] Updates the GeoLite2 database file used to geolocate IP addresses
+  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.
+
+---
+
 > This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

UPGRADE.md

@@ -0,0 +1,88 @@
+# Upgrading
+
+## From v1.x to v2.x
+
+### PHP 7.4 required
+
+This new version takes advantage of several new features introduced in PHP 7.4.
+
+Thanks to that, the code is more reliable and robust, and easier to maintain and improve.
+
+However, that means that any previous PHP version is no longer supported.
+
+### Preview generation
+
+The ability to generate website previews has been completely removed and has no replacement.
+
+The feature never properly worked, and it wasn't really useful. Because of that, the feature is no longer available on Shlink 2.x
+
+Removing this feature has these implications:
+
+* The `short-url:process-previews` CLI command no longer exists, and an error will be thrown if executed.
+* The `/{shortCode}/preview` path is no longer valid, and will return a 404 status.
+
+### Removed paths
+
+These routes have been removed, but have a direct replacement:
+
+* `/qr/{shortCode}[/{size}]` -> `/{shortCode}/qr-code[/{size}]`
+* `PUT /rest/v{version}/short-urls/{shortCode}` -> `PATCH /rest/v{version}/short-urls/{shortCode}`
+
+When using the old ones, a 404 status will me returned now.
+
+### Removed command and route aliases
+
+All the aliases for the CLI commands in the `short-urls` namespace have been removed. If you were using any of those commands with the `shortcode` or `short-code` prefixes, make sure to update them to use the `short-urls` prefix instead.
+
+The same happens for all REST endpoints starting with `/short-code`. They were previously aliased to `/short-urls` ones, but they will return a 404 now. Make sure to update them accordingly.
+
+### JWT authentication removed
+
+Shlink's REST API no longer accepts authentication using a JWT token. The API key has to be passed now in the `x-api-key` header.
+
+Removing this feature has these implications:
+
+* Shlink will no longer introspect the `Authorization` header for Bearer tokens.
+* The `POST /rest/v{version}/authenticate` endpoint no longer exists and will return a 404.
+
+### API version is now required
+
+Endpoints need to provide a version in the path now. Previously, not providing a version used to fall back to v1. Now, it will return a 404 status, as no route will match.
+
+The only exception is the `/rest/health` endpoint, which will continue working without the version.
+
+### API errors
+
+Shlink v1.21.0 introduced support for API errors using the Problem Details format, as well as the v2 of the API.
+
+For backwards compatibility reasons, requests performed to v1 continued to return the old `error` and `message` properties.
+
+Starting with Shlink v2.0.0, both versions of the API will no longer return those two properties.
+
+As a replacement, use `type` instead of `error`, and `detail` instead of `message`.
+
+### Changes in models
+
+The next REST API models have changed:
+
+* **ShortUrl**: The `originalUrl` property was deprecated and has been removed. Use `longUrl` instead.
+* **Visit**: The `remoteAddr` property was deprecated and has been removed. It has no replacement.
+* **VisitLocation**: The `latitude` and `longitude` properties are no longer strings, but float.
+
+### URL validation
+
+Shlink can verify provided long URLs are valid before trying to shorten them. Starting with v2, it no longer does it by default and needs to be explicitly enabled instead of explicitly disabled.
+
+### Removed config options
+
+The `not_found_redirect_to` config option and the `NOT_FOUND_REDIRECT_TO` env var are no longer taken into consideration for the docker image.
+
+Instead, use `invalid_short_url_redirect_to` and `INVALID_SHORT_URL_REDIRECT_TO` respectively.
+
+### Migrated to Laminas
+
+The project has been using Zend Framework components since the beginning. Since it has been re-branded as [Laminas](https://getlaminas.org/), this version updates to the new set of components.
+
+Updating to Laminas components has these implications:
+
+* If you were manually serving Shlink with swoole, the entry script has to be changed from `/path/to/shlink/vendor/bin/zend-expressive-swoole` to `/path/to/shlink/vendor/bin/mezzio-swoole`

bin/cli

@@ -1,10 +1,7 @@
 #!/usr/bin/env php
 <?php
+
 declare(strict_types=1);
 
-use Psr\Container\ContainerInterface;
-use Symfony\Component\Console\Application as CliApp;
-
-/** @var ContainerInterface $container */
-$container = include __DIR__ . '/../config/container.php';
-$container->get(CliApp::class)->run();
+$run = require __DIR__ . '/../config/run.php';
+$run(true);

bin/install

@@ -8,5 +8,5 @@ use function chdir;
 use function dirname;
 
 chdir(dirname(__DIR__));
-$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$run(false);
+[$install] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$install();

bin/test/run-api-tests.sh

@@ -1,18 +1,19 @@
 #!/usr/bin/env sh
 export APP_ENV=test
 export DB_DRIVER=mysql
+export TEST_ENV=api
 
 # Try to stop server just in case it hanged in last execution
-vendor/bin/zend-expressive-swoole stop
+vendor/bin/mezzio-swoole stop
 
 echo 'Starting server...'
-vendor/bin/zend-expressive-swoole start -d
+vendor/bin/mezzio-swoole start -d
 sleep 2
 
-vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always --log-junit=build/coverage-api/junit.xml $*
 testsExitCode=$?
 
-vendor/bin/zend-expressive-swoole stop
+vendor/bin/mezzio-swoole stop
 
 # Exit this script with the same code as the tests. If tests failed, this script has to fail
 exit $testsExitCode

bin/update

@@ -8,5 +8,5 @@ use function chdir;
 use function dirname;
 
 chdir(dirname(__DIR__));
-$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
-$run(true);
+[, $update] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$update();

build.sh

@@ -19,13 +19,14 @@ mkdir -p "${builtcontent}"
 rsync -av * "${builtcontent}" \
     --exclude=*docker* \
     --exclude=Dockerfile \
+    --include=.htaccess \
     --exclude-from=./.dockerignore
 cd "${builtcontent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
 ${composerBin} self-update
-${composerBin} install --no-dev --optimize-autoloader --no-progress --no-interaction
+${composerBin} install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction
 
 # Delete development files
 echo 'Deleting dev files...'

composer.json

@@ -12,72 +12,75 @@
         }
     ],
     "require": {
-        "php": "^7.2",
+        "php": "^7.4",
         "ext-json": "*",
         "ext-pdo": "*",
-        "acelaya/ze-content-based-error-handler": "^3.0",
         "akrabat/ip-address-middleware": "^1.0",
-        "cakephp/chronos": "^1.2",
-        "cocur/slugify": "^3.0",
-        "doctrine/cache": "^1.6",
-        "doctrine/dbal": "^2.9",
-        "doctrine/migrations": "^2.0",
-        "doctrine/orm": "^2.5",
+        "cakephp/chronos": "^2.0",
+        "cocur/slugify": "^4.0",
+        "doctrine/cache": "^1.9",
+        "doctrine/dbal": "^2.10",
+        "doctrine/migrations": "^3.0.1",
+        "doctrine/orm": "^2.7",
         "endroid/qr-code": "^3.6",
-        "firebase/php-jwt": "^4.0",
         "geoip2/geoip2": "^2.9",
-        "guzzlehttp/guzzle": "^6.3",
+        "guzzlehttp/guzzle": "^7.0",
+        "laminas/laminas-config": "^3.3",
+        "laminas/laminas-config-aggregator": "^1.1",
+        "laminas/laminas-diactoros": "^2.1.3",
+        "laminas/laminas-inputfilter": "^2.10",
+        "laminas/laminas-paginator": "^2.8",
+        "laminas/laminas-servicemanager": "^3.4",
+        "laminas/laminas-stdlib": "^3.2",
+        "lcobucci/jwt": "^4.0@alpha",
+        "league/uri": "^6.2",
         "lstrojny/functional-php": "^1.9",
-        "mikehaertl/phpwkhtmltopdf": "^2.2",
-        "monolog/monolog": "^1.24",
-        "ocramius/proxy-manager": "~2.2.2",
+        "mezzio/mezzio": "^3.2",
+        "mezzio/mezzio-fastroute": "^3.0",
+        "mezzio/mezzio-helpers": "^5.3",
+        "mezzio/mezzio-platesrenderer": "^2.1",
+        "mezzio/mezzio-problem-details": "^1.1",
+        "mezzio/mezzio-swoole": "^2.6.4",
+        "monolog/monolog": "^2.0",
+        "nikolaposa/monolog-factory": "^3.0",
+        "ocramius/proxy-manager": "^2.7.0",
         "phly/phly-event-dispatcher": "^1.0",
+        "php-middleware/request-id": "^4.0",
         "predis/predis": "^1.1",
         "pugx/shortid-php": "^0.5",
-        "shlinkio/shlink-common": "^2.2.1",
-        "shlinkio/shlink-event-dispatcher": "^1.0",
-        "shlinkio/shlink-installer": "^3.1",
-        "shlinkio/shlink-ip-geolocation": "^1.1",
-        "symfony/console": "^4.3",
-        "symfony/filesystem": "^4.3",
-        "symfony/lock": "^4.3",
-        "symfony/process": "^4.3",
-        "theorchard/monolog-cascade": "^0.5",
-        "zendframework/zend-config": "^3.3",
-        "zendframework/zend-config-aggregator": "^1.1",
-        "zendframework/zend-diactoros": "^2.1.3",
-        "zendframework/zend-expressive": "^3.2",
-        "zendframework/zend-expressive-fastroute": "^3.0",
-        "zendframework/zend-expressive-helpers": "^5.3",
-        "zendframework/zend-expressive-platesrenderer": "^2.1",
-        "zendframework/zend-expressive-swoole": "^2.4",
-        "zendframework/zend-inputfilter": "^2.10",
-        "zendframework/zend-paginator": "^2.8",
-        "zendframework/zend-servicemanager": "^3.4",
-        "zendframework/zend-stdlib": "^3.2"
+        "ramsey/uuid": "^3.9",
+        "shlinkio/shlink-common": "^3.3.0",
+        "shlinkio/shlink-config": "^1.0",
+        "shlinkio/shlink-event-dispatcher": "^1.4",
+        "shlinkio/shlink-importer": "^2.0.1",
+        "shlinkio/shlink-installer": "^5.1.0",
+        "shlinkio/shlink-ip-geolocation": "^1.5",
+        "symfony/console": "^5.1",
+        "symfony/filesystem": "^5.1",
+        "symfony/lock": "^5.1",
+        "symfony/mercure": "^0.3.0",
+        "symfony/process": "^5.1",
+        "symfony/string": "^5.1"
     },
     "require-dev": {
         "devster/ubench": "^2.0",
+        "dms/phpunit-arraysubset-asserts": "^0.2.0",
         "eaglewu/swoole-ide-helper": "dev-master",
-        "filp/whoops": "^2.4",
-        "infection/infection": "^0.14.2",
-        "phpstan/phpstan": "^0.11.16",
-        "phpunit/phpcov": "^6.0",
-        "phpunit/phpunit": "^8.3",
+        "infection/infection": "^0.20.0",
+        "phpspec/prophecy-phpunit": "^2.0",
+        "phpstan/phpstan": "^0.12.52",
+        "phpunit/php-code-coverage": "^9.2",
+        "phpunit/phpunit": "^9.4",
         "roave/security-advisories": "dev-master",
-        "shlinkio/php-coding-standard": "~2.0.0",
-        "shlinkio/shlink-test-utils": "^1.0",
-        "symfony/dotenv": "^4.3",
-        "symfony/var-dumper": "^4.3",
-        "zendframework/zend-component-installer": "^2.1",
-        "zendframework/zend-expressive-tooling": "^1.2"
+        "shlinkio/php-coding-standard": "~2.1.1",
+        "shlinkio/shlink-test-utils": "^1.5",
+        "symfony/var-dumper": "^5.1"
     },
     "autoload": {
         "psr-4": {
             "Shlinkio\\Shlink\\CLI\\": "module/CLI/src",
             "Shlinkio\\Shlink\\Rest\\": "module/Rest/src",
-            "Shlinkio\\Shlink\\Core\\": "module/Core/src",
-            "Shlinkio\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/src/"
+            "Shlinkio\\Shlink\\Core\\": "module/Core/src"
         },
         "files": [
             "module/Core/functions/functions.php"
@@ -91,9 +94,11 @@
             "ShlinkioTest\\Shlink\\Core\\": [
                 "module/Core/test",
                 "module/Core/test-db"
-            ],
-            "ShlinkioTest\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/test"
-        }
+            ]
+        },
+        "files": [
+            "config/test/constants.php"
+        ]
     },
     "scripts": {
         "ci": [
@@ -104,7 +109,7 @@
         ],
         "cs": "phpcs",
         "cs:fix": "phpcbf",
-        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config --level=5 -c phpstan.neon",
+        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config data/migrations --level=6",
         "test": [
             "@test:unit",
             "@test:db",
@@ -112,37 +117,34 @@
         ],
         "test:ci": [
             "@test:unit:ci",
-            "@test:db:ci",
-            "@test:api"
+            "@test:db"
         ],
-        "test:unit": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
-        "test:unit:ci": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --coverage-clover=build/clover.xml --coverage-xml=build/coverage-xml --log-junit=build/phpunit.junit.xml --testdox",
+        "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": [
-            "@test:db:sqlite",
+            "@test:db:sqlite:ci",
             "@test:db:mysql",
             "@test:db:maria",
-            "@test:db:postgres"
+            "@test:db:postgres",
+            "@test:db:ms"
         ],
-        "test:db:ci": [
-            "@test:db:sqlite",
-            "@test:db:mysql",
-            "@test:db:postgres"
-        ],
-        "test:db:sqlite": "APP_ENV=test phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always -c phpunit-db.xml --coverage-php build/coverage-db.cov --testdox",
+        "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",
         "test:db:mysql": "DB_DRIVER=mysql composer test:db:sqlite",
         "test:db:maria": "DB_DRIVER=maria composer test:db:sqlite",
         "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:pretty": [
-            "@test",
-            "phpdbg -qrr vendor/bin/phpcov merge build --html build/html"
+        "test:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
+        "infect": "infection --threads=4 --min-msi=80 --log-verbosity=default --only-covered",
+        "infect:ci:base": "@infect --skip-initial-tests",
+        "infect:ci": [
+            "@infect:ci:base --coverage=build/coverage-unit",
+            "@infect:ci:base --coverage=build/coverage-db --test-framework-options=--configuration=phpunit-db.xml"
         ],
-        "test:unit:pretty": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage",
-        "infect": "infection --threads=4 --min-msi=75 --log-verbosity=default --only-covered",
-        "infect:ci": "infection --threads=4 --min-msi=75 --log-verbosity=default --only-covered --coverage=build",
-        "infect:show": "infection --threads=4 --min-msi=75 --log-verbosity=default --only-covered --show-mutations",
         "infect:test": [
             "@test:unit:ci",
+            "@test:db:sqlite:ci",
             "@infect:ci"
         ],
         "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
@@ -156,22 +158,20 @@
         "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:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB and PostgreSQL</>",
-        "test:db:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL and PostgreSQL</>",
+        "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: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:api": "<fg=blue;options=bold>Runs API test suites</>",
-        "test:pretty": "<fg=blue;options=bold>Runs all test suites and generates an HTML code coverage report</>",
         "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
         "infect": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
         "infect:ci": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
-        "infect:show": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing and shows applied mutators</>",
         "infect:test": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
         "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "platform-check": false
     }
 }

config/autoload/app_options.global.php

@@ -2,14 +2,11 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Common\env;
-
 return [
 
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'secret_key' => env('SECRET_KEY', ''),
         'disable_track_param' => null,
     ],
 

config/autoload/client-detection.global.php

@@ -7,11 +7,11 @@ return [
     'ip_address_resolution' => [
         'headers_to_inspect' => [
             'CF-Connecting-IP',
-            'True-Client-IP',
-            'X-Real-IP',
-            'Forwarded',
             'X-Forwarded-For',
             'X-Forwarded',
+            'Forwarded',
+            'True-Client-IP',
+            'X-Real-IP',
             'X-Cluster-Client-Ip',
             'Client-Ip',
         ],

config/autoload/common.global.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Zend\ConfigAggregator\ConfigAggregator;
+use Laminas\ConfigAggregator\ConfigAggregator;
 
 return [
 

config/autoload/common.local.php.dist

@@ -1,7 +1,8 @@
 <?php
+
 declare(strict_types=1);
 
-use Zend\ConfigAggregator\ConfigAggregator;
+use Laminas\ConfigAggregator\ConfigAggregator;
 
 return [
 

config/autoload/dependencies.global.php

@@ -2,18 +2,23 @@
 
 declare(strict_types=1);
 
-use Zend\Expressive;
-use Zend\Expressive\Container;
+use GuzzleHttp\Client;
+use Mezzio\Container;
+use Psr\Http\Client\ClientInterface;
 
 return [
 
     'dependencies' => [
         'delegators' => [
-            Expressive\Application::class => [
+            Mezzio\Application::class => [
                 Container\ApplicationConfigInjectionDelegator::class,
             ],
         ],
 
+        'aliases' => [
+            ClientInterface::class => Client::class,
+        ],
+
         'lazy_services' => [
             'proxies_target_dir' => 'data/proxies',
             'proxies_namespace' => 'ShlinkProxy',

config/autoload/dependencies.local.php.dist

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Psr\Container\ContainerInterface;
@@ -12,7 +13,7 @@ return [
         ],
 
         'initializers' => [
-            function (ContainerInterface $container, $instance) {
+            function (ContainerInterface $container, $instance): void {
                 if ($instance instanceof Log\LoggerAwareInterface) {
                     $instance->setLogger($container->get(Log\LoggerInterface::class));
                 }

config/autoload/entity-manager.global.php

@@ -9,11 +9,12 @@ return [
     'entity_manager' => [
         'orm' => [
             'proxies_dir' => 'data/proxies',
+            'load_mappings_using_functional_style' => true,
         ],
         'connection' => [
-            'user' => env('DB_USER'),
-            'password' => env('DB_PASSWORD'),
-            'dbname' => env('DB_NAME', 'shlink'),
+            'user' => '',
+            'password' => '',
+            'dbname' => 'shlink',
             'charset' => 'utf8',
         ],
     ],

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

@@ -1,13 +1,24 @@
 <?php
+
+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' => [
+            'user' => 'root',
+            'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db',
-            'driverOptions' => [
-                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-            ],
+            'driverOptions' => $driverOptions,
         ],
     ],
 

config/autoload/error-handler.global.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\Stratigility\Middleware\ErrorHandler;
+use Mezzio\ProblemDetails\ProblemDetailsMiddleware;
+use Shlinkio\Shlink\Common\Logger;
+
+return [
+
+    'problem-details' => [
+        'default_types_map' => [
+            404 => 'NOT_FOUND',
+            500 => 'INTERNAL_SERVER_ERROR',
+        ],
+    ],
+
+    'error_handler' => [
+        'listeners' => [Logger\ErrorLogger::class],
+    ],
+
+    'dependencies' => [
+        'delegators' => [
+            ErrorHandler::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+            ProblemDetailsMiddleware::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+        ],
+    ],
+
+];

config/autoload/errorhandler.local.php.dist

@@ -1,29 +0,0 @@
-<?php
-declare(strict_types=1);
-
-use Zend\Expressive\Container\WhoopsErrorResponseGeneratorFactory;
-
-return [
-    'dependencies' => [
-        'invokables' => [
-            'Zend\Expressive\Whoops' => Whoops\Run::class,
-            'Zend\Expressive\WhoopsPageHandler' => Whoops\Handler\PrettyPageHandler::class,
-        ],
-    ],
-
-    'whoops' => [
-        'json_exceptions' => [
-            'display'    => true,
-            'show_trace' => true,
-            'ajax_only'  => true,
-        ],
-    ],
-
-    'error_handler' => [
-        'plugins' => [
-            'factories' => [
-                'text/html' => WhoopsErrorResponseGeneratorFactory::class,
-            ],
-        ],
-    ],
-];

config/autoload/geolite2.global.php

@@ -7,7 +7,7 @@ return [
     'geolite2' => [
         'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
         'temp_dir' => sys_get_temp_dir(),
-        'download_from' => 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz',
+        'license_key' => 'G4Lm0C60yJsnkdPi',
     ],
 
 ];

config/autoload/installer.global.php

@@ -2,49 +2,52 @@
 
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Installer\Config\Plugin;
+use Shlinkio\Shlink\Installer\Config\Option;
 
 return [
 
-    'installer_plugins_expected_config' => [
-        Plugin\UrlShortenerConfigCustomizer::class => [
-            Plugin\UrlShortenerConfigCustomizer::SCHEMA,
-            Plugin\UrlShortenerConfigCustomizer::HOSTNAME,
-            Plugin\UrlShortenerConfigCustomizer::VALIDATE_URL,
+    'installer' => [
+        'enabled_options' => [
+            Option\Database\DatabaseDriverConfigOption::class,
+            Option\Database\DatabaseNameConfigOption::class,
+            Option\Database\DatabaseHostConfigOption::class,
+            Option\Database\DatabasePortConfigOption::class,
+            Option\Database\DatabaseUserConfigOption::class,
+            Option\Database\DatabasePasswordConfigOption::class,
+            Option\Database\DatabaseSqlitePathConfigOption::class,
+            Option\Database\DatabaseMySqlOptionsConfigOption::class,
+            Option\UrlShortener\ShortDomainHostConfigOption::class,
+            Option\UrlShortener\ShortDomainSchemaConfigOption::class,
+            Option\UrlShortener\ValidateUrlConfigOption::class,
+            Option\Visit\VisitsWebhooksConfigOption::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\Worker\TaskWorkerNumConfigOption::class,
+            Option\Worker\WebWorkerNumConfigOption::class,
+            Option\RedisServersConfigOption::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,
         ],
 
-        Plugin\ApplicationConfigCustomizer::class => [
-            Plugin\ApplicationConfigCustomizer::SECRET,
-            Plugin\ApplicationConfigCustomizer::DISABLE_TRACK_PARAM,
-            Plugin\ApplicationConfigCustomizer::CHECK_VISITS_THRESHOLD,
-            Plugin\ApplicationConfigCustomizer::VISITS_THRESHOLD,
-            Plugin\ApplicationConfigCustomizer::BASE_PATH,
-            Plugin\ApplicationConfigCustomizer::WEB_WORKER_NUM,
-            Plugin\ApplicationConfigCustomizer::TASK_WORKER_NUM,
-        ],
-
-        Plugin\DatabaseConfigCustomizer::class => [
-            Plugin\DatabaseConfigCustomizer::DRIVER,
-            Plugin\DatabaseConfigCustomizer::NAME,
-            Plugin\DatabaseConfigCustomizer::USER,
-            Plugin\DatabaseConfigCustomizer::PASSWORD,
-            Plugin\DatabaseConfigCustomizer::HOST,
-            Plugin\DatabaseConfigCustomizer::PORT,
-        ],
-
-        Plugin\RedirectsConfigCustomizer::class => [
-            Plugin\RedirectsConfigCustomizer::INVALID_SHORT_URL_REDIRECT_TO,
-            Plugin\RedirectsConfigCustomizer::REGULAR_404_REDIRECT_TO,
-            Plugin\RedirectsConfigCustomizer::BASE_URL_REDIRECT_TO,
-        ],
-    ],
-
-    'installation_commands' => [
-        'db_create_schema' => [
-            'command' => 'bin/cli db:create',
-        ],
-        'db_migrate' => [
-            'command' => 'bin/cli db:migrate',
+        'installation_commands' => [
+            'db_create_schema' => [
+                'command' => 'bin/cli db:create',
+            ],
+            'db_migrate' => [
+                'command' => 'bin/cli db:migrate',
+            ],
         ],
     ],
 

config/autoload/locks.global.php

@@ -2,15 +2,13 @@
 
 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\Logger\LoggerAwareDelegatorFactory;
 use Symfony\Component\Lock;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 
-// This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
-$localLockFactory = 'Shlinkio\Shlink\LocalLockFactory';
-class_alias(Lock\Factory::class, $localLockFactory);
+use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
 
 return [
 
@@ -22,8 +20,8 @@ return [
         'factories' => [
             Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
             Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
-            Lock\Factory::class => ConfigAbstractFactory::class,
-            $localLockFactory => ConfigAbstractFactory::class,
+            Lock\LockFactory::class => ConfigAbstractFactory::class,
+            LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
         ],
         'aliases' => [
             // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
@@ -36,7 +34,7 @@ return [
             Lock\Store\RedisStore::class => [
                 RetryLockStoreDelegatorFactory::class,
             ],
-            Lock\Factory::class => [
+            Lock\LockFactory::class => [
                 LoggerAwareDelegatorFactory::class,
             ],
         ],
@@ -45,8 +43,8 @@ return [
     ConfigAbstractFactory::class => [
         Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
         Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
-        Lock\Factory::class => ['lock_store'],
-        $localLockFactory => ['local_lock_store'],
+        Lock\LockFactory::class => ['lock_store'],
+        LOCAL_LOCK_FACTORY => ['local_lock_store'],
     ],
 
 ];

config/autoload/logger.global.php

@@ -4,64 +4,72 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Monolog\Handler\RotatingFileHandler;
-use Monolog\Handler\StreamHandler;
+use Monolog\Formatter;
+use Monolog\Handler;
 use Monolog\Logger;
 use Monolog\Processor;
+use MonologFactory\DiContainerLoggerFactory;
+use PhpMiddleware\RequestId;
 use Psr\Log\LoggerInterface;
 
 use const PHP_EOL;
 
+$processors = [
+    'exception_with_new_line' => [
+        'name' => Common\Logger\Processor\ExceptionWithNewLineProcessor::class,
+    ],
+    'psr3' => [
+        '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 [
 
     'logger' => [
-        'formatters' => [
-            'dashed' => [
-                'format' => '[%datetime%] %channel%.%level_name% - %message%' . PHP_EOL,
-                'include_stacktraces' => true,
+        'Shlink' => [
+            'name' => 'Shlink',
+            'handlers' => [
+                'shlink_handler' => [
+                    'name' => Handler\RotatingFileHandler::class,
+                    'params' => [
+                        'level' => Logger::INFO,
+                        'filename' => 'data/log/shlink_log.log',
+                        'max_files' => 30,
+                        'file_permission' => 0666,
+                    ],
+                    'formatter' => $formatter,
+                ],
             ],
+            'processors' => $processors,
         ],
-
-        'handlers' => [
-            'shlink_rotating_handler' => [
-                'class' => RotatingFileHandler::class,
-                'level' => Logger::INFO,
-                'filename' => 'data/log/shlink_log.log',
-                'max_files' => 30,
-                'formatter' => 'dashed',
-            ],
-            'access_handler' => [
-                'class' => StreamHandler::class,
-                'level' => Logger::INFO,
-                'stream' => 'php://stdout',
-            ],
-        ],
-
-        'processors' => [
-            'exception_with_new_line' => [
-                'class' => Common\Logger\Processor\ExceptionWithNewLineProcessor::class,
-            ],
-            'psr3' => [
-                'class' => Processor\PsrLogMessageProcessor::class,
-            ],
-        ],
-
-        'loggers' => [
-            'Shlink' => [
-                'handlers' => ['shlink_rotating_handler'],
-                'processors' => ['exception_with_new_line', 'psr3'],
-            ],
-            'Access' => [
-                'handlers' => ['access_handler'],
-                'processors' => ['exception_with_new_line', 'psr3'],
+        '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' => Common\Logger\LoggerFactory::class,
-            'Logger_Access' => Common\Logger\LoggerFactory::class,
+            'Logger_Shlink' => [DiContainerLoggerFactory::class, 'Shlink'],
+            'Logger_Access' => [DiContainerLoggerFactory::class, 'Access'],
         ],
         'aliases' => [
             'logger' => 'Logger_Shlink',
@@ -70,10 +78,11 @@ return [
         ],
     ],
 
-    'zend-expressive-swoole' => [
+    'mezzio-swoole' => [
         'swoole-http-server' => [
             'logger' => [
                 'logger-name' => 'Logger_Access',
+                'format' => '%h %l %u "%r" %>s %b',
             ],
         ],
     ],

config/autoload/logger.local.php.dist

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Monolog\Handler\StreamHandler;
@@ -7,34 +8,28 @@ use Monolog\Logger;
 $isSwoole = extension_loaded('swoole');
 
 // For swoole, send logs to standard output
-$logger = $isSwoole ? [
-    'handlers' => [
-        'shlink_rotating_handler' => [
-            'level' => Logger::EMERGENCY, // This basically disables regular file logs
-        ],
-        'shlink_stdout_handler' => [
-            'class' => StreamHandler::class,
+$handler = $isSwoole
+    ? [
+        'name' => StreamHandler::class,
+        'params' => [
             'level' => Logger::DEBUG,
             'stream' => 'php://stdout',
-            'formatter' => 'dashed',
         ],
-    ],
-
-    'loggers' => [
-        'Shlink' => [
-            'handlers' => ['shlink_stdout_handler'],
-        ],
-    ],
-] : [
-    'handlers' => [
-        'shlink_rotating_handler' => [
+    ]
+    : [
+        'params' => [
             'level' => Logger::DEBUG,
         ],
-    ],
-];
+    ];
 
 return [
 
-    'logger' => $logger,
+    'logger' => [
+        'Shlink' => [
+            'handlers' => [
+                'shlink_handler' => $handler,
+            ],
+        ],
+    ],
 
 ];

config/autoload/mercure.global.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\Proxy\LazyServiceFactory;
+use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
+use Symfony\Component\Mercure\Publisher;
+use Symfony\Component\Mercure\PublisherInterface;
+
+return [
+
+    'mercure' => [
+        'public_hub_url' => null,
+        'internal_hub_url' => null,
+        'jwt_secret' => null,
+        'jwt_issuer' => 'Shlink',
+    ],
+
+    'dependencies' => [
+        'delegators' => [
+            LcobucciJwtProvider::class => [
+                LazyServiceFactory::class,
+            ],
+            Publisher::class => [
+                LazyServiceFactory::class,
+            ],
+        ],
+        'lazy_services' => [
+            'class_map' => [
+                LcobucciJwtProvider::class => LcobucciJwtProvider::class,
+                Publisher::class => PublisherInterface::class,
+            ],
+        ],
+    ],
+
+];

config/autoload/mercure.local.php.dist

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'mercure' => [
+        'public_hub_url' => 'http://localhost:8001',
+        'internal_hub_url' => 'http://shlink_mercure_proxy',
+        'jwt_secret' => 'mercure_jwt_key',
+    ],
+
+];

config/autoload/middleware-pipeline.global.php

@@ -4,53 +4,70 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Zend\Expressive;
-use Zend\Stratigility\Middleware\ErrorHandler;
+use Laminas\Stratigility\Middleware\ErrorHandler;
+use Mezzio\Helper;
+use Mezzio\ProblemDetails;
+use Mezzio\Router;
+use PhpMiddleware\RequestId\RequestIdMiddleware;
 
 return [
 
     'middleware_pipeline' => [
-        'pre-routing' => [
+        'error-handler' => [
             'middleware' => [
+                Helper\ContentLengthMiddleware::class,
                 ErrorHandler::class,
-                Expressive\Helper\ContentLengthMiddleware::class,
-                Common\Middleware\CloseDbConnectionMiddleware::class,
             ],
-            'priority' => 12,
         ],
-        'pre-routing-rest' => [
+        'error-handler-rest' => [
             'path' => '/rest',
             'middleware' => [
-                Rest\Middleware\PathVersionMiddleware::class,
-                Rest\Middleware\ShortUrl\ShortCodePathMiddleware::class,
+                Rest\Middleware\CrossDomainMiddleware::class,
+                RequestIdMiddleware::class,
+                ProblemDetails\ProblemDetailsMiddleware::class,
+            ],
+        ],
+
+        'pre-routing' => [
+            'middleware' => [
+                Common\Middleware\CloseDbConnectionMiddleware::class,
             ],
-            'priority' => 11,
         ],
 
         'routing' => [
             'middleware' => [
-                Expressive\Router\Middleware\RouteMiddleware::class,
+                Router\Middleware\RouteMiddleware::class,
+                Router\Middleware\ImplicitHeadMiddleware::class,
             ],
-            'priority' => 10,
         ],
 
         'rest' => [
             'path' => '/rest',
             'middleware' => [
-                Rest\Middleware\CrossDomainMiddleware::class,
-                Expressive\Router\Middleware\ImplicitOptionsMiddleware::class,
+                Router\Middleware\ImplicitOptionsMiddleware::class,
                 Rest\Middleware\BodyParserMiddleware::class,
                 Rest\Middleware\AuthenticationMiddleware::class,
             ],
-            'priority' => 5,
         ],
 
-        'post-routing' => [
+        'dispatch' => [
             'middleware' => [
-                Expressive\Router\Middleware\DispatchMiddleware::class,
-                Core\Response\NotFoundHandler::class,
+                Router\Middleware\DispatchMiddleware::class,
+            ],
+        ],
+
+        'not-found-rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                ProblemDetails\ProblemDetailsNotFoundHandler::class,
+            ],
+        ],
+        'not-found' => [
+            'middleware' => [
+                Core\ErrorHandler\NotFoundRedirectHandler::class,
+                Core\ErrorHandler\NotFoundTemplateHandler::class,
             ],
-            'priority' => 1,
         ],
     ],
+
 ];

config/autoload/preview-generation.global.php

@@ -1,12 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-/* @deprecated */
-return [
-
-    'preview_generation' => [
-        'files_location' => 'data/cache',
-    ],
-
-];

config/autoload/redirects.global.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 return [
 
     'not_found_redirects' => [
-        'invalid_short_url' => null, // Formerly url_shortener.not_found_short_url.redirect_to
+        'invalid_short_url' => null,
         'regular_404' => null,
         'base_url' => null,
     ],

config/autoload/redis.local.php.local

@@ -1,13 +1,16 @@
 <?php
+
 declare(strict_types=1);
 
 return [
 
-    'redis' => [
-        'servers' => 'tcp://shlink_redis:6379',
-//        'servers' => [
-//            'tcp://shlink_redis:6379',
-//        ],
+    'cache' => [
+        'redis' => [
+            'servers' => 'tcp://shlink_redis:6379',
+//            'servers' => [
+//                'tcp://shlink_redis:6379',
+//            ],
+        ],
     ],
 
     'dependencies' => [

config/autoload/request_id.global.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use PhpMiddleware\RequestId;
+
+return [
+
+    'request_id' => [
+        'allow_override' => true,
+        'header_name' => 'X-Request-Id',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class => InvokableFactory::class,
+            RequestId\RequestIdProviderFactory::class => ConfigAbstractFactory::class,
+            RequestId\RequestIdMiddleware::class => ConfigAbstractFactory::class,
+            RequestId\MonologProcessor::class => ConfigAbstractFactory::class,
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        RequestId\RequestIdProviderFactory::class => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class,
+            'config.request_id.allow_override',
+            'config.request_id.header_name',
+        ],
+        RequestId\RequestIdMiddleware::class => [
+            RequestId\RequestIdProviderFactory::class,
+            'config.request_id.header_name',
+        ],
+        RequestId\MonologProcessor::class => [RequestId\RequestIdMiddleware::class],
+    ],
+
+];

config/autoload/router.global.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Zend\Expressive\Router\FastRouteRouter;
+use Mezzio\Router\FastRouteRouter;
 
 return [
 

config/autoload/router.local.php.dist

@@ -1,9 +1,13 @@
 <?php
-use Zend\Expressive\Router\FastRouteRouter;
+
+declare(strict_types=1);
+
+use Mezzio\Router\FastRouteRouter;
 
 return [
 
     'router' => [
+//        'base_path' => '',
         'fastroute' => [
             FastRouteRouter::CONFIG_CACHE_ENABLED => false,
         ],

config/autoload/swoole.global.php

@@ -4,8 +4,9 @@ declare(strict_types=1);
 
 return [
 
-    'zend-expressive-swoole' => [
-        'enable_coroutine' => true,
+    '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',

config/autoload/swoole.local.php.dist

@@ -1,21 +1,13 @@
 <?php
-declare(strict_types=1);
 
-use Zend\Expressive\Swoole\HotCodeReload\FileWatcher\InotifyFileWatcher;
-use Zend\ServiceManager\Factory\InvokableFactory;
+declare(strict_types=1);
 
 return [
 
-    'zend-expressive-swoole' => [
+    'mezzio-swoole' => [
         'hot-code-reload' => [
             'enable' => true,
         ],
     ],
 
-    'dependencies' => [
-        'factories' => [
-            InotifyFileWatcher::class => InvokableFactory::class,
-        ],
-    ],
-
 ];

config/autoload/url-shortener.global.php

@@ -2,16 +2,23 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Common\env;
+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;
 
 return [
 
     'url_shortener' => [
         'domain' => [
-            'schema' => env('SHORTENED_URL_SCHEMA', 'http'),
-            'hostname' => env('SHORTENED_URL_HOSTNAME'),
+            'schema' => 'https',
+            'hostname' => '',
         ],
-        'validate_url' => true,
+        '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

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'url_shortener' => [
+        'domain' => [
+            'schema' => 'http',
+            'hostname' => 'localhost:8080',
+        ],
+    ],
+
+];

config/autoload/wkhtmltopdf.global.php

@@ -1,14 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-return [
-
-    'wkhtmltopdf' => [
-        'images' => [
-            'binary' => __DIR__ . '/../../bin/wkhtmltoimage',
-            'type' => 'jpg',
-        ],
-    ],
-
-];

config/cli-config.php

@@ -5,10 +5,9 @@ declare(strict_types=1);
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\Console\ConsoleRunner;
 use Psr\Container\ContainerInterface;
-use Zend\ServiceManager\ServiceManager;
 
 return (function () {
-    /** @var ContainerInterface|ServiceManager $container */
+    /** @var ContainerInterface $container */
     $container = include __DIR__ . '/container.php';
     $em = $container->get(EntityManager::class);
 

config/config.php

@@ -4,30 +4,33 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Acelaya\ExpressiveErrorHandler;
-use Zend\ConfigAggregator;
-use Zend\Expressive;
+use Laminas\ConfigAggregator;
+use Laminas\Diactoros;
+use Mezzio;
+use Mezzio\ProblemDetails;
 
 use function Shlinkio\Shlink\Common\env;
 
 return (new ConfigAggregator\ConfigAggregator([
-    Expressive\ConfigProvider::class,
-    Expressive\Router\ConfigProvider::class,
-    Expressive\Router\FastRouteRouter\ConfigProvider::class,
-    Expressive\Plates\ConfigProvider::class,
-    Expressive\Swoole\ConfigProvider::class,
-    ExpressiveErrorHandler\ConfigProvider::class,
+    Mezzio\ConfigProvider::class,
+    Mezzio\Router\ConfigProvider::class,
+    Mezzio\Router\FastRouteRouter\ConfigProvider::class,
+    Mezzio\Plates\ConfigProvider::class,
+    Mezzio\Swoole\ConfigProvider::class,
+    ProblemDetails\ConfigProvider::class,
+    Diactoros\ConfigProvider::class,
     Common\ConfigProvider::class,
+    Config\ConfigProvider::class,
+    Importer\ConfigProvider::class,
     IpGeolocation\ConfigProvider::class,
+    EventDispatcher\ConfigProvider::class,
     Core\ConfigProvider::class,
     CLI\ConfigProvider::class,
     Rest\ConfigProvider::class,
-    EventDispatcher\ConfigProvider::class,
-    PreviewGenerator\ConfigProvider::class,
     new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
     env('APP_ENV') === 'test'
         ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
-        : new ConfigAggregator\ZendConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
+        : new ConfigAggregator\LaminasConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
 ], 'data/cache/app_config.php', [
     Core\Config\SimplifiedConfigParser::class,
     Core\Config\BasePathPrefixer::class,

config/container.php

@@ -2,23 +2,26 @@
 
 declare(strict_types=1);
 
-use Symfony\Component\Dotenv\Dotenv;
-use Zend\ServiceManager\ServiceManager;
+use Laminas\ServiceManager\ServiceManager;
+use Symfony\Component\Lock;
+
+use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
 
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
-// If the Dotenv class exists, load env vars and enable errors
-if (class_exists(Dotenv::class)) {
-    error_reporting(E_ALL);
-    ini_set('display_errors', '1');
-    $dotenv = new Dotenv();
-    $dotenv->load(__DIR__ . '/../.env');
+// This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
+// It needs to be placed here as individual config files will not be loaded once config is cached
+if (! class_exists(LOCAL_LOCK_FACTORY)) {
+    class_alias(Lock\LockFactory::class, LOCAL_LOCK_FACTORY);
 }
 
 // Build container
-$config = require __DIR__ . '/config.php';
-$container = new ServiceManager($config['dependencies']);
-$container->setService('config', $config);
-return $container;
+return (function () {
+    $config = require __DIR__ . '/config.php';
+    $container = new ServiceManager($config['dependencies']);
+    $container->setService('config', $config);
+
+    return $container;
+})();

config/run.php

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

config/test/bootstrap_api_tests.php

@@ -7,22 +7,28 @@ namespace Shlinkio\Shlink\TestUtils;
 use Doctrine\ORM\EntityManager;
 use Psr\Container\ContainerInterface;
 
-use function file_exists;
-use function touch;
+use function register_shutdown_function;
+use function sprintf;
 
-// Create an empty .env file
-if (! file_exists('.env')) {
-    touch('.env');
-}
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
 
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
 $testHelper = $container->get(Helper\TestHelper::class);
 $config = $container->get('config');
 $em = $container->get(EntityManager::class);
+$httpClient = $container->get('shlink_test_api_client');
+
+// Start code coverage collecting on swoole process, and stop it 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),
+    );
+});
 
 $testHelper->createTestDb();
-ApiTest\ApiTestCase::setApiClient($container->get('shlink_test_api_client'));
-ApiTest\ApiTestCase::setSeedFixturesCallback(function () use ($testHelper, $em, $config) {
-    $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []);
-});
+ApiTest\ApiTestCase::setApiClient($httpClient);
+ApiTest\ApiTestCase::setSeedFixturesCallback(fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []));

config/test/bootstrap_db_tests.php

@@ -6,14 +6,6 @@ namespace Shlinkio\Shlink\TestUtils;
 
 use Psr\Container\ContainerInterface;
 
-use function file_exists;
-use function touch;
-
-// Create an empty .env file
-if (! file_exists('.env')) {
-    touch('.env');
-}
-
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
 $container->get(Helper\TestHelper::class)->createTestDb();

config/test/constants.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink;
+
+const SWOOLE_TESTING_HOST = '127.0.0.1';
+const SWOOLE_TESTING_PORT = 9999;

config/test/test_config.global.php

@@ -5,23 +5,40 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use GuzzleHttp\Client;
+use Laminas\ConfigAggregator\ConfigAggregator;
+use Laminas\Diactoros\Response\EmptyResponse;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Laminas\Stdlib\Glob;
 use PDO;
-use Zend\ConfigAggregator\ConfigAggregator;
-use Zend\ServiceManager\Factory\InvokableFactory;
+use PHPUnit\Runner\Version;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Driver\Selector;
+use SebastianBergmann\CodeCoverage\Filter;
+use SebastianBergmann\CodeCoverage\Report\PHP;
+use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;
 
+use function Laminas\Stratigility\middleware;
 use function Shlinkio\Shlink\Common\env;
 use function sprintf;
 use function sys_get_temp_dir;
 
-$swooleTestingHost = '127.0.0.1';
-$swooleTestingPort = 9999;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
+
+$isApiTest = env('TEST_ENV') === 'api';
+if ($isApiTest) {
+    $filter = new Filter();
+    foreach (Glob::glob(__DIR__ . '/../../module/*/src') as $item) {
+        $filter->includeDirectory($item);
+    }
+    $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
+}
 
 $buildDbConnection = function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
     $isCi = env('TRAVIS', false);
-    $getMysqlHost = function (string $driver) {
-        return sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
-    };
+    $getMysqlHost = fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
+    $getCiMysqlPort = fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
 
     $driverConfigMap = [
         'sqlite' => [
@@ -31,22 +48,32 @@ $buildDbConnection = function (): array {
         'mysql' => [
             'driver' => 'pdo_mysql',
             'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
+            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
             'user' => 'root',
-            'password' => $isCi ? '' : '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',
             'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
+            'port' => $isCi ? '5433' : '5432',
             'user' => 'postgres',
-            'password' => $isCi ? '' : 'root',
+            'password' => 'root',
             'dbname' => 'shlink_test',
             'charset' => 'utf8',
         ],
+        'mssql' => [
+            'driver' => 'pdo_sqlsrv',
+            'host' => $isCi ? '127.0.0.1' : 'shlink_db_ms',
+            'user' => 'sa',
+            'password' => 'Passw0rd!',
+            'dbname' => 'shlink_test',
+        ],
     ];
     $driverConfigMap['maria'] = $driverConfigMap['mysql'];
 
@@ -63,27 +90,61 @@ return [
             'schema' => 'http',
             'hostname' => 'doma.in',
         ],
+        'validate_url' => true,
     ],
 
-    'zend-expressive-swoole' => [
+    'mezzio-swoole' => [
         'enable_coroutine' => false,
         'swoole-http-server' => [
-            'host' => $swooleTestingHost,
-            'port' => $swooleTestingPort,
+            'host' => SWOOLE_TESTING_HOST,
+            'port' => SWOOLE_TESTING_PORT,
             'process-name' => 'shlink_test',
             'options' => [
                 'pid_file' => sys_get_temp_dir() . '/shlink-test-swoole.pid',
-                'worker_num' => 1,
-                'task_worker_num' => 1,
                 'enable_coroutine' => false,
             ],
         ],
     ],
 
+    'routes' => !$isApiTest ? [] : [
+        [
+            'name' => 'start_collecting_coverage',
+            'path' => '/api-tests/start-coverage',
+            'middleware' => middleware(static function () use (&$coverage) {
+                if ($coverage) {
+                    $coverage->start('API tests');
+                }
+                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();
+            }),
+            'allowed_methods' => ['GET'],
+        ],
+    ],
+
+    'mercure' => [
+        'public_hub_url' => null,
+        'internal_hub_url' => null,
+        'jwt_secret' => null,
+    ],
+
     'dependencies' => [
         'services' => [
             'shlink_test_api_client' => new Client([
-                'base_uri' => sprintf('http://%s:%s/', $swooleTestingHost, $swooleTestingPort),
+                'base_uri' => sprintf('http://%s:%s/', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT),
                 'http_errors' => false,
             ]),
         ],

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

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

data/infra/examples/nginx-vhost.conf

@@ -11,7 +11,7 @@ server {
 
     location ~ \.php$ {
         fastcgi_split_path_info ^(.+\.php)(/.+)$;
-        fastcgi_pass unix:/var/run/php/php7.2-fpm.sock;
+        fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
         fastcgi_index index.php;
         include fastcgi.conf;
     }

data/infra/examples/shlink-daemon.sh

@@ -8,7 +8,7 @@
 # Description:       Shlink non-blocking server with swoole
 ### END INIT INFO
 
-SCRIPT=/path/to/shlink/vendor/bin/zend-expressive-swoole\ start
+SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
 RUNAS=root
 
 PIDFILE=/var/run/shlink_swoole.pid

data/infra/mercure_proxy_vhost.conf

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

data/infra/php.Dockerfile

@@ -1,18 +1,19 @@
-FROM php:7.3.11-fpm-alpine3.10
+FROM php:7.4.11-alpine3.12
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.18
 ENV APCU_BC_VERSION 1.0.5
-ENV XDEBUG_VERSION 2.8.0
 
 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 mbstring
 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
@@ -29,6 +30,9 @@ 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 docker-php-ext-install gmp
+
 # 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\
@@ -53,20 +57,17 @@ RUN rm /tmp/apcu_bc.tar.gz
 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 xdebug
-ADD https://pecl.php.net/get/xdebug-$XDEBUG_VERSION /tmp/xdebug.tar.gz
-RUN mkdir -p /usr/src/php/ext/xdebug\
-  && tar xf /tmp/xdebug.tar.gz -C /usr/src/php/ext/xdebug --strip-components=1
-# configure and install
-RUN docker-php-ext-configure xdebug\
-  && docker-php-ext-install xdebug
-# cleanup
-RUN rm /tmp/xdebug.tar.gz
+# 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 && \
+    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install pdo_sqlsrv pcov && \
+    docker-php-ext-enable pdo_sqlsrv pcov && \
+    apk del .phpize-deps && \
+    rm msodbcsql17_17.5.1.1-1_amd64.apk
 
 # Install composer
-RUN php -r "readfile('https://getcomposer.org/installer');" | php
-RUN chmod +x composer.phar
-RUN mv composer.phar /usr/local/bin/composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
 
 # Make home directory writable by anyone
 RUN chmod 777 /home

data/infra/php.ini

@@ -1 +1,8 @@
-date.timezone = Europe/Madrid
+display_errors=On
+error_reporting=-1
+memory_limit=-1
+log_errors_max_len=0
+zend.assertions=1
+assert.exception=1
+pcov.enabled=1
+pcov.directory=module

data/infra/swoole.Dockerfile

@@ -1,19 +1,21 @@
-FROM php:7.3.11-alpine3.10
+FROM php:7.4.11-alpine3.12
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.18
 ENV APCU_BC_VERSION 1.0.5
 ENV INOTIFY_VERSION 2.0.0
-ENV SWOOLE_VERSION 4.4.12
+ENV SWOOLE_VERSION 4.5.5
 
 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 mbstring
 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
@@ -30,6 +32,9 @@ 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 docker-php-ext-install gmp
+
 # 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\
@@ -64,17 +69,17 @@ RUN docker-php-ext-configure inotify\
 # cleanup
 RUN rm /tmp/inotify.tar.gz
 
-# Install swoole
-# First line fixes an error when installing pecl extensions. Found in https://github.com/docker-library/php/issues/233
-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 swoole, 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 && \
+    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install swoole-${SWOOLE_VERSION} pdo_sqlsrv pcov && \
+    docker-php-ext-enable swoole pdo_sqlsrv pcov && \
+    apk del .phpize-deps && \
+    rm msodbcsql17_17.5.1.1-1_amd64.apk
 
 # Install composer
-RUN php -r "readfile('https://getcomposer.org/installer');" | php
-RUN chmod +x composer.phar
-RUN mv composer.phar /usr/local/bin/composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
 
 # Make home directory writable by anyone
 RUN chmod 777 /home
@@ -90,4 +95,4 @@ CMD \
     if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
     # When restarting the container, swoole 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/zend-expressive-swoole start; do sleep 1 ; done
+    until php ./vendor/bin/mezzio-swoole start; do sleep 1 ; done

data/infra/swoole_proxy_vhost.conf

@@ -0,0 +1,14 @@
+server {
+    listen 80 default_server;
+
+    error_log /home/shlink/www/data/infra/nginx/swoole_proxy.error.log;
+
+    location / {
+        proxy_http_version 1.1;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_pass http://shlink_swoole:8080;
+        proxy_read_timeout 90s;
+    }
+}

data/migrations/Version20160820191203.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 namespace ShlinkMigrations;
 
 use Doctrine\DBAL\Schema\Schema;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
 /**
@@ -30,12 +30,12 @@ class Version20160820191203 extends AbstractMigration
     private function createTagsTable(Schema $schema): void
     {
         $table = $schema->createTable('tags');
-        $table->addColumn('id', Type::BIGINT, [
+        $table->addColumn('id', Types::BIGINT, [
             'unsigned' => true,
             'autoincrement' => true,
             'notnull' => true,
         ]);
-        $table->addColumn('name', Type::STRING, [
+        $table->addColumn('name', Types::STRING, [
             'length' => 255,
             'notnull' => true,
         ]);
@@ -47,11 +47,11 @@ class Version20160820191203 extends AbstractMigration
     private function createShortUrlsInTagsTable(Schema $schema): void
     {
         $table = $schema->createTable('short_urls_in_tags');
-        $table->addColumn('short_url_id', Type::BIGINT, [
+        $table->addColumn('short_url_id', Types::BIGINT, [
             'unsigned' => true,
             'notnull' => true,
         ]);
-        $table->addColumn('tag_id', Type::BIGINT, [
+        $table->addColumn('tag_id', Types::BIGINT, [
             'unsigned' => true,
             'notnull' => true,
         ]);

data/migrations/Version20171021093246.php

@@ -6,7 +6,7 @@ namespace ShlinkMigrations;
 
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
 /**
@@ -24,10 +24,10 @@ class Version20171021093246 extends AbstractMigration
             return;
         }
 
-        $shortUrls->addColumn('valid_since', Type::DATETIME, [
+        $shortUrls->addColumn('valid_since', Types::DATETIME_MUTABLE, [
             'notnull' => false,
         ]);
-        $shortUrls->addColumn('valid_until', Type::DATETIME, [
+        $shortUrls->addColumn('valid_until', Types::DATETIME_MUTABLE, [
             'notnull' => false,
         ]);
     }

data/migrations/Version20171022064541.php

@@ -6,7 +6,7 @@ namespace ShlinkMigrations;
 
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
 /**
@@ -24,7 +24,7 @@ class Version20171022064541 extends AbstractMigration
             return;
         }
 
-        $shortUrls->addColumn('max_visits', Type::INTEGER, [
+        $shortUrls->addColumn('max_visits', Types::INTEGER, [
             'unsigned' => true,
             'notnull' => false,
         ]);

data/migrations/Version20180801183328.php

@@ -17,7 +17,6 @@ final class Version20180801183328 extends AbstractMigration
     private const OLD_SIZE = 10;
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
     public function up(Schema $schema): void
@@ -26,7 +25,6 @@ final class Version20180801183328 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
     public function down(Schema $schema): void
@@ -35,8 +33,6 @@ final class Version20180801183328 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
-     * @param int $size
      * @throws SchemaException
      */
     private function setSize(Schema $schema, int $size): void

data/migrations/Version20180913205455.php

@@ -17,7 +17,6 @@ use Shlinkio\Shlink\Common\Util\IpAddress;
 final class Version20180913205455 extends AbstractMigration
 {
     /**
-     * @param Schema $schema
      */
     public function up(Schema $schema): void
     {
@@ -25,7 +24,6 @@ final class Version20180913205455 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
      * @throws DBALException
      */
     public function postUp(Schema $schema): void
@@ -67,7 +65,6 @@ final class Version20180913205455 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
      */
     public function down(Schema $schema): void
     {

data/migrations/Version20180915110857.php

@@ -19,7 +19,6 @@ final class Version20180915110857 extends AbstractMigration
     ];
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
     public function up(Schema $schema): void
@@ -39,7 +38,7 @@ final class Version20180915110857 extends AbstractMigration
                 [
                     'onDelete' => self::ON_DELETE_MAP[$foreignTable],
                     'onUpdate' => 'RESTRICT',
-                ]
+                ],
             );
         }
     }

data/migrations/Version20181020060559.php

@@ -8,7 +8,7 @@ use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Schema\Table;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
 /**
@@ -24,7 +24,6 @@ final class Version20181020060559 extends AbstractMigration
     ];
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
     public function up(Schema $schema): void
@@ -36,7 +35,7 @@ final class Version20181020060559 extends AbstractMigration
     {
         foreach ($columnNames as $name) {
             if (! $visitLocations->hasColumn($name)) {
-                $visitLocations->addColumn($name, Type::STRING, ['notnull' => false]);
+                $visitLocations->addColumn($name, Types::STRING, ['notnull' => false]);
             }
         }
     }

data/migrations/Version20190930165521.php

@@ -6,7 +6,7 @@ namespace ShlinkMigrations;
 
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
-use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
 final class Version20190930165521 extends AbstractMigration
@@ -22,19 +22,19 @@ final class Version20190930165521 extends AbstractMigration
         }
 
         $domains = $schema->createTable('domains');
-        $domains->addColumn('id', Type::BIGINT, [
+        $domains->addColumn('id', Types::BIGINT, [
             'unsigned' => true,
             'autoincrement' => true,
             'notnull' => true,
         ]);
-        $domains->addColumn('authority', Type::STRING, [
+        $domains->addColumn('authority', Types::STRING, [
             'length' => 512,
             'notnull' => true,
         ]);
         $domains->addUniqueIndex(['authority']);
         $domains->setPrimaryKey(['id']);
 
-        $shortUrls->addColumn('domain_id', Type::BIGINT, [
+        $shortUrls->addColumn('domain_id', Types::BIGINT, [
             'unsigned' => true,
             'notnull' => false,
         ]);

data/migrations/Version20200105165647.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+use function Functional\some;
+
+final class Version20200105165647 extends AbstractMigration
+{
+    private const COLUMNS = ['lat' => 'latitude', 'lon' => 'longitude'];
+
+    /**
+     * @throws DBALException
+     */
+    public function preUp(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(some(
+            self::COLUMNS,
+            fn (string $v, string $newColName) => $visitLocations->hasColumn($newColName),
+        ), 'New columns already exist');
+
+        foreach (self::COLUMNS as $columnName) {
+            $qb = $this->connection->createQueryBuilder();
+            $qb->update('visit_locations')
+               ->set($columnName, ':zeroValue')
+               ->where($qb->expr()->orX(
+                   $qb->expr()->eq($columnName, ':emptyString'),
+                   $qb->expr()->isNull($columnName),
+               ))
+               ->setParameters([
+                   'zeroValue' => '0',
+                   'emptyString' => '',
+               ])
+               ->execute();
+        }
+    }
+
+    /**
+     * @throws DBALException
+     */
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        foreach (self::COLUMNS as $newName => $oldName) {
+            $visitLocations->addColumn($newName, Types::FLOAT, [
+                'default' => '0.0',
+            ]);
+        }
+    }
+
+    /**
+     * @throws DBALException
+     */
+    public function postUp(Schema $schema): void
+    {
+        $platformName = $this->connection->getDatabasePlatform()->getName();
+        $castType = $platformName === 'postgres' ? 'DOUBLE PRECISION' : 'DECIMAL(9,2)';
+
+        foreach (self::COLUMNS as $newName => $oldName) {
+            $qb = $this->connection->createQueryBuilder();
+            $qb->update('visit_locations')
+               ->set($newName, 'CAST(' . $oldName . ' AS ' . $castType . ')')
+               ->execute();
+        }
+    }
+
+    public function preDown(Schema $schema): void
+    {
+        foreach (self::COLUMNS as $newName => $oldName) {
+            $qb = $this->connection->createQueryBuilder();
+            $qb->update('visit_locations')
+               ->set($oldName, $newName)
+               ->execute();
+        }
+    }
+
+    /**
+     * @throws DBALException
+     */
+    public function down(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        foreach (self::COLUMNS as $colName => $oldName) {
+            $visitLocations->dropColumn($colName);
+        }
+    }
+}

data/migrations/Version20200106215144.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+use function Functional\none;
+
+final class Version20200106215144 extends AbstractMigration
+{
+    private const COLUMNS = ['latitude', 'longitude'];
+
+    /**
+     * @throws DBALException
+     */
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(none(
+            self::COLUMNS,
+            fn (string $oldColName) => $visitLocations->hasColumn($oldColName),
+        ), 'Old columns do not exist');
+
+        foreach (self::COLUMNS as $colName) {
+            $visitLocations->dropColumn($colName);
+        }
+    }
+
+    /**
+     * @throws DBALException
+     */
+    public function down(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        foreach (self::COLUMNS as $colName) {
+            $visitLocations->addColumn($colName, Types::STRING, [
+                'notnull' => false,
+            ]);
+        }
+    }
+}

data/migrations/Version20200110182849.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+use function Functional\each;
+use function Functional\partial_left;
+
+final class Version20200110182849 extends AbstractMigration
+{
+    private const DEFAULT_EMPTY_VALUE = '';
+    private const COLUMN_DEFAULTS_MAP = [
+        'visits' => [
+            'referer',
+            'user_agent',
+        ],
+        'visit_locations' => [
+            'timezone',
+            'country_code',
+            'country_name',
+            'region_name',
+            'city_name',
+        ],
+    ];
+
+    public function up(Schema $schema): void
+    {
+        each(
+            self::COLUMN_DEFAULTS_MAP,
+            fn (array $columns, string $tableName) =>
+                each($columns, partial_left([$this, 'setDefaultValueForColumnInTable'], $tableName)),
+        );
+    }
+
+    public function setDefaultValueForColumnInTable(string $tableName, string $columnName): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update($tableName)
+           ->set($columnName, ':emptyValue')
+           ->setParameter('emptyValue', self::DEFAULT_EMPTY_VALUE)
+           ->where($qb->expr()->isNull($columnName))
+           ->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No need (and no way) to undo this migration
+    }
+}

data/migrations/Version20200323190014.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20200323190014 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf($visitLocations->hasColumn('is_empty'));
+
+        $visitLocations->addColumn('is_empty', Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function postUp(Schema $schema): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visit_locations')
+           ->set('is_empty', ':isEmpty')
+           ->where($qb->expr()->eq('country_code', ':emptyString'))
+           ->andWhere($qb->expr()->eq('country_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('region_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('city_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('timezone', ':emptyString'))
+           ->andWhere($qb->expr()->eq('lat', 0))
+           ->andWhere($qb->expr()->eq('lon', 0))
+           ->setParameter('isEmpty', true)
+           ->setParameter('emptyString', '')
+           ->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(!$visitLocations->hasColumn('is_empty'));
+
+        $visitLocations->dropColumn('is_empty');
+    }
+}

data/migrations/Version20200503170404.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20200503170404 extends AbstractMigration
+{
+    private const INDEX_NAME = 'IDX_visits_date';
+
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf($visits->hasIndex(self::INDEX_NAME));
+        $visits->addIndex(['date'], self::INDEX_NAME);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf(! $visits->hasIndex(self::INDEX_NAME));
+        $visits->dropIndex(self::INDEX_NAME);
+    }
+}

data/migrations/Version20201023090929.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20201023090929 extends AbstractMigration
+{
+    private const IMPORT_SOURCE_COLUMN = 'import_source';
+
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn(self::IMPORT_SOURCE_COLUMN));
+
+        $shortUrls->addColumn(self::IMPORT_SOURCE_COLUMN, Types::STRING, [
+            'length' => 255,
+            'notnull' => false,
+        ]);
+        $shortUrls->addColumn('import_original_short_code', Types::STRING, [
+            'length' => 255,
+            'notnull' => false,
+        ]);
+
+        $shortUrls->addUniqueIndex(
+            [self::IMPORT_SOURCE_COLUMN, 'import_original_short_code', 'domain_id'],
+            'unique_imports',
+        );
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn(self::IMPORT_SOURCE_COLUMN));
+
+        $shortUrls->dropColumn(self::IMPORT_SOURCE_COLUMN);
+        $shortUrls->dropColumn('import_original_short_code');
+        $shortUrls->dropIndex('unique_imports');
+    }
+}

data/migrations/Version20201102113208.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Cake\Chronos\Chronos;
+use Doctrine\DBAL\Driver\Result;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20201102113208 extends AbstractMigration
+{
+    private const API_KEY_COLUMN = 'author_api_key_id';
+
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn(self::API_KEY_COLUMN));
+
+        $shortUrls->addColumn(self::API_KEY_COLUMN, Types::BIGINT, [
+            'unsigned' => true,
+            'notnull' => false,
+        ]);
+
+        $shortUrls->addForeignKeyConstraint('api_keys', [self::API_KEY_COLUMN], ['id'], [
+            'onDelete' => 'SET NULL',
+            'onUpdate' => 'RESTRICT',
+        ], 'FK_' . self::API_KEY_COLUMN);
+    }
+
+    public function postUp(Schema $schema): void
+    {
+        // If there's only one API key and it's active, link all existing URLs with it
+        $qb = $this->connection->createQueryBuilder();
+        $qb->select('id')
+           ->from('api_keys')
+           ->where($qb->expr()->eq('enabled', ':enabled'))
+           ->andWhere($qb->expr()->or(
+               $qb->expr()->isNull('expiration_date'),
+               $qb->expr()->gt('expiration_date', ':expiration'),
+           ))
+           ->setParameters([
+               'enabled' => true,
+               'expiration' => Chronos::now()->toDateTimeString(),
+           ]);
+
+        /** @var Result $result */
+        $result = $qb->execute();
+        $id = $this->resolveOneApiKeyId($result);
+        if ($id === null) {
+            return;
+        }
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('short_urls')
+           ->set(self::API_KEY_COLUMN, ':apiKeyId')
+           ->setParameter('apiKeyId', $id)
+           ->execute();
+    }
+
+    private function resolveOneApiKeyId(Result $result): ?string
+    {
+        $results = [];
+        while ($row = $result->fetchAssociative()) {
+            // As soon as we have to iterate more than once, then we cannot resolve a single API key
+            if (! empty($results)) {
+                return null;
+            }
+
+            $results[] = $row['id'] ?? null;
+        }
+
+        return $results[0] ?? null;
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn(self::API_KEY_COLUMN));
+
+        $shortUrls->removeForeignKey('FK_' . self::API_KEY_COLUMN);
+        $shortUrls->dropColumn(self::API_KEY_COLUMN);
+    }
+}

data/migrations_template.txt

@@ -7,7 +7,7 @@ namespace <namespace>;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 
-final class Version<version> extends AbstractMigration
+final class <className> extends AbstractMigration
 {
     public function up(Schema $schema): void
     {

docker-compose.ci.yml

@@ -0,0 +1,14 @@
+version: '3'
+
+services:
+    shlink_db:
+        environment:
+            MYSQL_DATABASE: shlink_test
+
+    shlink_db_postgres:
+        environment:
+            POSTGRES_DB: shlink_test
+
+    shlink_db_maria:
+        environment:
+            MYSQL_DATABASE: shlink_test

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.15.9-alpine
+        image: nginx:1.17.10-alpine
         ports:
             - "8000:80"
         volumes:
@@ -25,7 +25,23 @@ services:
             - shlink_db
             - shlink_db_postgres
             - shlink_db_maria
+            - shlink_db_ms
             - shlink_redis
+            - shlink_mercure
+            - shlink_mercure_proxy
+        environment:
+            LC_ALL: C
+
+    shlink_swoole_proxy:
+        container_name: shlink_swoole_proxy
+        image: nginx:1.17.10-alpine
+        ports:
+            - "8002:80"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/swoole_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
+        links:
+            - shlink_swoole
 
     shlink_swoole:
         container_name: shlink_swoole
@@ -37,11 +53,17 @@ services:
             - "9001:9001"
         volumes:
             - ./:/home/shlink
+            - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
             - shlink_db
             - shlink_db_postgres
             - shlink_db_maria
+            - shlink_db_ms
             - shlink_redis
+            - shlink_mercure
+            - shlink_mercure_proxy
+        environment:
+            LC_ALL: C
 
     shlink_db:
         container_name: shlink_db
@@ -57,7 +79,7 @@ services:
 
     shlink_db_postgres:
         container_name: shlink_db_postgres
-        image: postgres:10.7-alpine
+        image: postgres:12.2-alpine
         ports:
             - "5433:5432"
         volumes:
@@ -70,7 +92,7 @@ services:
 
     shlink_db_maria:
         container_name: shlink_db_maria
-        image: mariadb:10.2
+        image: mariadb:10.5
         ports:
             - "3308:3306"
         volumes:
@@ -81,8 +103,38 @@ services:
             MYSQL_DATABASE: shlink
             MYSQL_INITDB_SKIP_TZINFO: 1
 
+    shlink_db_ms:
+        container_name: shlink_db_ms
+        image: mcr.microsoft.com/mssql/server:2019-latest
+        ports:
+            - "1433:1433"
+        environment:
+            ACCEPT_EULA: Y
+            SA_PASSWORD: "Passw0rd!"
+
     shlink_redis:
         container_name: shlink_redis
-        image: redis:5.0-alpine
+        image: redis:6.0-alpine
         ports:
             - "6380:6379"
+
+    shlink_mercure_proxy:
+        container_name: shlink_mercure_proxy
+        image: nginx:1.17.10-alpine
+        ports:
+            - "8001:80"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/mercure_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
+        links:
+            - shlink_mercure
+
+    shlink_mercure:
+        container_name: shlink_mercure
+        image: dunglas/mercure:v0.9
+        ports:
+            - "3080:80"
+        environment:
+            CORS_ALLOWED_ORIGINS: "*"
+            JWT_KEY: "mercure_jwt_key"
+            USE_FORWARDED_HEADERS: "1"

docker/README.md

@@ -1,6 +1,5 @@
 # Shlink Docker image
 
-[![Docker build status](https://img.shields.io/docker/cloud/build/shlinkio/shlink.svg?style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
 [![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?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.
@@ -19,7 +18,7 @@ It also expects these two env vars to be provided, in order to properly generate
 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 shlinkio/shlink
+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.
@@ -38,10 +37,10 @@ Or you can list all tags with:
 docker exec -it shlink_container shlink tag:list
 ```
 
-Or process remaining visits with:
+Or locate remaining visits with:
 
 ```bash
-docker exec -it shlink_container shlink visit:process
+docker exec -it shlink_container shlink visit:locate
 ```
 
 All shlink commands will work the same way.
@@ -56,9 +55,9 @@ docker exec -it shlink_container shlink
 
 The image comes with a working sqlite database, but in production you will probably want to usa a distributed database.
 
-It is possible to use a set of env vars to make this shlink instance interact with an external MySQL, MariaDB or PostgreSQL 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** or **postgres** to prevent the sqlite database to be used.
+* `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.
@@ -67,62 +66,12 @@ It is possible to use a set of env vars to make this shlink instance interact wi
     * 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 of this image. Do not try to use it with previous versions.
+> 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 SHORT_DOMAIN_SCHEMA=https -e DB_DRIVER=mysql -e DB_USER=root -e DB_PASSWORD=123abc -e DB_HOST=something.rds.amazonaws.com shlinkio/shlink
-```
-
-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
-```
-
-> 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.
-
-## 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** or **postgres**.
-* `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`
-* `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 (after following redirects) is returned when trying to shorten a URL. Defaults to `true`.
-* `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.
-* `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).
-
-    This is important when running more than one Shlink instance ([Multi instance considerations](#multi-instance-considerations)). If not provided, Shlink stores locks on every instance separately.
-
-    If more than one server is provided, Shlink will expect them to be configured as a [redis cluster](https://redis.io/topics/cluster-tutorial).
-
-    In the future, these redis servers could be used for other caching operations performed by shlink.
-
-* `NOT_FOUND_REDIRECT_TO`: **Deprecated since v1.20 in favor of `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.
-* `SHORTCODE_CHARS`: **Ignored when using Shlink 1.20 or newer**. A charset to use when building short codes. Only needed when using more than one shlink instance ([Multi instance considerations](#multi-instance-considerations)).
-
-An example using all env vars could look like this:
-
 ```bash
 docker run \
     --name shlink \
@@ -130,6 +79,115 @@ docker run \
     -e SHORT_DOMAIN_HOST=doma.in \
     -e SHORT_DOMAIN_SCHEMA=https \
     -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`
+* `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 \
@@ -137,7 +195,7 @@ docker run \
     -e DB_PORT=3306 \
     -e DISABLE_TRACK_PARAM="no-track" \
     -e DELETE_SHORT_URL_THRESHOLD=30 \
-    -e VALIDATE_URLS=false \
+    -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" \
@@ -145,7 +203,16 @@ docker run \
     -e "BASE_PATH=/my-campaign" \
     -e WEB_WORKER_NUM=64 \
     -e TASK_WORKER_NUM=32 \
-    shlinkio/shlink
+    -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
 ```
 
 ## Provide config via volumes
@@ -162,17 +229,22 @@ The whole configuration should have this format, but it can be split into multip
     "delete_short_url_threshold": 30,
     "short_domain_schema": "https",
     "short_domain_host": "doma.in",
-    "validate_url": false,
+    "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",
@@ -181,21 +253,32 @@ The whole configuration should have this format, but it can be split into multip
         "host": "something.rds.amazonaws.com",
         "port": "3306"
     },
-    "not_found_redirect_to": "https://my-landing-page.com"
+    "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).
 
-> The `not_found_redirect_to` option has been deprecated in v1.20. Use `invalid_short_url_redirect_to` instead (however, it will still work for backwards compatibility).
-
 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
+docker run --name shlink -p 8080:8080 -v ${PWD}/my/config/dir:/etc/shlink/config/params shlinkio/shlink:stable
 ```
 
-## Multi instance considerations
+## 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.
 
@@ -205,20 +288,12 @@ These are some considerations to take into account when running multiple instanc
 
     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.
 
-* **Ignore this if using Shlink 1.20 or newer**. The first time shlink is run, it generates a charset used to generate short codes, which is a shuffled base62 charset.
-
-    If you are using several shlink instances, you will probably want all of them to use the same charset.
-
-    You can get a shuffled base62 charset by going to [https://shlink.io/short-code-chars](https://shlink.io/short-code-chars), and then you just need to pass it to all shlink instances using the `SHORTCODE_CHARS` env var.
-
-    If you don't do this, each shlink instance will use a different charset. However this shouldn't be a problem in practice, since the chances to get a collision will be very low.
-
 ## 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 1.20.0, installing `shlinkio/shlink:stable`, you will get an image containing shlink v1.20.0
-* `latest`: always holds the latest contents in master, and it's considered unstable and not suitable for production.
+* `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

@@ -0,0 +1,25 @@
+#!/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

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

docker/config/shlink_in_docker.local.php

@@ -8,64 +8,29 @@ use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 
 use function explode;
-use function file_exists;
-use function file_get_contents;
-use function file_put_contents;
 use function Functional\contains;
-use function implode;
 use function Shlinkio\Shlink\Common\env;
-use function sprintf;
-use function str_shuffle;
-use function substr;
-use function sys_get_temp_dir;
+
+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 BASE62 = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
     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',
     ];
 
-    /** @var string */
-    private $secretKey;
-
-    public function __construct()
-    {
-        [, $this->secretKey] = $this->initShlinkSecretKey();
-    }
-
-    private function initShlinkSecretKey(): array
-    {
-        $keysFile = sprintf('%s/shlink.keys', sys_get_temp_dir());
-        if (file_exists($keysFile)) {
-            return explode(',', file_get_contents($keysFile));
-        }
-
-        $keys = [
-            '', // This was the SHORTCODE_CHARS. Kept as empty string for BC
-            env('SECRET_KEY', $this->generateSecretKey()), // Deprecated
-        ];
-
-        file_put_contents($keysFile, implode(',', $keys));
-        return $keys;
-    }
-
-    private function generateSecretKey(): string
-    {
-        return substr(str_shuffle(self::BASE62), 0, 32);
-    }
-
-    public function getSecretKey(): string
-    {
-        return $this->secretKey;
-    }
-
     public function getDbConfig(): array
     {
         $driver = env('DB_DRIVER');
@@ -79,6 +44,8 @@ $helper = new class {
         $driverOptions = ! contains(['maria', 'mysql'], $driver) ? [] : [
             // 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],
@@ -94,11 +61,40 @@ $helper = new class {
     public function getNotFoundRedirectsConfig(): array
     {
         return [
-            'invalid_short_url' => env('INVALID_SHORT_URL_REDIRECT_TO', env('NOT_FOUND_REDIRECT_TO')),
+            '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 [
@@ -106,13 +102,12 @@ return [
     'config_cache_enabled' => false,
 
     'app_options' => [
-        'secret_key' => $helper->getSecretKey(),
         'disable_track_param' => env('DISABLE_TRACK_PARAM'),
     ],
 
     'delete_short_urls' => [
         'check_visits_threshold' => true,
-        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', 15),
+        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD),
     ],
 
     'entity_manager' => [
@@ -124,27 +119,26 @@ return [
             'schema' => env('SHORT_DOMAIN_SCHEMA', 'http'),
             'hostname' => env('SHORT_DOMAIN_HOST', ''),
         ],
-        'validate_url' => (bool) env('VALIDATE_URLS', true),
+        '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' => [
-        'handlers' => [
-            'shlink_rotating_handler' => [
-                'level' => Logger::EMERGENCY, // This basically disables regular file logs
-            ],
-            'shlink_stdout_handler' => [
-                'class' => StreamHandler::class,
-                'level' => Logger::INFO,
-                'stream' => 'php://stdout',
-                'formatter' => 'dashed',
-            ],
-        ],
-
-        'loggers' => [
-            'Shlink' => [
-                'handlers' => ['shlink_stdout_handler'],
+        'Shlink' => [
+            'handlers' => [
+                'shlink_handler' => [
+                    'name' => StreamHandler::class,
+                    'params' => [
+                        'level' => Logger::INFO,
+                        'stream' => 'php://stdout',
+                    ],
+                ],
             ],
         ],
     ],
@@ -155,16 +149,17 @@ return [
         ],
     ],
 
-    'redis' => [
-        'servers' => env('REDIS_SERVERS'),
+    'cache' => [
+        'redis' => $helper->getRedisConfig(),
     ],
 
     'router' => [
         'base_path' => env('BASE_PATH', ''),
     ],
 
-    'zend-expressive-swoole' => [
+    '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),
@@ -172,4 +167,10 @@ return [
         ],
     ],
 
+    'geolite2' => [
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
+    ],
+
+    'mercure' => $helper->getMercureConfig(),
+
 ];

docker/docker-entrypoint.sh

@@ -12,6 +12,9 @@ php bin/cli db:migrate -n -q
 echo "Generating proxies..."
 php vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies -n -q
 
+echo "Clearing entities cache..."
+php vendor/doctrine/orm/bin/doctrine.php orm:clear-cache:metadata -n -q
+
 # When restarting the container, swoole 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/zendframework/zend-expressive-swoole/bin/zend-expressive-swoole start; do sleep 1 ; done
+until php vendor/mezzio/mezzio-swoole/bin/mezzio-swoole start; do sleep 1 ; done

docs/async-api/async-api.json

@@ -0,0 +1,210 @@
+{
+    "asyncapi": "2.0.0",
+    "info": {
+        "title": "Shlink",
+        "version": "2.0.0",
+        "description": "Shlink, the self-hosted URL shortener",
+        "license": {
+            "name": "MIT",
+            "url": "https://github.com/shlinkio/shlink/blob/develop/LICENSE"
+        }
+    },
+    "defaultContentType": "application/json",
+    "channels": {
+        "http://shlink.io/new-visit": {
+            "subscribe": {
+                "summary": "Receive information about any new visit occurring on any short URL.",
+                "operationId": "newVisit",
+                "message": {
+                    "payload": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "shortUrl": {
+                                "$ref": "#/components/schemas/ShortUrl"
+                            },
+                            "visit": {
+                                "$ref": "#/components/schemas/Visit"
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "http://shlink.io/new-visit/{shortCode}": {
+            "parameters": {
+                "shortCode": {
+                    "description": "The short code of the short URL",
+                    "schema": {
+                        "type": "string"
+                    }
+                }
+            },
+            "subscribe": {
+                "summary": "Receive information about any new visit occurring on a specific short URL.",
+                "operationId": "newShortUrlVisit",
+                "message": {
+                    "payload": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "shortUrl": {
+                                "$ref": "#/components/schemas/ShortUrl"
+                            },
+                            "visit": {
+                                "$ref": "#/components/schemas/Visit"
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "components": {
+        "schemas": {
+            "ShortUrl": {
+                "type": "object",
+                "properties": {
+                    "shortCode": {
+                        "type": "string",
+                        "description": "The short code for this short URL."
+                    },
+                    "shortUrl": {
+                        "type": "string",
+                        "description": "The short URL."
+                    },
+                    "longUrl": {
+                        "type": "string",
+                        "description": "The original long URL."
+                    },
+                    "dateCreated": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date in which the short URL was created in ISO format."
+                    },
+                    "visitsCount": {
+                        "type": "integer",
+                        "description": "The number of visits that this short URL has recieved."
+                    },
+                    "tags": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "description": "A list of tags applied to this short URL"
+                    },
+                    "meta": {
+                        "$ref": "#/components/schemas/ShortUrlMeta"
+                    },
+                    "domain": {
+                        "type": "string",
+                        "description": "The domain in which the short URL was created. Null if it belongs to default domain."
+                    }
+                },
+                "example": {
+                    "shortCode": "12C18",
+                    "shortUrl": "https://doma.in/12C18",
+                    "longUrl": "https://store.steampowered.com",
+                    "dateCreated": "2016-08-21T20:34:16+02:00",
+                    "visitsCount": 328,
+                    "tags": [
+                        "games",
+                        "tech"
+                    ],
+                    "meta": {
+                        "validSince": "2017-01-21T00:00:00+02:00",
+                        "validUntil": null,
+                        "maxVisits": 100
+                    },
+                    "domain": "example.com"
+                }
+            },
+            "ShortUrlMeta": {
+                "type": "object",
+                "required": [
+                    "validSince",
+                    "validUntil",
+                    "maxVisits"
+                ],
+                "properties": {
+                    "validSince": {
+                        "description": "The date (in ISO-8601 format) from which this short code will be valid",
+                        "type": "string",
+                        "nullable": true
+                    },
+                    "validUntil": {
+                        "description": "The date (in ISO-8601 format) until which this short code will be valid",
+                        "type": "string",
+                        "nullable": true
+                    },
+                    "maxVisits": {
+                        "description": "The maximum number of allowed visits for this short code",
+                        "type": "number",
+                        "nullable": true
+                    }
+                }
+            },
+            "Visit": {
+                "type": "object",
+                "properties": {
+                    "referer": {
+                        "type": "string",
+                        "description": "The origin from which the visit was performed"
+                    },
+                    "date": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date in which the visit was performed"
+                    },
+                    "userAgent": {
+                        "type": "string",
+                        "description": "The user agent from which the visit was performed"
+                    },
+                    "visitLocation": {
+                        "$ref": "#/components/schemas/VisitLocation"
+                    }
+                },
+                "example": {
+                    "referer": "https://t.co",
+                    "date": "2015-08-20T05:05:03+04:00",
+                    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
+                    "visitLocation": {
+                        "cityName": "Cupertino",
+                        "countryCode": "US",
+                        "countryName": "United States",
+                        "latitude": 37.3042,
+                        "longitude": -122.0946,
+                        "regionName": "California",
+                        "timezone": "America/Los_Angeles"
+                    }
+                }
+            },
+            "VisitLocation": {
+                "type": "object",
+                "properties": {
+                    "cityName": {
+                        "type": "string"
+                    },
+                    "countryCode": {
+                        "type": "string"
+                    },
+                    "countryName": {
+                        "type": "string"
+                    },
+                    "latitude": {
+                        "type": "number"
+                    },
+                    "longitude": {
+                        "type": "number"
+                    },
+                    "regionName": {
+                        "type": "string"
+                    },
+                    "timezone": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/definitions/Error.json

@@ -1,13 +1,22 @@
 {
     "type": "object",
+    "required": ["type", "title", "detail", "status"],
     "properties": {
-        "code": {
+        "type": {
             "type": "string",
             "description": "A machine unique code"
         },
-        "message": {
+        "title": {
             "type": "string",
-            "description": "A human-friendly error message"
+            "description": "A unique title"
+        },
+        "detail": {
+            "type": "string",
+            "description": "A human-friendly error description"
+        },
+        "status": {
+            "type": "number",
+            "description": "HTTP response status code"
         }
     }
 }

docs/swagger/definitions/MercureInfo.json

@@ -0,0 +1,18 @@
+{
+    "type": "object",
+    "required": ["mercureHubUrl", "jwt", "jwtExpiration"],
+    "properties": {
+        "mercureHubUrl": {
+            "type": "string",
+            "description": "The public URL of the mercure hub that can be used to get real-time updates published by Shlink"
+        },
+        "jwt": {
+            "type": "string",
+            "description": "A JWT with subscribe permissions which is valid with the mercure hub"
+        },
+        "jwtExpiration": {
+            "type": "string",
+            "description": "The date (in ISO-8601 format) in which the JWT will expire"
+        }
+    }
+}

docs/swagger/definitions/ShortUrl.json

@@ -32,10 +32,9 @@
         "meta": {
             "$ref": "./ShortUrlMeta.json"
         },
-        "originalUrl": {
-            "deprecated": true,
+        "domain": {
             "type": "string",
-            "description": "The original long URL. [DEPRECATED. Use longUrl instead]"
+            "description": "The domain in which the short URL was created. Null if it belongs to default domain."
         }
     }
 }

docs/swagger/definitions/TagInfo.json

@@ -0,0 +1,17 @@
+{
+    "type": "object",
+    "properties": {
+        "tag": {
+            "type": "string",
+            "description": "The unique tag name"
+        },
+        "shortUrlsCount": {
+            "type": "number",
+            "description": "The amount of short URLs using this tag"
+        },
+        "userAgent": {
+            "type": "number",
+            "description": "The combined amount of visits received by short URLs with this tag"
+        }
+    }
+}

docs/swagger/definitions/Visit.json

@@ -16,11 +16,6 @@
         },
         "visitLocation": {
             "$ref": "./VisitLocation.json"
-        },
-        "remoteAddr": {
-            "type": "string",
-            "description": "This value is deprecated and will always be null",
-            "deprecated": true
         }
     }
 }