Merge pull request #567 from acelaya-forks/hotfix/v1.20.2

Hotfix/v1.20.2

.dockerignore

@@ -0,0 +1,24 @@
+config/autoload/*local*
+data/infra
+data/cache/*
+data/log/*
+data/locks/*
+data/proxies/*
+data/migrations_template.txt
+data/GeoLite2-City.*
+data/database.sqlite
+data/shlink-tests.db
+**/.gitignore
+CHANGELOG.md
+composer.lock
+vendor
+docs
+indocker
+docker-*
+php*
+infection.json
+phpstan.neon
+**/test*
+build*
+.github
+hooks

.env.dist

@@ -3,11 +3,6 @@ APP_ENV=
 SECRET_KEY=
 SHORTENED_URL_SCHEMA=
 SHORTENED_URL_HOSTNAME=
-SHORTCODE_CHARS=
-
-# Language
-DEFAULT_LOCALE=
-CLI_LOCALE=
 
 # Database
 DB_USER=

.gitattributes

@@ -1,12 +1,14 @@
+/config/test export-ignore
 /data/infra export-ignore
 /docs export-ignore
 /module/CLI/test export-ignore
 /module/CLI/test-resources export-ignore
-/module/Common/test export-ignore
-/module/Common/test-func export-ignore
 /module/Core/test export-ignore
-/module/Core/test-func 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
@@ -17,9 +19,9 @@ build.sh export-ignore
 CHANGELOG.md export-ignore
 docker-compose.override.yml.dist export-ignore
 docker-compose.yml export-ignore
-func_tests_bootstrap.php export-ignore
 indocker export-ignore
 phpcs.xml export-ignore
 phpunit.xml.dist export-ignore
-phpunit-func.xml export-ignore
+phpunit-api.xml export-ignore
+phpunit-db.xml export-ignore
 phpstan.neon

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,6 @@
+<!--
+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.
+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.
+Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
+-->

.github/ISSUE_TEMPLATE/Bug.md

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

.github/ISSUE_TEMPLATE/Feature_Request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Do you find shlink is missing some important feature that would make it more useful?
+labels: feature
+---
+
+<!--
+Before opening an issue, just take into account that this is a completely free of charge open source project.
+I'm always happy to help and provide support, but some understanding will be required.
+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.
+Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
+
+With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
+-->
+
+#### Summary
+
+<!-- Describe the new feature you would like to request. -->

.github/ISSUE_TEMPLATE/Question_Support.md

@@ -0,0 +1,25 @@
+---
+name: Question - Support
+about: Do you have a problem setting up or using shlink?
+labels: question
+---
+
+<!--
+Before opening an issue, just take into account that this is a completely free of charge open source project.
+I'm always happy to help and provide support, but some understanding will be required.
+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.
+Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
+
+With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
+-->
+
+#### How Shlink is set-up
+
+* Shlink Version: x.y.z
+* PHP Version: x.y.z
+* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
+* Database engine used: MySQL|MariaDB|PostgreSQL|SQLite (x.y.z)
+
+#### Summary
+
+<!-- Describe the issue you are facing here. -->

.gitignore

@@ -1,10 +1,14 @@
 .idea
 build
+!hooks/build
 composer.lock
 composer.phar
 vendor/
 .env
 data/database.sqlite
+data/shlink-tests.db
 data/GeoLite2-City.mmdb
-docs/swagger-ui
+data/GeoLite2-City.mmdb.*
+docs/swagger-ui*
 docker-compose.override.yml
+.phpunit.result.cache

.phpstorm.meta.php

@@ -2,7 +2,7 @@
 namespace PHPSTORM_META;
 
 use Psr\Container\ContainerInterface;
-use Zend\ServiceManager\ServiceManager;
+use Zend\ServiceManager\ServiceLocatorInterface;
 
 /**
  * PhpStorm Container Interop code completion
@@ -17,7 +17,7 @@ $STATIC_METHOD_TYPES = [
     ContainerInterface::get('') => [
         '' == '@',
     ],
-    ServiceManager::build('') => [
+    ServiceLocatorInterface::build('') => [
         '' == '@',
     ],
 ];

.scrutinizer.yml

@@ -1,5 +1,6 @@
 tools:
-  external_code_coverage: true
+  external_code_coverage:
+    timeout: 600
 checks:
   php:
     code_rating: true

.travis.yml

@@ -1,32 +1,45 @@
 language: php
 
-sudo: false # Use containerized environment
-
 branches:
   only:
     - /.*/
 
 php:
-  - 7.1
-  - 7.2
-  - 7.3
+  - '7.2'
+  - '7.3'
+  - '7.4snapshot'
 
 matrix:
   allow_failures:
-    - php: 7.3
+    - php: '7.4snapshot'
+
+services:
+  - mysql
+  - postgresql
+  - docker
+
+cache:
+  directories:
+    - $HOME/.composer/cache/files
 
 before_install:
-  - echo 'extension = memcached.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
   - echo 'extension = apcu.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
+  - yes | pecl install swoole
   - phpenv config-rm xdebug.ini || return 0
 
 install:
   - composer self-update
-  - composer install --no-interaction
+  - composer install --no-interaction --prefer-dist
+
+before_script:
+  - mysql -e 'CREATE DATABASE shlink_test;'
+  - psql -c 'create database shlink_test;' -U postgres
+  - mkdir build
+  - export DOCKERFILE_CHANGED=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/master} --name-only | grep Dockerfile)
 
 script:
-  - mkdir build
-  - composer check
+  - composer ci
+  - if [[ ! -z "$DOCKERFILE_CHANGED" && "${TRAVIS_PHP_VERSION}" == "7.2" ]]; then docker build -t shlink-docker-image:temp . ; fi
 
 after_success:
   - rm -f build/clover.xml
@@ -40,11 +53,11 @@ before_deploy:
   - ./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.1
+  - 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'

CHANGELOG.md

@@ -2,7 +2,459 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org).
+The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
+
+## 1.20.2 - 2019-12-06
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#561](https://github.com/shlinkio/shlink/issues/561) Fixed `db:migrate` command failing because yaml extension is not installed, which makes config file not to be readable.
+* [#562](https://github.com/shlinkio/shlink/issues/562) Fixed internal server error being returned when renaming a tag to another tag's name. Now a meaningful API error with status 409 is returned.
+* [#555](https://github.com/shlinkio/shlink/issues/555) Fixed internal server error being returned when invalid dates are provided for new short URLs. Now a 400 is returned, as intended.
+
+
+## 1.20.1 - 2019-11-17
+
+#### Added
+
+* [#519](https://github.com/shlinkio/shlink/issues/519) Documented how to customize web workers and task workers for the docker image.
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#512](https://github.com/shlinkio/shlink/issues/512) Fixed query params not being properly forwarded from short URL to long one.
+* [#540](https://github.com/shlinkio/shlink/issues/540) Fixed errors thrown when creating short URLs if the original URL has an internationalized domain name and URL validation is enabled.
+* [#528](https://github.com/shlinkio/shlink/issues/528) Ensured `db:create` and `db:migrate` commands do not silently fail when run as part of `install` or `update`.
+* [#518](https://github.com/shlinkio/shlink/issues/518) Fixed service which updates Geolite db file to use a local lock instead of a shared one, since every shlink instance holds its own db instance.
+
+
+## 1.20.0 - 2019-11-02
+
+#### Added
+
+* [#491](https://github.com/shlinkio/shlink/issues/491) Added improved short code generation logic.
+
+    Now, short codes are truly random, which removes the guessability factor existing in previous versions.
+
+    Generated short codes have 5 characters, and shlink makes sure they keep unique, while making it backwards-compatible.
+
+* [#418](https://github.com/shlinkio/shlink/issues/418) and [#419](https://github.com/shlinkio/shlink/issues/419) Added support to redirect any 404 error to a custom URL.
+
+    It was already possible to configure this but only for invalid short URLs. Shlink now also support configuring redirects for the base URL and any other kind of "not found" error.
+
+    The three URLs can be different, and it is already possible to pass them to the docker image via configuration or env vars.
+
+    The installer also asks for these two new configuration options.
+
+* [#497](https://github.com/shlinkio/shlink/issues/497) Officially added support for MariaDB.
+
+#### Changed
+
+* [#458](https://github.com/shlinkio/shlink/issues/458) Updated coding styles to use [shlinkio/php-coding-standard](https://github.com/shlinkio/php-coding-standard) v2.0.0.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#507](https://github.com/shlinkio/shlink/issues/507) Fixed error with too long original URLs by increasing size to the maximum value (2048) based on [the standard](https://stackoverflow.com/a/417184).
+* [#502](https://github.com/shlinkio/shlink/issues/502) Fixed error when providing the port as part of the domain on short URLs.
+* [#509](https://github.com/shlinkio/shlink/issues/509) Fixed error when trying to generate a QR code for a short URL which uses a custom domain.
+* [#522](https://github.com/shlinkio/shlink/issues/522) Highly mitigated errors thrown when lots of short URLs are created concurrently including new and existing tags.
+
+
+## 1.19.0 - 2019-10-05
+
+#### Added
+
+* [#482](https://github.com/shlinkio/shlink/issues/482) Added support to serve shlink under a sub path.
+
+    The `router.base_path` config option can be defined now to set the base path from which shlink is served.
+
+    ```php
+    return [
+        'router' => [
+            'base_path' => '/foo/bar',
+        ],
+    ];
+    ```
+
+    This option will also be available on shlink-installer 1.3.0, so the installer will ask for it. It can also be provided for the docker image as the `BASE_PATH` env var.
+
+* [#479](https://github.com/shlinkio/shlink/issues/479) Added preliminary support for multiple domains.
+
+    Endpoints and commands which create short URLs support providing the `domain` now (via query param or CLI flag). If not provided, the short URLs will still be "attached" to the default domain.
+
+    Custom slugs can be created on multiple domains, allowing to share links like `https://doma.in/my-compaign` and `https://example.com/my-campaign`, under the same shlink instance.
+
+    When resolving a short URL to redirect end users, the following rules are applied:
+
+    * If the domain used for the request plus the short code/slug are found, the user is redirected to that long URL and the visit is tracked.
+    * If the domain is not known but the short code/slug is defined for default domain, the user is redirected there and the visit is tracked.
+    * In any other case, no redirection happens and no visit is tracked (if a fall back redirection is configured for not-found URLs, it will still happen).
+
+#### Changed
+
+* [#486](https://github.com/shlinkio/shlink/issues/486) Updated to [shlink-installer](https://github.com/shlinkio/shlink-installer) v2, which supports asking for base path in which shlink is served.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* [#435](https://github.com/shlinkio/shlink/issues/435) Removed translations for error pages. All error pages are in english now.
+
+#### Fixed
+
+* *Nothing*
+
+
+## 1.18.1 - 2019-08-24
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* [#450](https://github.com/shlinkio/shlink/issues/450) Added PHP 7.4 to the build matrix, as an allowed-to-fail env.
+* [#441](https://github.com/shlinkio/shlink/issues/441) and [#443](https://github.com/shlinkio/shlink/issues/443) Split some logic into independent modules.
+* [#451](https://github.com/shlinkio/shlink/issues/451) Updated to infection 0.13.
+* [#467](https://github.com/shlinkio/shlink/issues/467) Moved docker image config to main Shlink repo.
+
+#### Deprecated
+
+* [#428](https://github.com/shlinkio/shlink/issues/428) Deprecated preview-generation feature. It will keep working but it will be removed in Shlink v2.0.0
+
+#### Removed
+
+* [#468](https://github.com/shlinkio/shlink/issues/468) Removed APCu extension from docker image.
+
+#### Fixed
+
+* [#449](https://github.com/shlinkio/shlink/issues/449) Fixed error when trying to save too big referrers on PostgreSQL.
+
+
+## 1.18.0 - 2019-08-08
+
+#### Added
+
+* [#411](https://github.com/shlinkio/shlink/issues/411) Added new `meta` property on the `ShortUrl` REST API model.
+
+    These endpoints are affected and include the new property when suitable:
+
+    * `GET /short-urls` - List short URLs.
+    * `GET /short-urls/shorten` - Create a short URL (for integrations).
+    * `GET /short-urls/{shortCode}` - Get one short URL.
+    * `POST /short-urls` - Create short URL.
+
+    The property includes the values `validSince`, `validUntil` and `maxVisits` in a single object. All of them are nullable.
+
+    ```json
+    {
+      "validSince": "2016-01-01T00:00:00+02:00",
+      "validUntil": null,
+      "maxVisits": 100
+    }
+    ```
+
+* [#285](https://github.com/shlinkio/shlink/issues/285) Visit location resolution is now done asynchronously but in real time thanks to swoole task management.
+
+    Now, when a short URL is visited, a task is enqueued to locate it. The user is immediately redirected to the long URL, and in the background, the visit is located, making stats to be available a couple of seconds after the visit without the requirement of cronjobs being run constantly.
+
+    Sadly, this feature is not enabled when serving shlink via apache/nginx, where you should still rely on cronjobs.
+
+* [#384](https://github.com/shlinkio/shlink/issues/384) Improved how remote IP addresses are detected.
+
+    This new set of headers is now also inspected looking for the IP address:
+
+    * CF-Connecting-IP
+    * True-Client-IP
+    * X-Real-IP
+
+* [#440](https://github.com/shlinkio/shlink/pull/440) Created `db:create` command, which improves how the shlink database is created, with these benefits:
+
+    * It sets up a lock which prevents the command to be run concurrently.
+    * It checks of the database does not exist, and creates it in that case.
+    * It checks if the database tables already exist, exiting gracefully in that case.
+
+* [#442](https://github.com/shlinkio/shlink/pull/442) Created `db:migrate` command, which improves doctrine's migrations command by generating a lock, preventing it to be run concurrently.
+
+#### Changed
+
+* [#430](https://github.com/shlinkio/shlink/issues/430) Updated to [shlinkio/php-coding-standard](https://github.com/shlinkio/php-coding-standard) 1.2.2
+* [#305](https://github.com/shlinkio/shlink/issues/305) Implemented changes which will allow Shlink to be truly clusterizable.
+* [#262](https://github.com/shlinkio/shlink/issues/262) Increased mutation score to 75%.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#416](https://github.com/shlinkio/shlink/issues/416) Fixed error thrown when trying to locate visits after the GeoLite2 DB is downloaded for the first time.
+* [#424](https://github.com/shlinkio/shlink/issues/424) Updated wkhtmltoimage to version 0.12.5
+* [#427](https://github.com/shlinkio/shlink/issues/427) and [#434](https://github.com/shlinkio/shlink/issues/434) Fixed shlink being unusable after a database error on swoole contexts.
+
+
+## 1.17.0 - 2019-05-13
+
+#### Added
+
+* [#377](https://github.com/shlinkio/shlink/issues/377) Updated `visit:locate` command (formerly `visit:process`) to automatically update the GeoLite2 database if it is too old or it does not exist.
+
+    This simplifies processing visits in a container-based infrastructure, since a fresh container is capable of getting an updated version of the file by itself.
+
+    It also removes the need of asynchronously and programmatically updating the file, which deprecates the `visit:update-db` command.
+
+* [#373](https://github.com/shlinkio/shlink/issues/373) Added support for a simplified config. Specially useful to use with the docker container.
+
+#### Changed
+
+* [#56](https://github.com/shlinkio/shlink/issues/56) Simplified supported cache, requiring APCu always.
+
+#### Deprecated
+
+* [#406](https://github.com/shlinkio/shlink/issues/406) Deprecated `PUT /short-urls/{shortCode}` REST endpoint in favor of `PATCH /short-urls/{shortCode}`.
+
+#### Removed
+
+* [#385](https://github.com/shlinkio/shlink/issues/385) Dropped support for PHP 7.1
+* [#379](https://github.com/shlinkio/shlink/issues/379) Removed copyright from error templates.
+
+#### Fixed
+
+* *Nothing*
+
+
+## 1.16.3 - 2019-03-30
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* [#153](https://github.com/shlinkio/shlink/issues/153) Updated to [doctrine/migrations](https://github.com/doctrine/migrations) version 2.0.0
+* [#376](https://github.com/shlinkio/shlink/issues/376) Allowed `visit:update-db` command to not return an error exit code even if download fails, by passing the `-i` flag.
+* [#341](https://github.com/shlinkio/shlink/issues/341) Improved database tests so that they are executed against all supported database engines.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#382](https://github.com/shlinkio/shlink/issues/382) Fixed existing short URLs not properly checked when providing the `findIfExists` flag.
+
+
+## 1.16.2 - 2019-03-05
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* *Nothing*
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#368](https://github.com/shlinkio/shlink/issues/368) Fixed error produced when running a `SELECT COUNT(...)` with `ORDER BY` in PostgreSQL databases.
+
+
+## 1.16.1 - 2019-02-26
+
+#### Added
+
+* *Nothing*
+
+#### Changed
+
+* [#363](https://github.com/shlinkio/shlink/issues/363) Updated to `shlinkio/php-coding-standard` version 1.1.0
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#362](https://github.com/shlinkio/shlink/issues/362) Fixed all visits without an IP address being processed every time the `visit:process` command is executed.
+
+
+## 1.16.0 - 2019-02-23
+
+#### Added
+
+* [#304](https://github.com/shlinkio/shlink/issues/304) Added health endpoint to check healthiness of the service. Useful in container-based infrastructures.
+
+    Call [GET /rest/health] in order to get a response like this:
+
+    ```http
+    HTTP/1.1 200 OK
+    Content-Type: application/health+json
+    Content-Length: 681
+
+    {
+      "status": "pass",
+      "version": "1.16.0",
+      "links": {
+        "about": "https://shlink.io",
+        "project": "https://github.com/shlinkio/shlink"
+      }
+    }
+    ```
+
+    The status code can be `200 OK` in case of success or `503 Service Unavailable` in case of error, while the `status` property will be one of `pass` or `fail`, as defined in the [Health check RFC](https://inadarei.github.io/rfc-healthcheck/).
+
+* [#279](https://github.com/shlinkio/shlink/issues/279) Added new `findIfExists` flag to the `[POST /short-url]` REST endpoint and the `short-urls:generate` CLI command. It can be used to return existing short URLs when found, instead of creating new ones.
+
+    Thanks to this flag you won't need to remember if you created a short URL for a long one. It will just create it if needed or return the existing one if possible.
+
+    The behavior might be a little bit counterintuitive when combined with other params. This is how the endpoint behaves when providing this new flag:
+
+    * Only the long URL is provided: It will return the newest match or create a new short URL if none is found.
+    * Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.
+    * Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.
+
+* [#336](https://github.com/shlinkio/shlink/issues/336) Added an API test suite which performs API calls to an actual instance of the web service.
+
+#### Changed
+
+* [#342](https://github.com/shlinkio/shlink/issues/342) The installer no longer asks for a charset to be provided, and instead, it shuffles the base62 charset.
+* [#320](https://github.com/shlinkio/shlink/issues/320) Replaced query builder by plain DQL for all queries which do not need to be dynamically generated.
+* [#330](https://github.com/shlinkio/shlink/issues/330) No longer allow failures on PHP 7.3 envs during project CI build.
+* [#335](https://github.com/shlinkio/shlink/issues/335) Renamed functional test suite to database test suite, since that better describes what it actually does.
+* [#346](https://github.com/shlinkio/shlink/issues/346) Extracted installer as an independent tool.
+* [#261](https://github.com/shlinkio/shlink/issues/261) Increased mutation score to 70%.
+
+#### Deprecated
+
+* [#351](https://github.com/shlinkio/shlink/issues/351) Deprecated `config:generate-charset` and `config:generate-secret` CLI commands.
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#317](https://github.com/shlinkio/shlink/issues/317) Fixed error while trying to generate previews because of global config file being deleted by mistake by build script.
+* [#307](https://github.com/shlinkio/shlink/issues/307) Fixed memory leak while trying to process huge amounts of visits due to the query not being properly paginated.
+
+
+## 1.15.1 - 2018-12-16
+
+#### Added
+
+* [#162](https://github.com/shlinkio/shlink/issues/162) Added non-rest endpoints to swagger definition.
+
+#### Changed
+
+* [#312](https://github.com/shlinkio/shlink/issues/312) Now all config files both in `php` and `json` format are loaded from `config/params` folder, easing users to provided customizations to docker image.
+* [#226](https://github.com/shlinkio/shlink/issues/226) Updated how table are rendered in CLI commands, making use of new features in Symfony 4.2.
+* [#321](https://github.com/shlinkio/shlink/issues/321) Extracted entities mappings from entities to external config files.
+* [#308](https://github.com/shlinkio/shlink/issues/308) Automated docker image building.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* [#301](https://github.com/shlinkio/shlink/issues/301) Removed custom `AccessLogFactory` in favor of the implementation included in [zendframework/zend-expressive-swoole](https://github.com/zendframework/zend-expressive-swoole) v2.2.0
+
+#### Fixed
+
+* [#309](https://github.com/shlinkio/shlink/issues/309) Added missing favicon to prevent 404 errors logged when an error page is loaded in a browser.
+* [#310](https://github.com/shlinkio/shlink/issues/310) Fixed execution context not being properly detected, making `CloseDbConnectionMiddlware` to be always piped. Now the check is not even made, which simplifies everything.
+
+
+## 1.15.0 - 2018-12-02
+
+#### Added
+
+* [#208](https://github.com/shlinkio/shlink/issues/208) Added initial support to run shlink using [swoole](https://www.swoole.co.uk/), a non-blocking IO server which improves the performance of shlink from 4 to 10 times.
+
+    Run shlink with `./vendor/bin/zend-expressive-swoole start` to start-up the service, which will be exposed in port `8080`.
+
+    Adding the `-d` flag, it will be started as a background service. Then you can use the `./vendor/bin/zend-expressive-swoole stop` command in order to stop it.
+
+* [#266](https://github.com/shlinkio/shlink/issues/266) Added pagination to `GET /short-urls/{shortCode}/visits` endpoint.
+
+    In order to make it backwards compatible, it keeps returning all visits by default, but it now allows to provide the `page` and `itemsPerPage` query parameters in order to configure the number of items to get.
+
+#### Changed
+
+* [#267](https://github.com/shlinkio/shlink/issues/267) API responses and the CLI interface is no longer translated and uses english always. Only not found error templates are still translated.
+* [#289](https://github.com/shlinkio/shlink/issues/289) Extracted coding standard rules to a separated package.
+* [#273](https://github.com/shlinkio/shlink/issues/273) Improved code coverage in repository classes.
+
+#### Deprecated
+
+* *Nothing*
+
+#### Removed
+
+* *Nothing*
+
+#### Fixed
+
+* [#278](https://github.com/shlinkio/shlink/pull/278) Added missing `X-Api-Key` header to the list of valid cross domain headers.
+* [#295](https://github.com/shlinkio/shlink/pull/295) Fixed custom slugs so that they are case sensitive and do not try to lowercase provided values.
+
 
 ## 1.14.1 - 2018-11-17
 

Dockerfile

@@ -0,0 +1,56 @@
+FROM php:7.3.11-alpine3.10
+LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+
+ARG SHLINK_VERSION=1.20.0
+ENV SHLINK_VERSION ${SHLINK_VERSION}
+ENV SWOOLE_VERSION 4.4.12
+ENV COMPOSER_VERSION 1.9.1
+
+WORKDIR /etc/shlink
+
+RUN \
+    # Install mysl and calendar
+    docker-php-ext-install -j"$(nproc)" pdo_mysql calendar && \
+    # Install sqlite
+    apk add --no-cache sqlite-libs sqlite-dev && \
+    docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
+    # Install postgres
+    apk add --no-cache postgresql-dev && \
+    docker-php-ext-install -j"$(nproc)" pdo_pgsql && \
+    # Install intl
+    apk add --no-cache icu-dev && \
+    docker-php-ext-install -j"$(nproc)" intl && \
+    # Install zip and gd
+    apk add --no-cache libzip-dev zlib-dev libpng-dev && \
+    docker-php-ext-install -j"$(nproc)" zip gd
+
+# Install 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
+COPY . .
+RUN rm -rf ./docker && \
+    wget https://getcomposer.org/download/${COMPOSER_VERSION}/composer.phar && \
+    php composer.phar install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction && \
+    php composer.phar clear-cache && \
+    rm composer.*
+
+# Add shlink to the path to ease running it after container is created
+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 8080
+
+# Expose params config dir, since the user is expected to provide custom config from there
+VOLUME /etc/shlink/config/params
+
+# Copy config specific for the image
+COPY docker/docker-entrypoint.sh docker-entrypoint.sh
+COPY docker/config/shlink_in_docker.local.php config/autoload/shlink_in_docker.local.php
+
+ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Alejandro Celaya
+Copyright (c) 2016-2019 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

@@ -9,12 +9,20 @@
 
 A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [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)
+
 ## Installation
 
 First make sure the host where you are going to run shlink fulfills these requirements:
 
-* PHP 7.1 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
-* MySQL, PostgreSQL or SQLite.
+* PHP 7.2 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
+* MySQL, MariaDB, PostgreSQL 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.
@@ -41,55 +49,133 @@ Then, you will need a built version of the project. There are a few ways to get
 
 Despite how you built the project, you are going to need to install it now, by following these steps:
 
-* If you are going to use MySQL or PostgreSQL, create an empty database with the name of your choice.
+* If you are going to use MySQL, MariaDB or PostgreSQL, 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.**
-* Configure the web server of your choice to serve shlink using your short domain.
+* 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.
 
-    For example, assuming your domain is doma.in and shlink is in the `/path/to/shlink` folder, this would be the basic configuration for Nginx and Apache.
+    * **Using a web server:**
 
-    *Nginx:*
+        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
-    server {
-        server_name doma.in;
-        listen 80;
-        root /path/to/shlink/public;
-        index index.php;
-        charset utf-8;
+        *Nginx:*
 
-        location / {
-            try_files $uri $uri/ /index.php$is_args$args;
+        ```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
         }
 
-        location ~ \.php$ {
-            fastcgi_split_path_info ^(.+\.php)(/.+)$;
-            fastcgi_pass unix:/var/run/php/php7.1-fpm.sock;
-            fastcgi_index index.php;
-            include fastcgi.conf;
+        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
         }
 
-        location ~ /\.ht {
-            deny all;
-        }
-    }
-    ```
+        case "$1" in
+          start)
+            start
+            ;;
+          stop)
+            stop
+            ;;
+          restart)
+            stop
+            start
+            ;;
+          *)
+            echo "Usage: $0 {start|stop|restart}"
+        esac
+        ```
 
-    *Apache:*
+        Then run these commands to enable the service and start it:
 
-    ```apache
-    <VirtualHost *:80>
-        ServerName doma.in
-        DocumentRoot "/path/to/shlink/public"
+        * `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`
 
-        <Directory "/path/to/shlink/public">
-            Options FollowSymLinks Includes ExecCGI
-            AllowOverride all
-            Order allow,deny
-            Allow from all
-        </Directory>
-    </VirtualHost>
-    ```
+        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.
@@ -100,31 +186,36 @@ There are a couple of time-consuming tasks that shlink expects you to do manuall
 
 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):
 
-* Resolve IP address locations: `/path/to/shlink/bin/cli visit:process`
+* **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`
 
     If you don't run this command regularly, the stats will say all visits come from *unknown* locations.
 
-* Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
-
-    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.
-
-    The file is updated the first Tuesday of every month, so it should be enough running this command the first Wednesday.
-
 * Generate website previews: `/path/to/shlink/bin/cli short-url:process-previews`
 
     Running this will improve the performance of the `doma.in/abc123/preview` URLs, which return a preview of the site.
 
-*Any of those commands accept the `-q` flag, which makes it not display any output. This is recommended when configuring the commands as cron jobs.*
+    > **Important!** Generating previews is considered deprecated and the feature will be removed in Shlink v2.
+
+* **For shlink older than v1.17.0**: Update IP geolocation database: `/path/to/shlink/bin/cli visit:update-db`
+
+    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.
+
+    The file is updated the first Tuesday of every month, so it should be enough running this command the first Wednesday.
+
+*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.*
+
+> 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.
 
 ## 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:
 
-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`)
+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.
+4. If you are using shlink with swoole, restart the service by running `/etc/init.d/shlink_swoole restart`.
 
-The 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 the assets neccessary for Shlink to function.
+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.
 
 Right now, it does not import cached info (like website previews), but it will. For now you will need to regenerate them again.
 
@@ -132,11 +223,9 @@ Right now, it does not import cached info (like website previews), but it will.
 
 ## Using a docker image
 
-Currently there's no official docker image, but there's a work in progress alpha version you can find [here](https://hub.docker.com/r/shlinkio/shlink/).
+Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](docker/README.md).
 
-The idea will be that you can just generate a container using the image and provide predefined config files via volumes or CLI arguments, so that you get shlink up and running.
-
-Currently the image does not expose an entry point which let's you interact with shlink's CLI interface, nor allows configuration to be passed.
+The idea is that you can just generate a container using the image and provide custom config via env vars.
 
 ## Using shlink
 
@@ -177,14 +266,17 @@ Available commands:
   api-key:generate            Generates a new valid API key.
   api-key:list                Lists all the available API keys.
  config
-  config:generate-charset     Generates a character set sample just by shuffling the default one, "123456789bcdfghjkmnpqrstvwxyzBCDFGHJKLMNPQRSTVWXYZ". Then it can be set in the SHORTCODE_CHARS environment variable
-  config:generate-secret      Generates a random secret string that can be used for JWT token encryption
+  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
+ db
+  db:create                   Creates the database needed for shlink to work. It will do nothing if the database already exists
+  db:migrate                  Runs database migrations, which will ensure the shlink database is up to date.
  short-url
   short-url:delete            [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] Processes and generates the previews for every URL, improving performance for later web requests.
+  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
  tag
   tag:create                  Creates one or more tags.
@@ -192,8 +284,8 @@ Available commands:
   tag:list                    Lists existing tags.
   tag:rename                  Renames one existing tag.
  visit
-  visit:process               Processes visits where location is not set yet
-  visit:update-db             Updates the GeoLite2 database file used to geolocate IP addresses
+  visit:locate                [visit:process] Resolves visits origin locations.
+  visit:update-db             [DEPRECATED] Updates the GeoLite2 database file used to geolocate IP addresses
 ```
 
 > This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

bin/cli

@@ -2,7 +2,7 @@
 <?php
 declare(strict_types=1);
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Symfony\Component\Console\Application as CliApp;
 
 /** @var ContainerInterface $container */

bin/install

@@ -2,11 +2,11 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Installer;
+namespace Shlinkio\Shlink;
 
-use Symfony\Component\Console\Application;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use function chdir;
+use function dirname;
 
-/** @var ServiceLocatorInterface $container */
-$container = include __DIR__ . '/../config/install-container.php';
-$container->build(Application::class)->run();
+chdir(dirname(__DIR__));
+$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$run(false);

bin/test/run-api-tests.sh

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

bin/update

@@ -2,11 +2,11 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Installer;
+namespace Shlinkio\Shlink;
 
-use Symfony\Component\Console\Application;
-use Zend\ServiceManager\ServiceLocatorInterface;
+use function chdir;
+use function dirname;
 
-/** @var ServiceLocatorInterface $container */
-$container = include __DIR__ . '/../config/install-container.php';
-$container->build(Application::class, ['isUpdate' => true])->run();
+chdir(dirname(__DIR__));
+$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$run(true);

build.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 set -e
 
-if [ "$#" -ne 1 ]; then
+if [[ "$#" -ne 1 ]]; then
   echo "Usage:" >&2
   echo "   $0 {version}" >&2
   exit 1
@@ -10,30 +10,16 @@ fi
 version=$1
 builtcontent="./build/shlink_${version}_dist"
 projectdir=$(pwd)
-[ -f ./composer.phar ] && composerBin='./composer.phar' || composerBin='composer'
+[[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
 
 # Copy project content to temp dir
 echo 'Copying project files...'
 rm -rf "${builtcontent}"
 mkdir -p "${builtcontent}"
 rsync -av * "${builtcontent}" \
-    --exclude=data/infra \
-    --exclude=data/migrations_template.txt \
-    --exclude=data/GeoLite2-City.mmdb \
-    --exclude=**/.gitignore \
-    --exclude=CHANGELOG.md \
-    --exclude=composer.lock \
-    --exclude=vendor \
-    --exclude=docs \
-    --exclude=indocker \
-    --exclude=docker* \
-    --exclude=func_tests_bootstrap.php \
-    --exclude=php* \
-    --exclude=infection.json \
-    --exclude=phpstan.neon \
-    --exclude=config/autoload/*local* \
-    --exclude=**/test* \
-    --exclude=build*
+    --exclude=*docker* \
+    --exclude=Dockerfile \
+    --exclude-from=./.dockerignore
 cd "${builtcontent}"
 
 # Install dependencies
@@ -44,7 +30,6 @@ ${composerBin} install --no-dev --optimize-autoloader --no-progress --no-interac
 # Delete development files
 echo 'Deleting dev files...'
 rm composer.*
-rm -f data/database.sqlite
 
 # Update shlink version in config
 sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php

composer.json

@@ -12,127 +12,142 @@
         }
     ],
     "require": {
-        "php": "^7.1",
+        "php": "^7.2",
         "ext-json": "*",
         "ext-pdo": "*",
-        "acelaya/ze-content-based-error-handler": "^2.2",
+        "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/migrations": "^1.4",
+        "doctrine/dbal": "^2.9",
+        "doctrine/migrations": "^2.0",
         "doctrine/orm": "^2.5",
-        "endroid/qr-code": "^1.7",
+        "endroid/qr-code": "^3.6",
         "firebase/php-jwt": "^4.0",
         "geoip2/geoip2": "^2.9",
-        "guzzlehttp/guzzle": "^6.2",
-        "lstrojny/functional-php": "^1.8",
+        "guzzlehttp/guzzle": "^6.3",
+        "lstrojny/functional-php": "^1.9",
         "mikehaertl/phpwkhtmltopdf": "^2.2",
-        "monolog/monolog": "^1.21",
-        "roave/security-advisories": "dev-master",
-        "symfony/console": "^4.1",
-        "symfony/filesystem": "^4.1",
-        "symfony/lock": "^4.1",
-        "symfony/process": "^4.1",
-        "theorchard/monolog-cascade": "^0.4",
-        "zendframework/zend-config": "^3.0",
-        "zendframework/zend-config-aggregator": "^1.0",
-        "zendframework/zend-diactoros": "^2.0",
-        "zendframework/zend-expressive": "^3.0",
+        "monolog/monolog": "^1.24",
+        "ocramius/proxy-manager": "~2.2.2",
+        "phly/phly-event-dispatcher": "^1.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.0",
-        "zendframework/zend-expressive-platesrenderer": "^2.0",
-        "zendframework/zend-i18n": "^2.7",
-        "zendframework/zend-inputfilter": "^2.8",
-        "zendframework/zend-paginator": "^2.6",
-        "zendframework/zend-servicemanager": "^3.2",
-        "zendframework/zend-stdlib": "^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"
     },
     "require-dev": {
         "devster/ubench": "^2.0",
-        "filp/whoops": "^2.0",
-        "infection/infection": "^0.11.0",
-        "phpstan/phpstan": "^0.10.0",
-        "phpunit/phpcov": "^5.0",
-        "phpunit/phpunit": "^7.3",
-        "slevomat/coding-standard": "^4.0",
-        "squizlabs/php_codesniffer": "^3.2.3",
-        "symfony/dotenv": "^4.0",
-        "symfony/var-dumper": "^4.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",
+        "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.0"
+        "zendframework/zend-expressive-tooling": "^1.2"
     },
     "autoload": {
         "psr-4": {
             "Shlinkio\\Shlink\\CLI\\": "module/CLI/src",
             "Shlinkio\\Shlink\\Rest\\": "module/Rest/src",
             "Shlinkio\\Shlink\\Core\\": "module/Core/src",
-            "Shlinkio\\Shlink\\Common\\": "module/Common/src",
-            "Shlinkio\\Shlink\\Installer\\": "module/Installer/src"
+            "Shlinkio\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/src/"
         },
         "files": [
-            "module/Common/functions/functions.php"
+            "module/Core/functions/functions.php"
         ]
     },
     "autoload-dev": {
         "psr-4": {
             "ShlinkioTest\\Shlink\\CLI\\": "module/CLI/test",
             "ShlinkioTest\\Shlink\\Rest\\": "module/Rest/test",
+            "ShlinkioApiTest\\Shlink\\Rest\\": "module/Rest/test-api",
             "ShlinkioTest\\Shlink\\Core\\": [
                 "module/Core/test",
-                "module/Core/test-func"
+                "module/Core/test-db"
             ],
-            "ShlinkioTest\\Shlink\\Common\\": [
-                "module/Common/test",
-                "module/Common/test-func"
-            ],
-            "ShlinkioTest\\Shlink\\Installer\\": "module/Installer/test"
+            "ShlinkioTest\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/test"
         }
     },
     "scripts": {
-        "check": [
+        "ci": [
             "@cs",
             "@stan",
             "@test:ci",
             "@infect:ci"
         ],
-        "ci": [
-            "echo \"This command is DEPRECATED. Use check instead\"",
-            "@check"
-        ],
-
         "cs": "phpcs",
         "cs:fix": "phpcbf",
-        "stan": "phpstan analyse module/*/src/ --level=5 -c phpstan.neon",
-
+        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config --level=5 -c phpstan.neon",
         "test": [
             "@test:unit",
-            "@test:func"
+            "@test:db",
+            "@test:api"
         ],
         "test:ci": [
             "@test:unit:ci",
-            "@test:func"
+            "@test:db:ci",
+            "@test:api"
         ],
-        "test:unit": "phpdbg -qrr vendor/bin/phpunit --order-by=random --coverage-php build/coverage-unit.cov",
-        "test:unit:ci": "phpdbg -qrr vendor/bin/phpunit --order-by=random --coverage-php build/coverage-unit.cov --coverage-clover=build/clover.xml --coverage-xml=build/coverage-xml --log-junit=build/phpunit.junit.xml",
-        "test:func": "phpdbg -qrr vendor/bin/phpunit --order-by=random -c phpunit-func.xml --coverage-php build/coverage-func.cov",
-
+        "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:db": [
+            "@test:db:sqlite",
+            "@test:db:mysql",
+            "@test:db:maria",
+            "@test:db:postgres"
+        ],
+        "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: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:api": "bin/test/run-api-tests.sh",
         "test:pretty": [
             "@test",
-            "phpcov merge build --html build/html"
+            "phpdbg -qrr vendor/bin/phpcov merge build --html build/html"
         ],
-        "test:unit:pretty": "phpdbg -qrr vendor/bin/phpunit --coverage-html build/coverage --order-by=random",
-
-        "infect": "infection --threads=4 --min-msi=65 --log-verbosity=2 --only-covered",
-        "infect:ci": "infection --threads=4 --min-msi=65 --log-verbosity=2 --only-covered --coverage=build",
-        "infect:show": "infection --threads=4 --min-msi=65 --log-verbosity=2 --only-covered --show-mutations",
+        "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",
             "@infect:ci"
-        ]
+        ],
+        "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
     },
     "scripts-descriptions": {
-        "check": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test\" and \"infect\"</>",
         "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test:ci\" and \"infect:ci\"</>",
         "cs": "<fg=blue;options=bold>Checks coding styles</>",
         "cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
@@ -141,12 +156,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:func": "<fg=blue;options=bold>Runs functional test suites (covering entity repositories)</>",
+        "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: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: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

config/autoload/app_options.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use function Shlinkio\Shlink\Common\env;
@@ -8,7 +9,7 @@ return [
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'secret_key' => env('SECRET_KEY'),
+        'secret_key' => env('SECRET_KEY', ''),
         'disable_track_param' => null,
     ],
 

config/autoload/client-detection.global.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'ip_address_resolution' => [
+        'headers_to_inspect' => [
+            'CF-Connecting-IP',
+            'True-Client-IP',
+            'X-Real-IP',
+            'Forwarded',
+            'X-Forwarded-For',
+            'X-Forwarded',
+            'X-Cluster-Client-Ip',
+            'Client-Ip',
+        ],
+    ],
+
+];

config/autoload/common.global.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Zend\ConfigAggregator\ConfigAggregator;
+
+return [
+
+    'debug' => false,
+    ConfigAggregator::ENABLE_CACHE => true,
+
+];

config/autoload/common.local.php.dist

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+use Zend\ConfigAggregator\ConfigAggregator;
+
+return [
+
+    'debug' => true,
+    ConfigAggregator::ENABLE_CACHE => false,
+
+];

config/autoload/delete_short_urls.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Shlinkio\Shlink;

config/autoload/dependencies.global.php

@@ -1,23 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Common\Factory\EmptyResponseImplicitOptionsMiddlewareFactory;
 use Zend\Expressive;
 use Zend\Expressive\Container;
-use Zend\Expressive\Helper;
-use Zend\Expressive\Router\Middleware\ImplicitOptionsMiddleware;
-use Zend\ServiceManager\Factory\InvokableFactory;
 
 return [
 
     'dependencies' => [
-        'factories' => [
-            ImplicitOptionsMiddleware::class => EmptyResponseImplicitOptionsMiddlewareFactory::class,
-
-            Helper\UrlHelper::class => Helper\UrlHelperFactory::class,
-            Helper\ServerUrlHelper::class => InvokableFactory::class,
-        ],
-
         'delegators' => [
             Expressive\Application::class => [
                 Container\ApplicationConfigInjectionDelegator::class,

config/autoload/dependencies.local.php.dist

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

config/autoload/entity-manager.global.php

@@ -1,7 +1,8 @@
 <?php
+
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Common;
+namespace Shlinkio\Shlink\Common;
 
 return [
 
@@ -10,9 +11,9 @@ return [
             'proxies_dir' => 'data/proxies',
         ],
         'connection' => [
-            'user' => Common\env('DB_USER'),
-            'password' => Common\env('DB_PASSWORD'),
-            'dbname' => Common\env('DB_NAME', 'shlink'),
+            'user' => env('DB_USER'),
+            'password' => env('DB_PASSWORD'),
+            'dbname' => env('DB_NAME', 'shlink'),
             'charset' => 'utf8',
         ],
     ],

config/autoload/errorhandler.local.php.dist

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 use Zend\Expressive\Container\WhoopsErrorResponseGeneratorFactory;
 
 return [

config/autoload/geolite2.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 return [

config/autoload/installer.global.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Installer\Config\Plugin;
+
+return [
+
+    'installer_plugins_expected_config' => [
+        Plugin\UrlShortenerConfigCustomizer::class => [
+            Plugin\UrlShortenerConfigCustomizer::SCHEMA,
+            Plugin\UrlShortenerConfigCustomizer::HOSTNAME,
+            Plugin\UrlShortenerConfigCustomizer::VALIDATE_URL,
+        ],
+
+        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',
+        ],
+    ],
+
+];

config/autoload/local.php.dist

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

config/autoload/locks.global.php

@@ -1,9 +1,17 @@
 <?php
+
 declare(strict_types=1);
 
+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);
+
 return [
 
     'locks' => [
@@ -13,13 +21,32 @@ return [
     'dependencies' => [
         'factories' => [
             Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
+            Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
             Lock\Factory::class => ConfigAbstractFactory::class,
+            $localLockFactory => ConfigAbstractFactory::class,
+        ],
+        'aliases' => [
+            // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
+            'lock_store' => 'local_lock_store',
+
+            'redis_lock_store' => Lock\Store\RedisStore::class,
+            'local_lock_store' => Lock\Store\FlockStore::class,
+        ],
+        'delegators' => [
+            Lock\Store\RedisStore::class => [
+                RetryLockStoreDelegatorFactory::class,
+            ],
+            Lock\Factory::class => [
+                LoggerAwareDelegatorFactory::class,
+            ],
         ],
     ],
 
     ConfigAbstractFactory::class => [
         Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
-        Lock\Factory::class => [Lock\Store\FlockStore::class],
+        Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
+        Lock\Factory::class => ['lock_store'],
+        $localLockFactory => ['local_lock_store'],
     ],
 
 ];

config/autoload/logger.global.php

@@ -1,11 +1,15 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
 use Monolog\Handler\RotatingFileHandler;
+use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 use Monolog\Processor;
+use Psr\Log\LoggerInterface;
+
 use const PHP_EOL;
 
 return [
@@ -19,13 +23,18 @@ return [
         ],
 
         'handlers' => [
-            'rotating_file_handler' => [
+            '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' => [
@@ -39,10 +48,34 @@ return [
 
         'loggers' => [
             'Shlink' => [
-                'handlers' => ['rotating_file_handler'],
+                'handlers' => ['shlink_rotating_handler'],
+                'processors' => ['exception_with_new_line', 'psr3'],
+            ],
+            'Access' => [
+                'handlers' => ['access_handler'],
                 'processors' => ['exception_with_new_line', 'psr3'],
             ],
         ],
     ],
 
+    'dependencies' => [
+        'factories' => [
+            'Logger_Shlink' => Common\Logger\LoggerFactory::class,
+            'Logger_Access' => Common\Logger\LoggerFactory::class,
+        ],
+        'aliases' => [
+            'logger' => 'Logger_Shlink',
+            Logger::class => 'Logger_Shlink',
+            LoggerInterface::class => 'Logger_Shlink',
+        ],
+    ],
+
+    'zend-expressive-swoole' => [
+        'swoole-http-server' => [
+            'logger' => [
+                'logger-name' => 'Logger_Access',
+            ],
+        ],
+    ],
+
 ];

config/autoload/logger.local.php.dist

@@ -1,14 +1,40 @@
 <?php
+declare(strict_types=1);
+
+use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 
-return [
+$isSwoole = extension_loaded('swoole');
 
-    'logger' => [
-        'handlers' => [
-            'rotating_file_handler' => [
-                'level' => Logger::DEBUG,
-            ],
+// 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,
+            'level' => Logger::DEBUG,
+            'stream' => 'php://stdout',
+            'formatter' => 'dashed',
         ],
     ],
 
+    'loggers' => [
+        'Shlink' => [
+            'handlers' => ['shlink_stdout_handler'],
+        ],
+    ],
+] : [
+    'handlers' => [
+        'shlink_rotating_handler' => [
+            'level' => Logger::DEBUG,
+        ],
+    ],
+];
+
+return [
+
+    'logger' => $logger,
+
 ];

config/autoload/middleware-pipeline.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
@@ -13,7 +14,7 @@ return [
             'middleware' => [
                 ErrorHandler::class,
                 Expressive\Helper\ContentLengthMiddleware::class,
-                Common\Middleware\LocaleMiddleware::class,
+                Common\Middleware\CloseDbConnectionMiddleware::class,
             ],
             'priority' => 12,
         ],

config/autoload/preview-generation.global.php

@@ -1,6 +1,8 @@
 <?php
+
 declare(strict_types=1);
 
+/* @deprecated */
 return [
 
     'preview_generation' => [

config/autoload/redirects.global.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'not_found_redirects' => [
+        'invalid_short_url' => null, // Formerly url_shortener.not_found_short_url.redirect_to
+        'regular_404' => null,
+        'base_url' => null,
+    ],
+
+];

config/autoload/redis.local.php.local

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+return [
+
+    'redis' => [
+        'servers' => 'tcp://shlink_redis:6379',
+//        'servers' => [
+//            'tcp://shlink_redis:6379',
+//        ],
+    ],
+
+    'dependencies' => [
+        'aliases' => [
+            // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
+//            'lock_store' => 'redis_lock_store',
+        ],
+    ],
+
+];

config/autoload/router.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Zend\Expressive\Router\FastRouteRouter;
@@ -6,6 +7,8 @@ use Zend\Expressive\Router\FastRouteRouter;
 return [
 
     'router' => [
+        'base_path' => '',
+
         'fastroute' => [
             FastRouteRouter::CONFIG_CACHE_ENABLED => true,
             FastRouteRouter::CONFIG_CACHE_FILE => 'data/cache/fastroute_cached_routes.php',

config/autoload/swoole.global.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'zend-expressive-swoole' => [
+        'enable_coroutine' => true,
+
+        'swoole-http-server' => [
+            'host' => '0.0.0.0',
+            'process-name' => 'shlink',
+
+            'options' => [
+                'worker_num' => 16,
+                'task_worker_num' => 16,
+            ],
+        ],
+    ],
+
+];

config/autoload/swoole.local.php.dist

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

config/autoload/templates.global.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 return [

config/autoload/translator.global.php

@@ -1,12 +0,0 @@
-<?php
-declare(strict_types=1);
-
-use Shlinkio\Shlink\Common;
-
-return [
-
-    'translator' => [
-        'locale' => Common\env('DEFAULT_LOCALE', 'en'),
-    ],
-
-];

config/autoload/url-shortener.global.php

@@ -1,7 +1,7 @@
 <?php
+
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Core\Service\UrlShortener;
 use function Shlinkio\Shlink\Common\env;
 
 return [
@@ -11,12 +11,7 @@ return [
             'schema' => env('SHORTENED_URL_SCHEMA', 'http'),
             'hostname' => env('SHORTENED_URL_HOSTNAME'),
         ],
-        'shortcode_chars' => env('SHORTCODE_CHARS', UrlShortener::DEFAULT_CHARS),
         'validate_url' => true,
-        'not_found_short_url' => [
-            'enable_redirection' => false,
-            'redirect_to' => null,
-        ],
     ],
 
 ];

config/autoload/wkhtmltopdf.global.php

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

config/autoload/zend-expressive.global.php

@@ -1,9 +0,0 @@
-<?php
-declare(strict_types=1);
-
-return [
-
-    'debug' => false,
-    'config_cache_enabled' => true,
-
-];

config/cli-config.php

@@ -1,35 +1,16 @@
 <?php
+
 declare(strict_types=1);
 
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\Console\ConsoleRunner;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\ServiceManager;
 
-$isTest = false;
-foreach ($_SERVER['argv'] as $i => $arg) {
-    if ($arg === '--test') {
-        unset($_SERVER['argv'][$i]);
-        $isTest = true;
-        break;
-    }
-}
+return (function () {
+    /** @var ContainerInterface|ServiceManager $container */
+    $container = include __DIR__ . '/container.php';
+    $em = $container->get(EntityManager::class);
 
-/** @var ContainerInterface|ServiceManager $container */
-$container = include __DIR__ . '/container.php';
-
-// If in testing env, override DB connection to use an in-memory sqlite database
-if ($isTest) {
-    $container->setAllowOverride(true);
-    $config = $container->get('config');
-    $config['entity_manager']['connection'] = [
-        'driver' => 'pdo_sqlite',
-        'path' => realpath(sys_get_temp_dir()) . '/shlink-tests.db',
-    ];
-    $container->setService('config', $config);
-}
-
-/** @var EntityManager $em */
-$em = $container->get(EntityManager::class);
-
-return ConsoleRunner::createHelperSet($em);
+    return ConsoleRunner::createHelperSet($em);
+})();

config/config.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
@@ -6,22 +7,29 @@ namespace Shlinkio\Shlink;
 use Acelaya\ExpressiveErrorHandler;
 use Zend\ConfigAggregator;
 use Zend\Expressive;
-use function class_exists;
+
+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\Helper\ConfigProvider::class,
-    class_exists(Expressive\Swoole\ConfigProvider::class)
-        ? Expressive\Swoole\ConfigProvider::class
-        : new ConfigAggregator\ArrayProvider([]),
+    Expressive\Swoole\ConfigProvider::class,
     ExpressiveErrorHandler\ConfigProvider::class,
     Common\ConfigProvider::class,
+    IpGeolocation\ConfigProvider::class,
     Core\ConfigProvider::class,
     CLI\ConfigProvider::class,
-    Installer\ConfigProvider::class,
     Rest\ConfigProvider::class,
-    new ConfigAggregator\ZendConfigProvider('config/{autoload/{{,*.}global,{,*.}local},params/generated_config}.php'),
-], 'data/cache/app_config.php'))->getMergedConfig();
+    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}}'),
+], 'data/cache/app_config.php', [
+    Core\Config\SimplifiedConfigParser::class,
+    Core\Config\BasePathPrefixer::class,
+    Core\Config\DeprecatedConfigParser::class,
+]))->getMergedConfig();

config/container.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Symfony\Component\Dotenv\Dotenv;

config/install-container.php

@@ -1,29 +0,0 @@
-<?php
-declare(strict_types=1);
-
-use Shlinkio\Shlink\Installer\Config\Plugin\DatabaseConfigCustomizer;
-use Shlinkio\Shlink\Installer\Factory\InstallApplicationFactory;
-use Symfony\Component\Console\Application;
-use Symfony\Component\Filesystem\Filesystem;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\ServiceManager\ServiceManager;
-
-chdir(dirname(__DIR__));
-
-require __DIR__ . '/../vendor/autoload.php';
-
-$container = new ServiceManager([
-    'factories' => [
-        Application::class => InstallApplicationFactory::class,
-        Filesystem::class => InvokableFactory::class,
-    ],
-    'services' => [
-        'config' => [
-            ConfigAbstractFactory::class => [
-                DatabaseConfigCustomizer::class => [Filesystem::class],
-            ],
-        ],
-    ],
-]);
-return $container;

config/test/bootstrap_api_tests.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Doctrine\ORM\EntityManager;
+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';
+$testHelper = $container->get(Helper\TestHelper::class);
+$config = $container->get('config');
+$em = $container->get(EntityManager::class);
+
+$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'] ?? []);
+});

config/test/bootstrap_db_tests.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+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();
+DbTest\DatabaseTestCase::setEntityManager($container->get('em'));

config/test/test_config.global.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use GuzzleHttp\Client;
+use PDO;
+use Zend\ConfigAggregator\ConfigAggregator;
+use Zend\ServiceManager\Factory\InvokableFactory;
+
+use function Shlinkio\Shlink\Common\env;
+use function sprintf;
+use function sys_get_temp_dir;
+
+$swooleTestingHost = '127.0.0.1';
+$swooleTestingPort = 9999;
+
+$buildDbConnection = function (): array {
+    $driver = env('DB_DRIVER', 'sqlite');
+    $isCi = env('TRAVIS', false);
+    $getMysqlHost = function (string $driver) {
+        return sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
+    };
+
+    $driverConfigMap = [
+        'sqlite' => [
+            'driver' => 'pdo_sqlite',
+            'path' => sys_get_temp_dir() . '/shlink-tests.db',
+        ],
+        'mysql' => [
+            'driver' => 'pdo_mysql',
+            'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
+            'user' => 'root',
+            'password' => $isCi ? '' : 'root',
+            'dbname' => 'shlink_test',
+            'charset' => 'utf8',
+            'driverOptions' => [
+                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
+            ],
+        ],
+        'postgres' => [
+            'driver' => 'pdo_pgsql',
+            'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
+            'user' => 'postgres',
+            'password' => $isCi ? '' : 'root',
+            'dbname' => 'shlink_test',
+            'charset' => 'utf8',
+        ],
+    ];
+    $driverConfigMap['maria'] = $driverConfigMap['mysql'];
+
+    return $driverConfigMap[$driver] ?? [];
+};
+
+return [
+
+    'debug' => true,
+    ConfigAggregator::ENABLE_CACHE => false,
+
+    'url_shortener' => [
+        'domain' => [
+            'schema' => 'http',
+            'hostname' => 'doma.in',
+        ],
+    ],
+
+    'zend-expressive-swoole' => [
+        'enable_coroutine' => false,
+        'swoole-http-server' => [
+            'host' => $swooleTestingHost,
+            'port' => $swooleTestingPort,
+            '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,
+            ],
+        ],
+    ],
+
+    'dependencies' => [
+        'services' => [
+            'shlink_test_api_client' => new Client([
+                'base_uri' => sprintf('http://%s:%s/', $swooleTestingHost, $swooleTestingPort),
+                'http_errors' => false,
+            ]),
+        ],
+        'factories' => [
+            TestUtils\Helper\TestHelper::class => InvokableFactory::class,
+        ],
+    ],
+
+    'entity_manager' => [
+        'connection' => $buildDbConnection(),
+    ],
+
+    'data_fixtures' => [
+        'paths' => [
+            __DIR__ . '/../../module/Rest/test-api/Fixtures',
+        ],
+    ],
+
+];

data/infra/database_maria/.gitignore

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

data/infra/database_pg/.gitignore

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

data/infra/db.Dockerfile

@@ -1,6 +0,0 @@
-FROM mysql:5.7
-MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
-
-# Enable remote access (default is localhost only, we change this
-# otherwise our database would not be reachable from outside the container)
-RUN sed -i -e"s/^bind-address\s*=\s*127.0.0.1/bind-address = 0.0.0.0/" /etc/mysql/my.cnf

data/infra/examples/apache-vhost.conf

@@ -0,0 +1,11 @@
+<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>

data/infra/examples/nginx-vhost.conf

@@ -0,0 +1,22 @@
+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;
+    }
+}

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

@@ -0,0 +1,13 @@
+/var/log/shlink/shlink_swoole.log {
+    su root root
+    daily
+    missingok
+    rotate 120
+    compress
+    delaycompress
+    notifempty
+    create 0640 root root
+    postrotate
+        /etc/init.d/shlink_swoole restart
+    endscript
+}

data/infra/examples/shlink-daemon.sh

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

data/infra/nginx.Dockerfile

@@ -1,5 +0,0 @@
-FROM nginx:1.11.6-alpine
-MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
-
-# Delete default nginx vhost
-RUN rm /etc/nginx/conf.d/default.conf

data/infra/php.Dockerfile

@@ -1,6 +1,10 @@
-FROM php:7.1.22-fpm-alpine
+FROM php:7.3.11-fpm-alpine3.10
 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
@@ -9,46 +13,24 @@ RUN docker-php-ext-install iconv
 RUN docker-php-ext-install mbstring
 RUN docker-php-ext-install calendar
 
-RUN apk add --no-cache --virtual sqlite-libs
-RUN apk add --no-cache --virtual sqlite-dev
+RUN apk add --no-cache sqlite-libs
+RUN apk add --no-cache sqlite-dev
 RUN docker-php-ext-install pdo_sqlite
 
-RUN apk add --no-cache --virtual icu-dev
+RUN apk add --no-cache icu-dev
 RUN docker-php-ext-install intl
 
-RUN apk add --no-cache --virtual zlib-dev
+RUN apk add --no-cache libzip-dev zlib-dev
 RUN docker-php-ext-install zip
 
-RUN apk add --no-cache --virtual libmcrypt-dev
-RUN docker-php-ext-install mcrypt
-
-RUN apk add --no-cache --virtual libpng-dev
+RUN apk add --no-cache libpng-dev
 RUN docker-php-ext-install gd
 
-# Install redis extension
-ADD https://github.com/phpredis/phpredis/archive/3.1.4.tar.gz /tmp/phpredis.tar.gz
-RUN mkdir -p /usr/src/php/ext/redis\
-  && tar xf /tmp/phpredis.tar.gz -C /usr/src/php/ext/redis --strip-components=1
-# configure and install
-RUN docker-php-ext-configure redis\
-  && docker-php-ext-install redis
-# cleanup
-RUN rm /tmp/phpredis.tar.gz
-
-# Install memcached extension
-RUN apk add --no-cache --virtual cyrus-sasl-dev
-RUN apk add --no-cache --virtual libmemcached-dev
-ADD https://github.com/php-memcached-dev/php-memcached/archive/php7.tar.gz /tmp/memcached.tar.gz
-RUN mkdir -p /usr/src/php/ext/memcached\
-  && tar xf /tmp/memcached.tar.gz -C /usr/src/php/ext/memcached --strip-components=1
-# configure and install
-RUN docker-php-ext-configure memcached\
-  && docker-php-ext-install memcached
-# cleanup
-RUN rm /tmp/memcached.tar.gz
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
 
 # Install APCu extension
-ADD https://pecl.php.net/get/apcu-5.1.3.tgz /tmp/apcu.tar.gz
+ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu\
   && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
 # configure and install
@@ -58,7 +40,7 @@ RUN docker-php-ext-configure apcu\
 RUN rm /tmp/apcu.tar.gz
 
 # Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-1.0.3.tgz /tmp/apcu_bc.tar.gz
+ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu-bc\
   && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
 # configure and install
@@ -72,7 +54,7 @@ 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-2.5.0 /tmp/xdebug.tar.gz
+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

data/infra/swoole.Dockerfile

@@ -0,0 +1,93 @@
+FROM php:7.3.11-alpine3.10
+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
+
+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 sqlite-libs
+RUN apk add --no-cache sqlite-dev
+RUN docker-php-ext-install pdo_sqlite
+
+RUN apk add --no-cache icu-dev
+RUN docker-php-ext-install intl
+
+RUN apk add --no-cache libzip-dev zlib-dev
+RUN docker-php-ext-install zip
+
+RUN apk add --no-cache libpng-dev
+RUN docker-php-ext-install gd
+
+RUN apk add --no-cache postgresql-dev
+RUN docker-php-ext-install pdo_pgsql
+
+# Install APCu extension
+ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu\
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
+# configure and install
+RUN docker-php-ext-configure apcu\
+  && docker-php-ext-install apcu
+# cleanup
+RUN rm /tmp/apcu.tar.gz
+
+# Install APCu-BC extension
+ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu-bc\
+  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
+# configure and install
+RUN docker-php-ext-configure apcu-bc\
+  && docker-php-ext-install apcu-bc
+# cleanup
+RUN rm /tmp/apcu_bc.tar.gz
+
+# Load APCU.ini before APC.ini
+RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
+RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
+
+# Install inotify extension
+ADD https://pecl.php.net/get/inotify-$INOTIFY_VERSION.tgz /tmp/inotify.tar.gz
+RUN mkdir -p /usr/src/php/ext/inotify\
+  && tar xf /tmp/inotify.tar.gz -C /usr/src/php/ext/inotify --strip-components=1
+# configure and install
+RUN docker-php-ext-configure inotify\
+  && docker-php-ext-install 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 composer
+RUN php -r "readfile('https://getcomposer.org/installer');" | php
+RUN chmod +x composer.phar
+RUN mv composer.phar /usr/local/bin/composer
+
+# Make home directory writable by anyone
+RUN chmod 777 /home
+
+VOLUME /home/shlink
+WORKDIR /home/shlink
+
+# Expose swoole port
+EXPOSE 8080
+
+CMD \
+    # Install dependencies if the vendor dir does not exist
+    if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
+    # When restarting the container, swoole might think it is already in execution
+    # 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

data/migrations/Version20160819142757.php

@@ -1,23 +1,27 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
 
 /**
  * Auto-generated Migration: Please modify to your needs!
  */
 class Version20160819142757 extends AbstractMigration
 {
-    const MYSQL = 'mysql';
-    const SQLITE = 'sqlite';
+    private const MYSQL = 'mysql';
+    private const SQLITE = 'sqlite';
 
     /**
-     * @param Schema $schema
+     * @throws DBALException
+     * @throws SchemaException
      */
-    public function up(Schema $schema)
+    public function up(Schema $schema): void
     {
         $db = $this->connection->getDatabasePlatform()->getName();
         $table = $schema->getTable('short_urls');
@@ -31,9 +35,9 @@ class Version20160819142757 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
+     * @throws DBALException
      */
-    public function down(Schema $schema)
+    public function down(Schema $schema): void
     {
         $db = $this->connection->getDatabasePlatform()->getName();
     }

data/migrations/Version20160820191203.php

@@ -1,21 +1,19 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\Migrations\AbstractMigration;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
 
 /**
  * Auto-generated Migration: Please modify to your needs!
  */
 class Version20160820191203 extends AbstractMigration
 {
-    /**
-     * @param Schema $schema
-     */
-    public function up(Schema $schema)
+    public function up(Schema $schema): void
     {
         // Check if the tables already exist
         $tables = $schema->getTables();
@@ -29,7 +27,7 @@ class Version20160820191203 extends AbstractMigration
         $this->createShortUrlsInTagsTable($schema);
     }
 
-    protected function createTagsTable(Schema $schema)
+    private function createTagsTable(Schema $schema): void
     {
         $table = $schema->createTable('tags');
         $table->addColumn('id', Type::BIGINT, [
@@ -46,7 +44,7 @@ class Version20160820191203 extends AbstractMigration
         $table->setPrimaryKey(['id']);
     }
 
-    protected function createShortUrlsInTagsTable(Schema $schema)
+    private function createShortUrlsInTagsTable(Schema $schema): void
     {
         $table = $schema->createTable('short_urls_in_tags');
         $table->addColumn('short_url_id', Type::BIGINT, [
@@ -70,10 +68,7 @@ class Version20160820191203 extends AbstractMigration
         $table->setPrimaryKey(['short_url_id', 'tag_id']);
     }
 
-    /**
-     * @param Schema $schema
-     */
-    public function down(Schema $schema)
+    public function down(Schema $schema): void
     {
         $schema->dropTable('short_urls_in_tags');
         $schema->dropTable('tags');

data/migrations/Version20171021093246.php

@@ -1,12 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\Migrations\AbstractMigration;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
 
 /**
  * Auto-generated Migration: Please modify to your needs!
@@ -14,10 +15,9 @@ use Doctrine\DBAL\Types\Type;
 class Version20171021093246 extends AbstractMigration
 {
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
-    public function up(Schema $schema)
+    public function up(Schema $schema): void
     {
         $shortUrls = $schema->getTable('short_urls');
         if ($shortUrls->hasColumn('valid_since')) {
@@ -33,10 +33,9 @@ class Version20171021093246 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
-    public function down(Schema $schema)
+    public function down(Schema $schema): void
     {
         $shortUrls = $schema->getTable('short_urls');
         if (! $shortUrls->hasColumn('valid_since')) {

data/migrations/Version20171022064541.php

@@ -1,12 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\Migrations\AbstractMigration;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
 
 /**
  * Auto-generated Migration: Please modify to your needs!
@@ -14,10 +15,9 @@ use Doctrine\DBAL\Types\Type;
 class Version20171022064541 extends AbstractMigration
 {
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
-    public function up(Schema $schema)
+    public function up(Schema $schema): void
     {
         $shortUrls = $schema->getTable('short_urls');
         if ($shortUrls->hasColumn('max_visits')) {
@@ -31,10 +31,9 @@ class Version20171022064541 extends AbstractMigration
     }
 
     /**
-     * @param Schema $schema
      * @throws SchemaException
      */
-    public function down(Schema $schema)
+    public function down(Schema $schema): void
     {
         $shortUrls = $schema->getTable('short_urls');
         if (! $shortUrls->hasColumn('max_visits')) {

data/migrations/Version20180801183328.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;

data/migrations/Version20180913205455.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;
@@ -7,7 +8,7 @@ use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 use PDO;
-use Shlinkio\Shlink\Common\Exception\WrongIpException;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
 use Shlinkio\Shlink\Common\Util\IpAddress;
 
 /**
@@ -60,7 +61,7 @@ final class Version20180913205455 extends AbstractMigration
 
         try {
             return (string) IpAddress::fromString($addr)->getObfuscatedCopy();
-        } catch (WrongIpException $e) {
+        } catch (InvalidArgumentException $e) {
             return null;
         }
     }

data/migrations/Version20180915110857.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;

data/migrations/Version20181020060559.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;

data/migrations/Version20181020065148.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;

data/migrations/Version20181110175521.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace ShlinkMigrations;

data/migrations/Version20190824075137.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20190824075137 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->getRefererColumn($schema)->setLength(1024);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $this->getRefererColumn($schema)->setLength(256);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    private function getRefererColumn(Schema $schema): Column
+    {
+        return $schema->getTable('visits')->getColumn('referer');
+    }
+}

data/migrations/Version20190930165521.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20190930165521 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        if ($shortUrls->hasColumn('domain_id')) {
+            return;
+        }
+
+        $domains = $schema->createTable('domains');
+        $domains->addColumn('id', Type::BIGINT, [
+            'unsigned' => true,
+            'autoincrement' => true,
+            'notnull' => true,
+        ]);
+        $domains->addColumn('authority', Type::STRING, [
+            'length' => 512,
+            'notnull' => true,
+        ]);
+        $domains->addUniqueIndex(['authority']);
+        $domains->setPrimaryKey(['id']);
+
+        $shortUrls->addColumn('domain_id', Type::BIGINT, [
+            'unsigned' => true,
+            'notnull' => false,
+        ]);
+        $shortUrls->addForeignKeyConstraint('domains', ['domain_id'], ['id'], [
+            'onDelete' => 'RESTRICT',
+            'onUpdate' => 'RESTRICT',
+        ]);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $schema->getTable('short_urls')->dropColumn('domain_id');
+        $schema->dropTable('domains');
+    }
+}

data/migrations/Version20191001201532.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Index;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+use function array_reduce;
+
+final class Version20191001201532 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        if ($shortUrls->hasIndex('unique_short_code_plus_domain')) {
+            return;
+        }
+
+        /** @var Index|null $shortCodesIndex */
+        $shortCodesIndex = array_reduce($shortUrls->getIndexes(), function (?Index $found, Index $current) {
+            [$column] = $current->getColumns();
+            return $column === 'short_code' ? $current : $found;
+        });
+        if ($shortCodesIndex === null) {
+            return;
+        }
+
+        $shortUrls->dropIndex($shortCodesIndex->getName());
+        $shortUrls->addUniqueIndex(['short_code', 'domain_id'], 'unique_short_code_plus_domain');
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+
+        $shortUrls->dropIndex('unique_short_code_plus_domain');
+        $shortUrls->addUniqueIndex(['short_code']);
+    }
+}

data/migrations/Version20191020074522.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20191020074522 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->getOriginalUrlColumn($schema)->setLength(2048);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $this->getOriginalUrlColumn($schema)->setLength(1024);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    private function getOriginalUrlColumn(Schema $schema): Column
+    {
+        return $schema->getTable('short_urls')->getColumn('original_url');
+    }
+}

data/migrations_template.txt

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace <namespace>;

docker-compose.override.yml.dist

@@ -1,4 +1,4 @@
-version: '2'
+version: '3'
 
 services:
     shlink_php:
@@ -6,3 +6,27 @@ services:
         volumes:
             - /etc/passwd:/etc/passwd:ro
             - /etc/group:/etc/group:ro
+
+    shlink_swoole:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db_postgres:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro
+
+    shlink_db_maria:
+        user: 1000:1000
+        volumes:
+            - /etc/passwd:/etc/passwd:ro
+            - /etc/group:/etc/group:ro

docker-compose.yml

@@ -1,17 +1,15 @@
-version: '2'
+version: '3'
 
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        build:
-            context: .
-            dockerfile: ./data/infra/nginx.Dockerfile
+        image: nginx:1.15.9-alpine
         ports:
             - "8000:80"
         volumes:
             - ./:/home/shlink/www
             - ./docs:/home/shlink/www/public/docs
-            - ./data/infra/vhost.conf:/etc/nginx/conf.d/shlink-vhost.conf
+            - ./data/infra/vhost.conf:/etc/nginx/conf.d/default.conf
         links:
             - shlink_php
 
@@ -25,12 +23,29 @@ services:
             - ./data/infra/php.ini:/usr/local/etc/php/php.ini
         links:
             - shlink_db
+            - shlink_db_postgres
+            - shlink_db_maria
+            - shlink_redis
+
+    shlink_swoole:
+        container_name: shlink_swoole
+        build:
+            context: .
+            dockerfile: ./data/infra/swoole.Dockerfile
+        ports:
+            - "8080:8080"
+            - "9001:9001"
+        volumes:
+            - ./:/home/shlink
+        links:
+            - shlink_db
+            - shlink_db_postgres
+            - shlink_db_maria
+            - shlink_redis
 
     shlink_db:
         container_name: shlink_db
-        build:
-            context: .
-            dockerfile: ./data/infra/db.Dockerfile
+        image: mysql:5.7
         ports:
             - "3307:3306"
         volumes:
@@ -39,3 +54,35 @@ services:
         environment:
             MYSQL_ROOT_PASSWORD: root
             MYSQL_DATABASE: shlink
+
+    shlink_db_postgres:
+        container_name: shlink_db_postgres
+        image: postgres:10.7-alpine
+        ports:
+            - "5433:5432"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database_pg:/var/lib/postgresql/data
+        environment:
+            POSTGRES_PASSWORD: root
+            POSTGRES_DB: shlink
+            PGDATA: /var/lib/postgresql/data/pgdata
+
+    shlink_db_maria:
+        container_name: shlink_db_maria
+        image: mariadb:10.2
+        ports:
+            - "3308:3306"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/database_maria:/var/lib/mysql
+        environment:
+            MYSQL_ROOT_PASSWORD: root
+            MYSQL_DATABASE: shlink
+            MYSQL_INITDB_SKIP_TZINFO: 1
+
+    shlink_redis:
+        container_name: shlink_redis
+        image: redis:5.0-alpine
+        ports:
+            - "6380:6379"

docker/README.md

@@ -0,0 +1,224 @@
+# 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.
+
+It exposes a shlink instance served with [swoole](https://www.swoole.co.uk/), which persists data in a local [sqlite](https://www.sqlite.org/index.html) database.
+
+## Usage
+
+Shlink docker image exposes port `8080` in order to interact with its HTTP interface.
+
+It also expects these two env vars to be provided, in order to properly generate short URLs at runtime.
+
+* `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
+* `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
+
+So based on this, to run shlink on a local docker service, you should run a command like this:
+
+```bash
+docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https shlinkio/shlink
+```
+
+### Interact with shlink's CLI on a running container.
+
+Once the shlink container is running, you can interact with the CLI tool by running `shlink` with any of the supported commands.
+
+For example, if the container is called `shlink_container`, you can generate a new API key with:
+
+```bash
+docker exec -it shlink_container shlink api-key:generate
+```
+
+Or you can list all tags with:
+
+```bash
+docker exec -it shlink_container shlink tag:list
+```
+
+Or process remaining visits with:
+
+```bash
+docker exec -it shlink_container shlink visit:process
+```
+
+All shlink commands will work the same way.
+
+You can also list all available commands just by running this:
+
+```bash
+docker exec -it shlink_container shlink
+```
+
+## Use an external DB
+
+The image comes with a working sqlite database, but in production 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.
+
+* `DB_DRIVER`: **[Mandatory]**. Use the value **mysql**, **maria** or **postgres** to prevent the sqlite database to be used.
+* `DB_NAME`: [Optional]. The database name to be used. Defaults to **shlink**.
+* `DB_USER`: **[Mandatory]**. The username credential for the database server.
+* `DB_PASSWORD`: **[Mandatory]**. The password credential for the database server.
+* `DB_HOST`: **[Mandatory]**. The host name of the server running the database engine.
+* `DB_PORT`: [Optional]. The port in which the database service is running.
+    * Default value is based on the value provided for `DB_DRIVER`:
+        * **mysql** or **maria** -> `3306`
+        * **postgres** -> `5432`
+
+> PostgreSQL is supported since v1.16.1 of this image. Do not try to use it 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 \
+    -p 8080:8080 \
+    -e SHORT_DOMAIN_HOST=doma.in \
+    -e SHORT_DOMAIN_SCHEMA=https \
+    -e DB_DRIVER=mysql \
+    -e DB_NAME=shlink \
+    -e DB_USER=root \
+    -e DB_PASSWORD=123abc \
+    -e DB_HOST=something.rds.amazonaws.com \
+    -e DB_PORT=3306 \
+    -e DISABLE_TRACK_PARAM="no-track" \
+    -e DELETE_SHORT_URL_THRESHOLD=30 \
+    -e VALIDATE_URLS=false \
+    -e "INVALID_SHORT_URL_REDIRECT_TO=https://my-landing-page.com" \
+    -e "REGULAR_404_REDIRECT_TO=https://my-landing-page.com" \
+    -e "BASE_URL_REDIRECT_TO=https://my-landing-page.com" \
+    -e "REDIS_SERVERS=tcp://172.20.0.1:6379,tcp://172.20.0.2:6379" \
+    -e "BASE_PATH=/my-campaign" \
+    -e WEB_WORKER_NUM=64 \
+    -e TASK_WORKER_NUM=32 \
+    shlinkio/shlink
+```
+
+## Provide config via volumes
+
+Rather than providing custom configuration via env vars, it is also possible ot provide config files in json format.
+
+Mounting a volume at `config/params` you will make shlink load all the files on it with the `.config.json` suffix.
+
+The whole configuration should have this format, but it can be split into multiple files that will be merged:
+
+```json
+{
+    "disable_track_param": "my_param",
+    "delete_short_url_threshold": 30,
+    "short_domain_schema": "https",
+    "short_domain_host": "doma.in",
+    "validate_url": false,
+    "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,
+    "redis_servers": [
+        "tcp://172.20.0.1:6379",
+        "tcp://172.20.0.2:6379"
+    ],
+    "db_config": {
+        "driver": "pdo_mysql",
+        "dbname": "shlink",
+        "user": "root",
+        "password": "123abc",
+        "host": "something.rds.amazonaws.com",
+        "port": "3306"
+    },
+    "not_found_redirect_to": "https://my-landing-page.com"
+}
+```
+
+> 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
+```
+
+## Multi instance considerations
+
+These are some considerations to take into account when running multiple instances of shlink.
+
+* Some operations performed by Shlink should never be run more than once at the same time (like creating the database for the first time, or downloading the GeoLite2 database). For this reason, Shlink uses a locking system.
+
+    However, these locks are locally scoped to each Shlink instance by default.
+
+    You can (and should) make the locks to be shared by all Shlink instances by using a redis server/cluster. Just define the `REDIS_SERVERS` env var with the list of servers.
+
+* **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.
+
+> **Important**: The docker image was introduced with shlink v1.15.0, so there are no official images previous to that versions.

docker/config/shlink_in_docker.local.php

@@ -0,0 +1,175 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+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;
+
+$helper = new class {
+    private const BASE62 = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    private const DB_DRIVERS_MAP = [
+        'mysql' => 'pdo_mysql',
+        'maria' => 'pdo_mysql',
+        'postgres' => 'pdo_pgsql',
+    ];
+    private const DB_PORTS_MAP = [
+        'mysql' => '3306',
+        'maria' => '3306',
+        'postgres' => '5432',
+    ];
+
+    /** @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');
+        if ($driver === null || $driver === 'sqlite') {
+            return [
+                'driver' => 'pdo_sqlite',
+                'path' => 'data/database.sqlite',
+            ];
+        }
+
+        $driverOptions = ! contains(['maria', 'mysql'], $driver) ? [] : [
+            // 1002 -> PDO::MYSQL_ATTR_INIT_COMMAND
+            1002 => 'SET NAMES utf8',
+        ];
+        return [
+            'driver' => self::DB_DRIVERS_MAP[$driver],
+            'dbname' => env('DB_NAME', 'shlink'),
+            'user' => env('DB_USER'),
+            'password' => env('DB_PASSWORD'),
+            'host' => env('DB_HOST'),
+            'port' => env('DB_PORT', self::DB_PORTS_MAP[$driver]),
+            'driverOptions' => $driverOptions,
+        ];
+    }
+
+    public function getNotFoundRedirectsConfig(): array
+    {
+        return [
+            'invalid_short_url' => env('INVALID_SHORT_URL_REDIRECT_TO', env('NOT_FOUND_REDIRECT_TO')),
+            'regular_404' => env('REGULAR_404_REDIRECT_TO'),
+            'base_url' => env('BASE_URL_REDIRECT_TO'),
+        ];
+    }
+};
+
+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),
+    ],
+
+    'entity_manager' => [
+        'connection' => $helper->getDbConfig(),
+    ],
+
+    'url_shortener' => [
+        'domain' => [
+            'schema' => env('SHORT_DOMAIN_SCHEMA', 'http'),
+            'hostname' => env('SHORT_DOMAIN_HOST', ''),
+        ],
+        'validate_url' => (bool) env('VALIDATE_URLS', true),
+    ],
+
+    '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'],
+            ],
+        ],
+    ],
+
+    'dependencies' => [
+        'aliases' => env('REDIS_SERVERS') === null ? [] : [
+            'lock_store' => 'redis_lock_store',
+        ],
+    ],
+
+    'redis' => [
+        'servers' => env('REDIS_SERVERS'),
+    ],
+
+    'router' => [
+        'base_path' => env('BASE_PATH', ''),
+    ],
+
+    'zend-expressive-swoole' => [
+        'swoole-http-server' => [
+            'options' => [
+                'worker_num' => (int) env('WEB_WORKER_NUM', 16),
+                'task_worker_num' => (int) env('TASK_WORKER_NUM', 16),
+            ],
+        ],
+    ],
+
+];

docker/docker-entrypoint.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+set -e
+
+cd /etc/shlink
+
+echo "Creating fresh database if needed..."
+php bin/cli db:create -n -q
+
+echo "Updating database..."
+php bin/cli db:migrate -n -q
+
+echo "Generating proxies..."
+php vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies -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

docs/swagger/definitions/Health.json

@@ -0,0 +1,31 @@
+{
+    "type": "object",
+    "properties": {
+        "status": {
+            "type": "string",
+            "enum": [
+                "pass",
+                "fail"
+            ],
+            "description": "The status of the service"
+        },
+        "version": {
+            "type": "string",
+            "description": "Shlink version"
+        },
+        "links": {
+            "type": "object",
+            "properties": {
+                "about": {
+                    "type": "string",
+                    "description": "About shlink"
+                },
+                "project": {
+                    "type": "string",
+                    "description": "Shlink project repository"
+                }
+            },
+            "description": "A list of links"
+        }
+    }
+}

docs/swagger/definitions/ShortUrl.json

@@ -29,6 +29,9 @@
             },
             "description": "A list of tags applied to this short URL"
         },
+        "meta": {
+            "$ref": "./ShortUrlMeta.json"
+        },
         "originalUrl": {
             "deprecated": true,
             "type": "string",

docs/swagger/definitions/ShortUrlMeta.json

@@ -0,0 +1,21 @@
+{
+    "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
+        }
+    }
+}

docs/swagger/paths/health.json

@@ -0,0 +1,62 @@
+{
+    "get": {
+        "operationId": "health",
+        "tags": [
+            "Monitoring"
+        ],
+        "summary": "Check healthiness",
+        "description": "Checks the healthiness of the service, making sure it can access required resources.",
+        "responses": {
+            "200": {
+                "description": "The passing health status",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Health.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "status": "pass",
+                        "version": "1.16.0",
+                        "links": {
+                            "about": "https://shlink.io",
+                            "project": "https://github.com/shlinkio/shlink"
+                        }
+                    }
+                }
+            },
+            "503": {
+                "description": "The failing health status",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Health.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "status": "fail",
+                        "version": "1.16.0",
+                        "links": {
+                            "about": "https://shlink.io",
+                            "project": "https://github.com/shlinkio/shlink"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/v1_short-urls.json

@@ -100,7 +100,12 @@
                                     "tags": [
                                         "games",
                                         "tech"
-                                    ]
+                                    ],
+                                    "meta": {
+                                        "validSince": "2017-01-21T00:00:00+02:00",
+                                        "validUntil": null,
+                                        "maxVisits": 100
+                                    }
                                 },
                                 {
                                     "shortCode": "12Kb3",
@@ -110,7 +115,12 @@
                                     "visitsCount": 1029,
                                     "tags": [
                                         "shlink"
-                                    ]
+                                    ],
+                                    "meta": {
+                                        "validSince": null,
+                                        "validUntil": null,
+                                        "maxVisits": null
+                                    }
                                 },
                                 {
                                     "shortCode": "123bA",
@@ -118,7 +128,12 @@
                                     "longUrl": "https://www.google.com",
                                     "dateCreated": "2015-10-01T20:34:16+02:00",
                                     "visitsCount": 25,
-                                    "tags": []
+                                    "tags": [],
+                                    "meta": {
+                                        "validSince": "2017-01-21T00:00:00+02:00",
+                                        "validUntil": null,
+                                        "maxVisits": null
+                                    }
                                 }
                             ],
                             "pagination": {
@@ -151,7 +166,7 @@
             "Short URLs"
         ],
         "summary": "Create short URL",
-        "description": "Creates a new short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
+        "description": "Creates a new short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.<br></br>**Param findIfExists:**: Starting with v1.16, this new param allows to force shlink to return existing short URLs when found based on provided params, instead of creating a new one. However, it might add complexity and have unexpected outputs.\n\nThese are the use cases:\n* Only the long URL is provided: It will return the newest match or create a new short URL if none is found.\n* Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.\n* Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.",
         "security": [
             {
                 "ApiKey": []
@@ -197,6 +212,14 @@
                             "maxVisits": {
                                 "description": "The maximum number of allowed visits for this short code",
                                 "type": "number"
+                            },
+                            "findIfExists": {
+                                "description": "Will force existing matching URL to be returned if found, instead of creating a new one",
+                                "type": "boolean"
+                            },
+                            "domain": {
+                                "description": "The domain to which the short URL will be attached",
+                                "type": "string"
                             }
                         }
                     }
@@ -223,7 +246,12 @@
                         "tags": [
                             "games",
                             "tech"
-                        ]
+                        ],
+                        "meta": {
+                            "validSince": "2017-01-21T00:00:00+02:00",
+                            "validUntil": null,
+                            "maxVisits": 500
+                        }
                     }
                 }
             },

docs/swagger/paths/v1_short-urls_shorten.json

@@ -64,7 +64,12 @@
                         "tags": [
                             "games",
                             "tech"
-                        ]
+                        ],
+                        "meta": {
+                            "validSince": "2017-01-21T00:00:00+02:00",
+                            "validUntil": null,
+                            "maxVisits": 100
+                        }
                     },
                     "text/plain": "https://doma.in/abc123"
                 }

docs/swagger/paths/v1_short-urls_{shortCode}.json

@@ -15,6 +15,15 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "name": "domain",
+                "in": "query",
+                "description": "The domain in which the short code should be searched for. Will fall back to default domain if not found.",
+                "required": false,
+                "schema": {
+                    "type": "string"
+                }
             }
         ],
         "security": [
@@ -44,7 +53,12 @@
                         "visitsCount": 1029,
                         "tags": [
                             "shlink"
-                        ]
+                        ],
+                        "meta": {
+                            "validSince": "2017-01-21T00:00:00+02:00",
+                            "validUntil": null,
+                            "maxVisits": 100
+                        }
                     }
                 }
             },
@@ -81,7 +95,7 @@
         }
     },
 
-    "put": {
+    "patch": {
         "operationId": "editShortUrl",
         "tags": [
             "Short URLs"
@@ -169,6 +183,95 @@
         }
     },
 
+    "put": {
+        "deprecated": true,
+        "operationId": "editShortUrlPut",
+        "tags": [
+            "Short URLs"
+        ],
+        "summary": "[DEPRECATED] Edit short URL",
+        "description": "**[DEPRECATED]** Use [editShortUrl](#/Short_URLs/getShortUrl) instead",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to edit.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "requestBody": {
+            "description": "Request body.",
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "type": "object",
+                        "properties": {
+                            "validSince": {
+                                "description": "The date (in ISO-8601 format) from which this short code will be valid",
+                                "type": "string"
+                            },
+                            "validUntil": {
+                                "description": "The date (in ISO-8601 format) until which this short code will be valid",
+                                "type": "string"
+                            },
+                            "maxVisits": {
+                                "description": "The maximum number of allowed visits for this short code",
+                                "type": "number"
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "security": [
+            {
+                "ApiKey": []
+            },
+            {
+                "Bearer": []
+            }
+        ],
+        "responses": {
+            "204": {
+                "description": "The short code has been properly updated."
+            },
+            "400": {
+                "description": "Provided meta arguments are invalid.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
+            "404": {
+                "description": "No short URL was found for provided short code.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    },
+
     "delete": {
         "operationId": "deleteShortUrl",
         "tags": [

docs/swagger/paths/v1_short-urls_{shortCode}_visits.json

@@ -33,6 +33,24 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "name": "page",
+                "in": "query",
+                "description": "The page to display. Defaults to 1",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
+            },
+            {
+                "name": "itemsPerPage",
+                "in": "query",
+                "description": "The amount of items to return on every page. Defaults to all the items",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
             }
         ],
         "security": [
@@ -59,6 +77,9 @@
                                             "items": {
                                                 "$ref": "../definitions/Visit.json"
                                             }
+                                        },
+                                        "pagination": {
+                                            "$ref": "../definitions/Pagination.json"
                                         }
                                     }
                                 }
@@ -96,7 +117,14 @@
                                     "userAgent": "some_web_crawler/1.4",
                                     "visitLocation": null
                                 }
-                            ]
+                            ],
+                            "pagination": {
+                                "currentPage": 5,
+                                "pagesCount": 12,
+                                "itemsPerPage": 10,
+                                "itemsInCurrentPage": 10,
+                                "totalItems": 115
+                            }
                         }
                     }
                 }

docs/swagger/paths/{shortCode}.json

@@ -0,0 +1,36 @@
+{
+    "get": {
+        "operationId": "shortUrl",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL",
+        "description": "Represents a short URL. Tracks the visit and redirects tio the corresponding long URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "302": {
+                "description": "Visit properly tracked and redirected"
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_preview.json

@@ -0,0 +1,45 @@
+{
+    "get": {
+        "deprecated": true,
+        "operationId": "shortUrlPreview",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL preview image",
+        "description": "Returns the preview of the page behind a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Image in PNG format",
+                "content": {
+                    "image/png": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_qr-code.json

@@ -0,0 +1,56 @@
+{
+    "get": {
+        "operationId": "shortUrlQrCode",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL QR code",
+        "description": "Generates a QR code image pointing to a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "size",
+                "in": "path",
+                "description": "The size of the image to be returned.",
+                "required": false,
+                "schema": {
+                    "type": "integer",
+                    "minimum": 50,
+                    "maximum": 1000,
+                    "default": 300
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "QR code in PNG format",
+                "content": {
+                    "image/png": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_track.json

@@ -0,0 +1,44 @@
+{
+    "get": {
+        "operationId": "trackShortUrl",
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL tracking pixel",
+        "description": "Generates a 1px transparent image which can be used to track emails with a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Image in GIF format",
+                "content": {
+                    "image/gif": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/swagger.json

@@ -6,15 +6,20 @@
         "version": "1.0"
     },
 
+    "externalDocs": {
+        "url": "https://shlink.io/api-docs",
+        "description": "Find more info on how to start using this API here"
+    },
+
     "servers": [
         {
-            "url": "{schema}://{server}/rest",
+            "url": "{scheme}://{host}",
             "variables": {
-                "schema": {
+                "scheme": {
                     "default": "https",
                     "enum": ["https", "http"]
                 },
-                "server": {
+                "host": {
                     "default": ""
                 }
             }
@@ -30,7 +35,7 @@
                 "name": "X-Api-Key"
             },
             "Bearer": {
-                "description": "**[Deprecated]** The JWT identifying a previously authenticated API key",
+                "description": "**[DEPRECATED]** The JWT identifying a previously authenticated API key",
                 "type": "http",
                 "scheme": "bearer",
                 "bearerFormat": "JWT"
@@ -51,35 +56,60 @@
             "name": "Visits",
             "description": "Operations to manage visits on short URLs"
         },
+        {
+            "name": "Monitoring",
+            "description": "Public endpoints designed to monitor the service"
+        },
+        {
+            "name": "URL Shortener",
+            "description": "Non-rest endpoints, used to be publicly exposed"
+        },
         {
             "name": "Authentication",
-            "description": "Authentication-related endpoints"
+            "description": "**[DEPRECATED]** Authentication-related endpoints"
         }
     ],
 
     "paths": {
-        "/v1/short-urls": {
+        "/rest/v1/short-urls": {
             "$ref": "paths/v1_short-urls.json"
         },
-        "/v1/short-urls/shorten": {
+        "/rest/v1/short-urls/shorten": {
             "$ref": "paths/v1_short-urls_shorten.json"
         },
-        "/v1/short-urls/{shortCode}": {
+        "/rest/v1/short-urls/{shortCode}": {
             "$ref": "paths/v1_short-urls_{shortCode}.json"
         },
-        "/v1/short-urls/{shortCode}/tags": {
+        "/rest/v1/short-urls/{shortCode}/tags": {
             "$ref": "paths/v1_short-urls_{shortCode}_tags.json"
         },
 
-        "/v1/tags": {
+        "/rest/v1/tags": {
             "$ref": "paths/v1_tags.json"
         },
 
-        "/v1/short-urls/{shortCode}/visits": {
+        "/rest/v1/short-urls/{shortCode}/visits": {
             "$ref": "paths/v1_short-urls_{shortCode}_visits.json"
         },
 
-        "/v1/authenticate": {
+        "/rest/health": {
+            "$ref": "paths/health.json"
+        },
+
+        "/{shortCode}": {
+            "$ref": "paths/{shortCode}.json"
+        },
+        "/{shortCode}/track": {
+            "$ref": "paths/{shortCode}_track.json"
+        },
+        "/{shortCode}/qr-code": {
+            "$ref": "paths/{shortCode}_qr-code.json"
+        },
+        "/{shortCode}/preview": {
+            "$ref": "paths/{shortCode}_preview.json"
+        },
+
+        "/rest/v1/authenticate": {
             "$ref": "paths/v1_authenticate.json"
         }
     }