Merge pull request #619 from acelaya-forks/feature/1.21.2

Feature/1.21.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

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

.gitattributes

@@ -1,13 +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
-.env.dist export-ignore
+/module/Rest/test-api export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 .phpstorm.meta.php export-ignore
@@ -17,9 +18,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,8 +1,13 @@
 .idea
 build
+!hooks/build
 composer.lock
+composer.phar
 vendor/
-.env
 data/database.sqlite
-docs/swagger-ui
+data/shlink-tests.db
+data/GeoLite2-City.mmdb
+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,6 +1,13 @@
 tools:
-  external_code_coverage: true
+  external_code_coverage:
+    timeout: 600
 checks:
-    php:
-        code_rating: true
-        duplication: true
+  php:
+    code_rating: true
+    duplication: true
+build:
+  nodes:
+    analysis:
+      tests:
+        override:
+          - php-scrutinizer-run

.travis.yml

@@ -5,24 +5,55 @@ branches:
     - /.*/
 
 php:
-  - 7.1
-  - 7.2
+  - '7.2'
+  - '7.3'
+
+services:
+  - mysql
+  - postgresql
+  - docker
+
+cache:
+  directories:
+    - $HOME/.composer/cache/files
 
 before_install:
-  - phpenv config-add data/infra/travis-php/memcached.ini
-  - phpenv config-add data/infra/travis-php/apcu.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 --prefer-dist
 
 before_script:
-  - composer self-update
-  - composer install --no-interaction
+  - 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_script:
-  - vendor/bin/phpcov merge build --clover build/clover.xml
+after_success:
+  - rm -f build/clover.xml
+  - wget https://phar.phpunit.de/phpcov-6.0.1.phar
+  - phpdbg -qrr phpcov-6.0.1.phar merge build --clover build/clover.xml
   - wget https://scrutinizer-ci.com/ocular.phar
   - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
 
-sudo: false
+# Before deploying, build dist file for current travis tag
+before_deploy:
+  - rm -f ocular.phar
+  - ./build.sh ${TRAVIS_TAG#?}
+
+deploy:
+  - provider: releases
+    api_key:
+      secure: a9dbZchocqeuOViwUeNH54bQR5Sz7rEYXx5b9WPFtnFn9LGKKUaLbA2U91UQ9QKPrcTpsALubUYbw2CnNmvCwzaY+R8lCD3gkU4ohsEnbpnw3deOeixI74sqBHJAuCH9FSaRDGILoBMtUKx2xlzIymFxkIsgIukkGbdkWHDlRWY3oTUUuw1SQ2Xk9KDsbJQtjIc1+G/O6gHaV4qv/R9W8NPmJExKTNDrAZbC1vIUnxqp4UpVo1hst8qPd1at94CndDYM5rG+7imGbdtxTxzamt819qdTO1OfvtctKawNAm7YXZrrWft6c7gI6j6SI4hxd+ZrrPBqbaRFHkZHjnNssO/yn4SaOHFFzccmu0MzvpPCf0qWZwd3sGHVYer1MnR2mHYqU84QPlW3nrHwJjkrpq3+q0JcBY6GsJs+RskHNtkMTKV05Iz6QUI5YZGwTpuXaRm036SmavjGc4IDlMaYCk/NmbB9BKpthJxLdUpczOHpnjXXHziotWD6cfEnbjU3byfD8HY5WrxSjsNT7SKmXN3hRof7bk985ewQVjGT42O3NbnfnqjQQWr/B7/zFTpLR4f526Bkq12CdCyf5lvrbq+POkLVdJ+uFfR7ds248Ue/jBQy6kM1tWmKF9QiwisFlA84eQ4CW3I93Rp97URv+AQa9zmbD0Ve3Udp+g6nF5I=
+    file: "./build/shlink_${TRAVIS_TAG#?}_dist.zip"
+    skip_cleanup: true
+    on:
+      tags: true
+      php: '7.2'

Dockerfile

@@ -0,0 +1,57 @@
+FROM php:7.3.11-alpine3.10
+LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+
+ARG SHLINK_VERSION=1.20.2
+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
+COPY docker/config/php.ini ${PHP_INI_DIR}/conf.d/
+
+ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 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

@@ -1,9 +1,306 @@
-# Shlink
+![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/master/public/images/shlink-hero.png)
 
-[![Build Status](https://travis-ci.org/shlinkio/shlink.svg?branch=master)](https://travis-ci.org/shlinkio/shlink)
-[![Code Coverage](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/shlinkio/shlink/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Latest Stable Version](https://poser.pugx.org/shlinkio/shlink/v/stable.png)](https://packagist.org/packages/shlinkio/shlink)
-[![License](https://poser.pugx.org/shlinkio/shlink/license.png)](https://packagist.org/packages/shlinkio/shlink)
+[![Build Status](https://img.shields.io/travis/shlinkio/shlink.svg?style=flat-square)](https://travis-ci.org/shlinkio/shlink)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
+[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/master/LICENSE)
+[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://acel.me/donate)
 
-A PHP-based URL shortener application with analytics and management
+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)
+    - [Download](#download)
+    - [Configure](#configure)
+    - [Serve](#serve)
+    - [Bonus](#bonus)
+- [Update to new version](#update-to-new-version)
+- [Using a docker image](#using-a-docker-image)
+- [Using shlink](#using-shlink)
+    - [Shlink CLI Help](#shlink-cli-help)
+
+## Installation
+
+> These are the steps needed to install Shlink if you plan to manually host it. 
+>
+> Alternatively, you can use the official docker image. If that's your intention, jump directly to [Using a docker image](#using-a-docker-image)
+
+First, make sure the host where you are going to run shlink fulfills these requirements:
+
+* 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).
+
+### Download
+
+In order to run Shlink, you will need a built version of the project. There are two ways to get it.
+
+* **Using a dist file**
+
+    The easiest way to install shlink is by using one of the pre-bundled distributable packages.
+
+    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink_x.x.x_dist.zip` file you will find there.
+
+    Finally, decompress the file in the location of your choice.
+
+* **Building from sources**
+
+    If for any reason you want to build the project yourself, follow these steps:
+
+    * Clone the project with git (`git clone https://github.com/shlinkio/shlink.git`), or download it by clicking the **Clone or download** green button.
+    * Download the [Composer](https://getcomposer.org/download/) PHP package manager inside the project folder.
+    * Run `./build.sh 1.0.0`, replacing the version with the version number you are going to build (the version number is only used for the generated dist file).
+
+    After that, you will have a `shlink_x.x.x_dist.zip` dist file inside the `build` directory, that you need to decompress in the location fo your choice.
+
+    > This is the process used when releasing new shlink versions. After tagging the new version with git, the Github release is automatically created by [travis](https://travis-ci.org/shlinkio/shlink), attaching the generated dist file to it.
+
+### Configure
+
+Despite how you built the project, you now need to configure it, by following these steps:
+
+* If you are going to use MySQL, MariaDB 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.**
+* Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with shlink's API.
+
+### Serve
+
+Once Shlink is configured, you need to expose it to the web, either by using a traditional web server + fast CGI approach, or by using a [swoole](https://www.swoole.co.uk/) non-blocking server.
+
+* **Using a web server:**
+
+    For example, assuming your domain is doma.in and shlink is in the `/path/to/shlink` folder, these would be the basic configurations for Nginx and Apache.
+
+    *Nginx:*
+
+    ```nginx
+    server {
+        server_name doma.in;
+        listen 80;
+        root /path/to/shlink/public;
+        index index.php;
+        charset utf-8;
+
+        location / {
+            try_files $uri $uri/ /index.php$is_args$args;
+        }
+
+        location ~ \.php$ {
+            fastcgi_split_path_info ^(.+\.php)(/.+)$;
+            fastcgi_pass unix:/var/run/php/php7.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. Run `./vendor/bin/zend-expressive-swoole start -d` and you will get shlink running on port 8080.
+
+    However, by doing it this way, you are loosing all the access logs, and the service won't be automatically run if the server has to be restarted.
+
+    For that reason, you should create a daemon script, in `/etc/init.d/shlink_swoole`, like this one, replacing `/path/to/shlink` by the path to your shlink installation:
+
+    ```bash
+    #!/bin/bash
+    ### BEGIN INIT INFO
+    # Provides:          shlink_swoole
+    # Required-Start:    $local_fs $network $named $time $syslog
+    # Required-Stop:     $local_fs $network $named $time $syslog
+    # Default-Start:     2 3 4 5
+    # Default-Stop:      0 1 6
+    # Description:       Shlink non-blocking server with swoole
+    ### END INIT INFO
+
+    SCRIPT=/path/to/shlink/vendor/bin/zend-expressive-swoole\ start
+    RUNAS=root
+
+    PIDFILE=/var/run/shlink_swoole.pid
+    LOGDIR=/var/log/shlink
+    LOGFILE=${LOGDIR}/shlink_swoole.log
+
+    start() {
+      if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
+        echo 'Shlink with swoole already running' >&2
+        return 1
+      fi
+      echo 'Starting shlink with swoole' >&2
+      mkdir -p "$LOGDIR"
+      touch "$LOGFILE"
+      local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
+      su -c "$CMD" $RUNAS > "$PIDFILE"
+      echo 'Shlink started' >&2
+    }
+
+    stop() {
+      if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
+        echo 'Shlink with swoole not running' >&2
+        return 1
+      fi
+      echo 'Stopping shlink with swoole' >&2
+      kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
+      echo 'Shlink stopped' >&2
+    }
+
+    case "$1" in
+      start)
+        start
+        ;;
+      stop)
+        stop
+        ;;
+      restart)
+        stop
+        start
+        ;;
+      *)
+        echo "Usage: $0 {start|stop|restart}"
+    esac
+    ```
+
+    Then run these commands to enable the service and start it:
+
+    * `sudo chmod +x /etc/init.d/shlink_swoole`
+    * `sudo update-rc.d shlink_swoole defaults`
+    * `sudo update-rc.d shlink_swoole enable`
+    * `/etc/init.d/shlink_swoole start`
+
+    Now again, you can access shlink on port 8080, but this time the service will be automatically run at system start-up, and all access logs will be written in `/var/log/shlink/shlink_swoole.log` (you will probably want to [rotate those logs](https://www.digitalocean.com/community/tutorials/how-to-manage-logfiles-with-logrotate-on-ubuntu-16-04). You can find an example logrotate config file [here](data/infra/examples/shlink-daemon-logrotate.conf)).
+
+Finally access to [https://app.shlink.io](https://app.shlink.io) and configure your server to start creating short URLs.
+
+### Bonus
+
+Depending on the shlink version you installed and how you serve it, there are a couple of time-consuming tasks that shlink expects you to do manually, or at least it is recommended, since it will improve runtime performance.
+
+Those tasks can be performed using shlink's CLI tool, so it should be easy to schedule them to be run in the background (for example, using cron jobs):
+
+* **For shlink older than 1.18.0 or not using swoole to serve it**: 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.
+
+    > If you serve Shlink with swoole and use v1.18.0 at least, visit location is automatically scheduled by Shlink just after the visit occurs, using swoole's task system.
+
+* **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.
+
+    > You don't need this if you use Shlink v1.17.0 or newer, since now it downloads/updates the geolocation database automatically just before trying to use it.
+
+* 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.
+
+    > **Important!** Generating previews is considered deprecated and the feature will be removed in Shlink v2.
+
+*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.*
+
+## Update to new version
+
+When a new Shlink version is available, you don't need to repeat the entire process. Instead, follow these steps:
+
+1. Rename your existing Shlink directory to something else (ie. `shlink` ---> `shlink-old`).
+2. Download and extract the new version of Shlink, and set the directory name to that of the old version (ie. `shlink`).
+3. Run the `bin/update` script in the new version's directory to migrate your configuration over. You will be asked to provide the path to the old instance (ie. `shlink-old`).
+4. If you are using shlink with swoole, restart the service by running `/etc/init.d/shlink_swoole restart`.
+
+The `bin/update` will use the location from previous shlink version to import the configuration. It will then update the database and generate some assets shlink needs to work.
+
+**Important!** It is recommended that you don't skip any version when using this process. The update tool gets better on every version, but older versions might make assumptions.
+
+## Using a docker image
+
+Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](docker/README.md).
+
+The idea is that you can just generate a container using the image and provide custom config via env vars.
+
+## Using shlink
+
+Once shlink is installed, there are two main ways to interact with it:
+
+* **The command line**. Try running `bin/cli` and see all the [available commands](#shlink-cli-help).
+
+    All of those commands can be run with the `--help`/`-h` flag in order to see how to use them and all the available options.
+
+    It is probably a good idea to symlink the CLI entry point (`bin/cli`) to somewhere in your path, so that you can run shlink from any directory.
+
+* **The REST API**. The complete docs on how to use the API can be found [here](https://shlink.io/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
+
+    However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or you can host it yourself too.
+
+Both the API and CLI allow you to do the same operations, except for API key management, which can be done from the command line interface only.
+
+### Shlink CLI Help
+
+```
+Usage:
+  command [options] [arguments]
+
+Options:
+  -h, --help            Display this help message
+  -q, --quiet           Do not output any message
+  -V, --version         Display this application version
+      --ansi            Force ANSI output
+      --no-ansi         Disable ANSI output
+  -n, --no-interaction  Do not ask any interactive question
+  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+Available commands:
+  help                        Displays help for a command
+  list                        Lists commands
+ api-key
+  api-key:disable             Disables an API key.
+  api-key:generate            Generates a new valid API key.
+  api-key:list                Lists all the available API keys.
+ config
+  config:generate-charset     [DEPRECATED] Generates a character set sample just by shuffling the default one, "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Then it can be set in the SHORTCODE_CHARS environment variable
+  config:generate-secret      [DEPRECATED] Generates a random secret string that can be used for JWT token encryption
+ 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] [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.
+  tag:delete                  Deletes one or more tags.
+  tag:list                    Lists existing tags.
+  tag:rename                  Renames one existing tag.
+ visit
+  visit:locate                [visit:process] Resolves visits origin locations.
+  visit:update-db             [DEPRECATED] Updates the GeoLite2 database file used to geolocate IP addresses
+```
+
+> This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

bin/cli

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

bin/install

@@ -1,29 +1,12 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
-use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;
-use Symfony\Component\Console\Application;
-use Symfony\Component\Filesystem\Filesystem;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\ServiceManager\ServiceManager;
+namespace Shlinkio\Shlink;
+
+use function chdir;
+use function dirname;
 
 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]
-            ],
-        ],
-    ],
-]);
-$container->build(Application::class)->run();
+$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

@@ -1,29 +1,12 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
-use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
-use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;
-use Symfony\Component\Console\Application;
-use Symfony\Component\Filesystem\Filesystem;
-use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\ServiceManager\ServiceManager;
+namespace Shlinkio\Shlink;
+
+use function chdir;
+use function dirname;
 
 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]
-            ],
-        ],
-    ],
-]);
-$container->build(Application::class, ['isUpdate' => true])->run();
+$run = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$run(true);

build.sh

@@ -1,48 +1,45 @@
 #!/usr/bin/env bash
 set -e
 
-if [ "$#" -ne 1 ]; then
+if [[ "$#" -ne 1 ]]; then
   echo "Usage:" >&2
   echo "   $0 {version}" >&2
   exit 1
 fi
 
 version=$1
-builtcontent=$(readlink -f "../shlink_${version}_dist")
+builtcontent="./build/shlink_${version}_dist"
 projectdir=$(pwd)
+[[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
 
 # Copy project content to temp dir
 echo 'Copying project files...'
 rm -rf "${builtcontent}"
-mkdir "${builtcontent}"
-sudo chmod -R 777 "${projectdir}"/data/infra/{database,nginx}
-cp -R "${projectdir}"/* "${builtcontent}"
+mkdir -p "${builtcontent}"
+rsync -av * "${builtcontent}" \
+    --exclude=*docker* \
+    --exclude=Dockerfile \
+    --exclude-from=./.dockerignore
 cd "${builtcontent}"
 
 # Install dependencies
-rm -rf vendor
-rm -f composer.lock
-composer self-update
-composer install --no-dev --optimize-autoloader --no-progress --no-interaction
+echo "Installing dependencies with $composerBin..."
+${composerBin} self-update
+${composerBin} install --no-dev --optimize-autoloader --no-progress --no-interaction
 
 # Delete development files
 echo 'Deleting dev files...'
-rm build.sh
-rm CHANGELOG.md
 rm composer.*
-rm LICENSE
-rm indocker
-rm docker-compose.yml
-rm php*
-rm README.md
-rm -rf build
-rm -ff data/database.sqlite
-rm -rf data/infra
-rm -rf data/{cache,log,proxies}/{*,.gitignore}
-rm -rf config/params/{*,.gitignore}
-rm -rf config/autoload/{{,*.}local.php{,.dist},.gitignore}
+
+# Update shlink version in config
+sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php
 
 # Compressing file
-rm -f "${projectdir}"/build/shlink_${version}_dist.zip
-zip -ry "${projectdir}"/build/shlink_${version}_dist.zip "../shlink_${version}_dist"
+echo 'Compressing files...'
+cd "${projectdir}"/build
+rm -f ./shlink_${version}_dist.zip
+zip -ry ./shlink_${version}_dist.zip ./shlink_${version}_dist
+cd "${projectdir}"
 rm -rf "${builtcontent}"
+
+echo 'Done!'

composer.json

@@ -12,106 +12,156 @@
         }
     ],
     "require": {
-        "php": "^7.1",
-        "acelaya/ze-content-based-error-handler": "^2.2",
+        "php": "^7.2",
+        "ext-json": "*",
+        "ext-pdo": "*",
+        "akrabat/ip-address-middleware": "^1.0",
+        "cakephp/chronos": "^1.2",
         "cocur/slugify": "^3.0",
-        "doctrine/annotations": "^1.4",
-        "doctrine/cache": "^1.6",
-        "doctrine/collections": "^1.4",
-        "doctrine/common": "^2.7",
-        "doctrine/dbal": "^2.5",
-        "doctrine/migrations": "^1.4",
-        "doctrine/orm": "^2.5",
-        "endroid/qr-code": "^1.7",
+        "doctrine/cache": "^1.9",
+        "doctrine/dbal": "^2.10",
+        "doctrine/migrations": "^2.2",
+        "doctrine/orm": "^2.7",
+        "endroid/qr-code": "^3.6",
         "firebase/php-jwt": "^4.0",
-        "guzzlehttp/guzzle": "^6.2",
+        "geoip2/geoip2": "^2.9",
+        "guzzlehttp/guzzle": "^6.5.1",
+        "lstrojny/functional-php": "^1.9",
         "mikehaertl/phpwkhtmltopdf": "^2.2",
-        "monolog/monolog": "^1.21",
-        "roave/security-advisories": "dev-master",
-        "symfony/console": "^4.0",
-        "symfony/filesystem": "^4.0",
-        "symfony/process": "^4.0",
-        "theorchard/monolog-cascade": "^0.4",
-        "zendframework/zend-config": "^3.0",
-        "zendframework/zend-config-aggregator": "^1.0",
-        "zendframework/zend-diactoros": "^1.7",
-        "zendframework/zend-expressive": "^3.0",
+        "monolog/monolog": "^2.0",
+        "nikolaposa/monolog-factory": "^3.0",
+        "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.4",
+        "shlinkio/shlink-event-dispatcher": "^1.1",
+        "shlinkio/shlink-installer": "^3.3",
+        "shlinkio/shlink-ip-geolocation": "^1.2",
+        "symfony/console": "^5.0",
+        "symfony/filesystem": "^5.0",
+        "symfony/lock": "^5.0",
+        "symfony/process": "^5.0",
+        "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-problem-details": "^1.0",
+        "zendframework/zend-servicemanager": "^3.4",
+        "zendframework/zend-stdlib": "^3.2"
     },
     "require-dev": {
-        "filp/whoops": "^2.0",
-        "infection/infection": "^0.8.1",
-        "phpstan/phpstan": "0.9",
-        "phpunit/phpcov": "^5.0",
-        "phpunit/phpunit": "^7.0",
-        "slevomat/coding-standard": "^4.0",
-        "squizlabs/php_codesniffer": "^3.1 <3.2",
-        "symfony/dotenv": "^4.0",
-        "symfony/var-dumper": "^4.0",
-        "zendframework/zend-component-installer": "^2.1",
-        "zendframework/zend-expressive-tooling": "^1.0"
+        "devster/ubench": "^2.0",
+        "eaglewu/swoole-ide-helper": "dev-master",
+        "infection/infection": "^0.15.0",
+        "phpstan/phpstan-shim": "^0.11.16",
+        "phpunit/phpunit": "^8.3",
+        "roave/security-advisories": "dev-master",
+        "shlinkio/php-coding-standard": "~2.0.0",
+        "shlinkio/shlink-test-utils": "^1.2",
+        "symfony/var-dumper": "^5.0"
     },
     "autoload": {
         "psr-4": {
             "Shlinkio\\Shlink\\CLI\\": "module/CLI/src",
             "Shlinkio\\Shlink\\Rest\\": "module/Rest/src",
             "Shlinkio\\Shlink\\Core\\": "module/Core/src",
-            "Shlinkio\\Shlink\\Common\\": "module/Common/src"
+            "Shlinkio\\Shlink\\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\\PreviewGenerator\\": "module/PreviewGenerator/test"
         }
     },
     "scripts": {
-        "check": [
+        "ci": [
             "@cs",
             "@stan",
-            "@test",
-            "@func-test",
-            "@infect"
+            "@test:ci",
+            "@infect:ci"
         ],
         "cs": "phpcs",
-        "cs-fix": "phpcbf",
-        "serve": "php -S 0.0.0.0:8000 -t public/",
-        "test": "phpunit --coverage-php build/coverage-unit.cov",
-        "pretty-test": "phpunit --coverage-html build/coverage",
-        "func-test": "phpunit -c phpunit-func.xml --coverage-php build/coverage-func.cov",
-        "complete-pretty-test": [
-            "@test",
-            "@func-test",
-            "phpcov merge build --html build/html"
+        "cs:fix": "phpcbf",
+        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config --level=5 -c phpstan.neon",
+        "test": [
+            "@test:unit",
+            "@test:db",
+            "@test:api"
         ],
-        "stan": "phpstan analyse module/*/src/ --level=6 -c phpstan.neon",
-        "infect": "infection --threads=4 --min-msi=65 --only-covered --log-verbosity=2",
-        "infect-show": "infection --threads=4 --min-msi=65 --only-covered --log-verbosity=2 --show-mutations",
-        "expressive": "expressive"
+        "test:ci": [
+            "@test:unit:ci",
+            "@test:db:ci",
+            "@test:api"
+        ],
+        "test:unit": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
+        "test:unit:ci": "@test:unit --coverage-clover=build/clover.xml --coverage-xml=build/coverage-xml --log-junit=build/junit.xml",
+        "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 --coverage-php build/coverage-db.cov --testdox -c phpunit-db.xml",
+        "test:db:mysql": "DB_DRIVER=mysql composer test:db:sqlite",
+        "test:db:maria": "DB_DRIVER=maria composer test:db:sqlite",
+        "test:db:postgres": "DB_DRIVER=postgres composer test:db:sqlite",
+        "test:api": "bin/test/run-api-tests.sh",
+        "test:unit:pretty": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage",
+        "infect": "infection --threads=4 --min-msi=80 --log-verbosity=default --only-covered",
+        "infect:ci": "@infect --coverage=build",
+        "infect:show": "@infect --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": {
+        "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</>",
+        "stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
+        "test": "<fg=blue;options=bold>Runs all test suites</>",
+        "test:ci": "<fg=blue;options=bold>Runs all test suites, generating all needed reports and logs for CI envs</>",
+        "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
+        "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
+        "test: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:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
+        "infect": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
+        "infect:ci": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
+        "infect:show": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing and shows applied mutators</>",
+        "infect:test": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
+        "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
     },
     "config": {
-        "process-timeout": 0,
-        "sort-packages": true,
-        "platform": {
-            "php": "7.1.8"
-        }
+        "sort-packages": true
     }
 }

config/autoload/app_options.global.php

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

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+return [
+
+    'delete_short_urls' => [
+        'visits_threshold' => 15,
+        'check_visits_threshold' => true,
+    ],
+
+];

config/autoload/dependencies.global.php

@@ -1,28 +1,24 @@
 <?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,
             ],
         ],
+
+        'lazy_services' => [
+            'proxies_target_dir' => 'data/proxies',
+            'proxies_namespace' => 'ShlinkProxy',
+            'write_proxy_files' => true,
+        ],
     ],
 
 ];

config/autoload/dependencies.local.php.dist

@@ -0,0 +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' => '',
+            'password' => '',
+            'dbname' => 'shlink',
             'charset' => 'utf8',
         ],
     ],

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

@@ -1,8 +1,13 @@
 <?php
+
+declare(strict_types=1);
+
 return [
 
     'entity_manager' => [
         'connection' => [
+            'user' => 'root',
+            'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db',
             'driverOptions' => [

config/autoload/error-handler.global.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Common\Logger;
+use Zend\ProblemDetails\ProblemDetailsMiddleware;
+use Zend\Stratigility\Middleware\ErrorHandler;
+
+return [
+
+    'backwards_compatible_problem_details' => [
+        'default_type_fallbacks' => [
+            404 => 'NOT_FOUND',
+            500 => 'INTERNAL_SERVER_ERROR',
+        ],
+        'json_flags' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
+    ],
+
+    'error_handler' => [
+        'listeners' => [Logger\ErrorLogger::class],
+    ],
+
+    'dependencies' => [
+        'delegators' => [
+            ErrorHandler::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+            ProblemDetailsMiddleware::class => [
+                Logger\ErrorHandlerListenerAttachingDelegator::class,
+            ],
+        ],
+    ],
+
+];

config/autoload/errorhandler.local.php.dist

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

config/autoload/geolite2.global.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'geolite2' => [
+        'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
+        'temp_dir' => sys_get_temp_dir(),
+        'download_from' =>
+            'https://download.maxmind.com/app/geoip_download'
+            . '?edition_id=GeoLite2-City&license_key=G4Lm0C60yJsnkdPi&suffix=tar.gz',
+    ],
+
+];

config/autoload/installer.global.php

@@ -0,0 +1,53 @@
+<?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\UrlShortenerConfigCustomizer::NOTIFY_VISITS_WEBHOOKS,
+            Plugin\UrlShortenerConfigCustomizer::VISITS_WEBHOOKS,
+        ],
+
+        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

@@ -0,0 +1,50 @@
+<?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;
+
+$localLockFactory = 'Shlinkio\Shlink\LocalLockFactory';
+
+return [
+
+    'locks' => [
+        'locks_dir' => __DIR__ . '/../../data/locks',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
+            Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
+            Lock\LockFactory::class => ConfigAbstractFactory::class,
+            $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\LockFactory::class => [
+                LoggerAwareDelegatorFactory::class,
+            ],
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
+        Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
+        Lock\LockFactory::class => ['lock_store'],
+        $localLockFactory => ['local_lock_store'],
+    ],
+
+];

config/autoload/logger.global.php

@@ -1,32 +1,84 @@
 <?php
+
 declare(strict_types=1);
 
-use Monolog\Handler\RotatingFileHandler;
+namespace Shlinkio\Shlink;
+
+use Monolog\Formatter;
+use Monolog\Handler;
 use Monolog\Logger;
+use Monolog\Processor;
+use MonologFactory\DiContainerLoggerFactory;
+use Psr\Log\LoggerInterface;
+
+use const PHP_EOL;
+
+$processors = [
+    'exception_with_new_line' => [
+        'name' => Common\Logger\Processor\ExceptionWithNewLineProcessor::class,
+    ],
+    'psr3' => [
+        'name' => Processor\PsrLogMessageProcessor::class,
+    ],
+];
+$formatter = [
+    'name' => Formatter\LineFormatter::class,
+    'params' => [
+        'format' => '[%datetime%] %channel%.%level_name% - %message%' . PHP_EOL,
+        'allow_inline_line_breaks' => true,
+    ],
+];
 
 return [
 
     'logger' => [
-        'formatters' => [
-            'dashed' => [
-                'format' => '[%datetime%] %channel%.%level_name% - %message% %context%' . PHP_EOL,
-                'include_stacktraces' => true,
+        'Shlink' => [
+            'name' => 'Shlink',
+            'handlers' => [
+                'shlink_handler' => [
+                    'name' => Handler\RotatingFileHandler::class,
+                    'params' => [
+                        'level' => Logger::INFO,
+                        'filename' => 'data/log/shlink_log.log',
+                        'max_files' => 30,
+                    ],
+                    'formatter' => $formatter,
+                ],
             ],
+            'processors' => $processors,
         ],
-
-        'handlers' => [
-            'rotating_file_handler' => [
-                'class' => RotatingFileHandler::class,
-                'level' => Logger::INFO,
-                'filename' => 'data/log/shlink_log.log',
-                'max_files' => 30,
-                'formatter' => 'dashed',
+        'Access' => [
+            'name' => 'Access',
+            'handlers' => [
+                'access_handler' => [
+                    'name' => Handler\StreamHandler::class,
+                    'params' => [
+                        'level' => Logger::INFO,
+                        'stream' => 'php://stdout',
+                    ],
+                    'formatter' => $formatter,
+                ],
             ],
+            'processors' => $processors,
         ],
+    ],
 
-        'loggers' => [
-            'Shlink' => [
-                'handlers' => ['rotating_file_handler'],
+    'dependencies' => [
+        'factories' => [
+            'Logger_Shlink' => [DiContainerLoggerFactory::class, 'Shlink'],
+            'Logger_Access' => [DiContainerLoggerFactory::class, 'Access'],
+        ],
+        '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,12 +1,33 @@
 <?php
+
+declare(strict_types=1);
+
+use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 
+$isSwoole = extension_loaded('swoole');
+
+// For swoole, send logs to standard output
+$handler = $isSwoole
+    ? [
+        'name' => StreamHandler::class,
+        'params' => [
+            'level' => Logger::DEBUG,
+            'stream' => 'php://stdout',
+        ],
+    ]
+    : [
+        'params' => [
+            'level' => Logger::DEBUG,
+        ],
+    ];
+
 return [
 
     'logger' => [
-        'handlers' => [
-            'rotating_file_handler' => [
-                'level' => Logger::DEBUG,
+        'Shlink' => [
+            'handlers' => [
+                'shlink_handler' => $handler,
             ],
         ],
     ],

config/autoload/middleware-pipeline.global.php

@@ -1,57 +1,76 @@
 <?php
+
 declare(strict_types=1);
 
-use Shlinkio\Shlink\Common\Middleware\LocaleMiddleware;
-use Shlinkio\Shlink\Core\Response\NotFoundDelegate;
-use Shlinkio\Shlink\Rest\Middleware\BodyParserMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\CheckAuthenticationMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\CrossDomainMiddleware;
-use Shlinkio\Shlink\Rest\Middleware\PathVersionMiddleware;
+namespace Shlinkio\Shlink;
+
 use Zend\Expressive;
+use Zend\ProblemDetails;
 use Zend\Stratigility\Middleware\ErrorHandler;
 
 return [
 
     'middleware_pipeline' => [
+        'error-handler' => [
+            'middleware' => [
+                Expressive\Helper\ContentLengthMiddleware::class,
+                ErrorHandler::class,
+            ],
+        ],
+        'error-handler-rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                Rest\Middleware\CrossDomainMiddleware::class,
+                Rest\Middleware\BackwardsCompatibleProblemDetailsMiddleware::class,
+                ProblemDetails\ProblemDetailsMiddleware::class,
+            ],
+        ],
+
         'pre-routing' => [
             'middleware' => [
-                ErrorHandler::class,
-                LocaleMiddleware::class,
+                Common\Middleware\CloseDbConnectionMiddleware::class,
             ],
-            'priority' => 11,
         ],
         'pre-routing-rest' => [
             'path' => '/rest',
             'middleware' => [
-                PathVersionMiddleware::class,
+                Rest\Middleware\PathVersionMiddleware::class,
+                Rest\Middleware\ShortUrl\ShortCodePathMiddleware::class,
             ],
-            'priority' => 11,
         ],
 
         'routing' => [
             'middleware' => [
                 Expressive\Router\Middleware\RouteMiddleware::class,
             ],
-            'priority' => 10,
         ],
 
         'rest' => [
             'path' => '/rest',
             'middleware' => [
-                CrossDomainMiddleware::class,
                 Expressive\Router\Middleware\ImplicitOptionsMiddleware::class,
-                BodyParserMiddleware::class,
-                CheckAuthenticationMiddleware::class,
+                Rest\Middleware\BodyParserMiddleware::class,
+                Rest\Middleware\AuthenticationMiddleware::class,
             ],
-            'priority' => 5,
         ],
 
-        'post-routing' => [
+        'dispatch' => [
             'middleware' => [
                 Expressive\Router\Middleware\DispatchMiddleware::class,
-                NotFoundDelegate::class,
             ],
-            'priority' => 1,
+        ],
+
+        'not-found-rest' => [
+            'path' => '/rest',
+            'middleware' => [
+                ProblemDetails\ProblemDetailsNotFoundHandler::class,
+            ],
+        ],
+        'not-found' => [
+            'middleware' => [
+                Core\ErrorHandler\NotFoundRedirectHandler::class,
+                Core\ErrorHandler\NotFoundTemplateHandler::class,
+            ],
         ],
     ],
 ];

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,18 +1,16 @@
 <?php
-declare(strict_types=1);
 
-use Shlinkio\Shlink\Core\Service\UrlShortener;
-use function Shlinkio\Shlink\Common\env;
+declare(strict_types=1);
 
 return [
 
     'url_shortener' => [
         'domain' => [
-            'schema' => env('SHORTENED_URL_SCHEMA', 'http'),
-            'hostname' => env('SHORTENED_URL_HOSTNAME'),
+            'schema' => 'https',
+            'hostname' => '',
         ],
-        'shortcode_chars' => env('SHORTCODE_CHARS', UrlShortener::DEFAULT_CHARS),
         'validate_url' => true,
+        'visits_webhooks' => [],
     ],
 
 ];

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

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

config/autoload/wkhtmltopdf.global.php

@@ -1,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,33 +1,35 @@
 <?php
+
 declare(strict_types=1);
 
-use Acelaya\ExpressiveErrorHandler;
-use Shlinkio\Shlink\CLI;
-use Shlinkio\Shlink\Common;
-use Shlinkio\Shlink\Core;
-use Shlinkio\Shlink\Rest;
+namespace Shlinkio\Shlink;
+
 use Zend\ConfigAggregator;
 use Zend\Expressive;
+use Zend\ProblemDetails;
 
-/**
- * Configuration files are loaded in a specific order. First ``global.php``, then ``*.global.php``.
- * then ``local.php`` and finally ``*.local.php``. This way local settings overwrite global settings.
- *
- * The configuration can be cached. This can be done by setting ``config_cache_enabled`` to ``true``.
- *
- * Obviously, if you use closures in your config you can't cache it.
- */
+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,
-    ExpressiveErrorHandler\ConfigProvider::class,
+    Expressive\Swoole\ConfigProvider::class,
+    ProblemDetails\ConfigProvider::class,
     Common\ConfigProvider::class,
+    IpGeolocation\ConfigProvider::class,
     Core\ConfigProvider::class,
     CLI\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,23 +1,24 @@
 <?php
+
 declare(strict_types=1);
 
-use Symfony\Component\Dotenv\Dotenv;
+use Symfony\Component\Lock;
 use Zend\ServiceManager\ServiceManager;
 
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
-// If the Dotenv class exists, load env vars and enable errors
-if (class_exists(Dotenv::class)) {
-    error_reporting(E_ALL);
-    ini_set('display_errors', '1');
-    $dotenv = new Dotenv();
-    $dotenv->load(__DIR__ . '/../.env');
+// This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
+if (! class_exists('Shlinkio\Shlink\LocalLockFactory')) {
+    class_alias(Lock\LockFactory::class, 'Shlinkio\Shlink\LocalLockFactory');
 }
 
 // Build container
-$config = require __DIR__ . '/config.php';
-$container = new ServiceManager($config['dependencies']);
-$container->setService('config', $config);
-return $container;
+return (function () {
+    $config = require __DIR__ . '/config.php';
+    $container = new ServiceManager($config['dependencies']);
+    $container->setService('config', $config);
+
+    return $container;
+})();

config/run.php

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

config/test/bootstrap_api_tests.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Doctrine\ORM\EntityManager;
+use Psr\Container\ContainerInterface;
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$testHelper = $container->get(Helper\TestHelper::class);
+$config = $container->get('config');
+$em = $container->get(EntityManager::class);
+
+$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,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\TestUtils;
+
+use Psr\Container\ContainerInterface;
+
+/** @var ContainerInterface $container */
+$container = require __DIR__ . '/../container.php';
+$container->get(Helper\TestHelper::class)->createTestDb();
+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-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/php.ini

@@ -1 +1,6 @@
-date.timezone = Europe/Madrid
+display_errors=On
+error_reporting=-1
+memory_limit=-1
+log_errors_max_len=0
+zend.assertions=1
+assert.exception=1

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/infra/travis-php/apcu.ini

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

data/infra/travis-php/memcached.ini

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

data/locks/.gitignore

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

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

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20180801183328 extends AbstractMigration
+{
+    private const NEW_SIZE = 255;
+    private const OLD_SIZE = 10;
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->setSize($schema, self::NEW_SIZE);
+    }
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $this->setSize($schema, self::OLD_SIZE);
+    }
+
+    /**
+     * @param Schema $schema
+     * @param int $size
+     * @throws SchemaException
+     */
+    private function setSize(Schema $schema, int $size): void
+    {
+        $schema->getTable('short_urls')->getColumn('short_code')->setLength($size);
+    }
+}

data/migrations/Version20180913205455.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+use PDO;
+use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
+use Shlinkio\Shlink\Common\Util\IpAddress;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20180913205455 extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema): void
+    {
+        // Nothing to create
+    }
+
+    /**
+     * @param Schema $schema
+     * @throws DBALException
+     */
+    public function postUp(Schema $schema): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->select('id', 'remote_addr')
+           ->from('visits');
+        $st = $this->connection->executeQuery($qb->getSQL());
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visits', 'v')
+           ->set('v.remote_addr', ':obfuscatedAddr')
+           ->where('v.id=:id');
+
+        while ($row = $st->fetch(PDO::FETCH_ASSOC)) {
+            $addr = $row['remote_addr'] ?? null;
+            if ($addr === null) {
+                continue;
+            }
+
+            $qb->setParameters([
+                'id' => $row['id'],
+                'obfuscatedAddr' => $this->determineAddress((string) $addr),
+            ])->execute();
+        }
+    }
+
+    private function determineAddress(string $addr): ?string
+    {
+        if ($addr === IpAddress::LOCALHOST) {
+            return $addr;
+        }
+
+        try {
+            return (string) IpAddress::fromString($addr)->getObfuscatedCopy();
+        } catch (InvalidArgumentException $e) {
+            return null;
+        }
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema): void
+    {
+        // Nothing to rollback
+    }
+}

data/migrations/Version20180915110857.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20180915110857 extends AbstractMigration
+{
+    private const ON_DELETE_MAP = [
+        'visit_locations' => 'SET NULL',
+        'short_urls' => 'CASCADE',
+    ];
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $foreignKeys = $visits->getForeignKeys();
+
+        // Remove all existing foreign keys and add them again with CASCADE delete
+        foreach ($foreignKeys as $foreignKey) {
+            $visits->removeForeignKey($foreignKey->getName());
+            $foreignTable = $foreignKey->getForeignTableName();
+
+            $visits->addForeignKeyConstraint(
+                $foreignTable,
+                $foreignKey->getLocalColumns(),
+                $foreignKey->getForeignColumns(),
+                [
+                    'onDelete' => self::ON_DELETE_MAP[$foreignTable],
+                    'onUpdate' => 'RESTRICT',
+                ]
+            );
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        // Nothing to run
+    }
+}

data/migrations/Version20181020060559.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\DBAL\Types\Type;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20181020060559 extends AbstractMigration
+{
+    private const COLUMNS = [
+        'countryCode' => 'country_code',
+        'countryName' => 'country_name',
+        'regionName' => 'region_name',
+        'cityName' => 'city_name',
+    ];
+
+    /**
+     * @param Schema $schema
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->createColumns($schema->getTable('visit_locations'), self::COLUMNS);
+    }
+
+    private function createColumns(Table $visitLocations, array $columnNames): void
+    {
+        foreach ($columnNames as $name) {
+            if (! $visitLocations->hasColumn($name)) {
+                $visitLocations->addColumn($name, Type::STRING, ['notnull' => false]);
+            }
+        }
+    }
+
+    /**
+     * @throws SchemaException
+     * @throws DBALException
+     */
+    public function postUp(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        // If the camel case columns do not exist, do nothing
+        if (! $visitLocations->hasColumn('countryCode')) {
+            return;
+        }
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visit_locations');
+        foreach (self::COLUMNS as $camelCaseName => $snakeCaseName) {
+            $qb->set($snakeCaseName, $camelCaseName);
+        }
+        $qb->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No down
+    }
+}

data/migrations/Version20181020065148.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20181020065148 extends AbstractMigration
+{
+    private const CAMEL_CASE_COLUMNS = [
+        'countryCode',
+        'countryName',
+        'regionName',
+        'cityName',
+    ];
+
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+
+        foreach (self::CAMEL_CASE_COLUMNS as $name) {
+            if ($visitLocations->hasColumn($name)) {
+                $visitLocations->dropColumn($name);
+            }
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No down
+    }
+}

data/migrations/Version20181110175521.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 Version20181110175521 extends AbstractMigration
+{
+    /**
+     * @throws SchemaException
+     */
+    public function up(Schema $schema): void
+    {
+        $this->getUserAgentColumn($schema)->setLength(512);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $this->getUserAgentColumn($schema)->setLength(256);
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    private function getUserAgentColumn(Schema $schema): Column
+    {
+        return $schema->getTable('visits')->getColumn('user_agent');
+    }
+}

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

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace <namespace>;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version<version> extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+<up>
+    }
+
+    public function down(Schema $schema): void
+    {
+<down>
+    }
+}

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.17.6-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,30 @@ 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
+            - ./data/infra/php.ini:/usr/local/etc/php/php.ini
+        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 +55,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,230 @@
+# 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:stable
+```
+
+### Interact with shlink's CLI on a running container.
+
+Once the shlink container is running, you can interact with the CLI tool by running `shlink` with any of the supported commands.
+
+For example, if the container is called `shlink_container`, you can generate a new API key with:
+
+```bash
+docker exec -it shlink_container shlink api-key:generate
+```
+
+Or you can list all tags with:
+
+```bash
+docker exec -it shlink_container shlink tag:list
+```
+
+Or 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:stable
+```
+
+You could even link to a local database running on a different container:
+
+```bash
+docker run --name shlink -p 8080:8080 [...] -e DB_HOST=some_mysql_container --link some_mysql_container shlinkio/shlink:stable
+```
+
+> If you have considered using SQLite but sharing the database file with a volume, read [this issue](https://github.com/shlinkio/shlink-docker-image/issues/40) first.
+
+## 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.
+* `VISITS_WEBHOOKS`: A comma-separated list of URLs that will receive a `POST` request when a short URL receives a visit.
+* `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 \
+    -e "VISITS_WEBHOOKS=http://my-api.com/api/v2.3/notify,https://third-party.io/foo" \
+    shlinkio/shlink:stable
+```
+
+## 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"
+    ],
+    "visits_webhooks": [
+        "http://my-api.com/api/v2.3/notify",
+        "https://third-party.io/foo"
+    ],
+    "db_config": {
+        "driver": "pdo_mysql",
+        "dbname": "shlink",
+        "user": "root",
+        "password": "123abc",
+        "host": "something.rds.amazonaws.com",
+        "port": "3306"
+    },
+    "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:stable
+```
+
+## 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/php.ini

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

docker/config/shlink_in_docker.local.php

@@ -0,0 +1,176 @@
+<?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'),
+        ];
+    }
+
+    public function getVisitsWebhooks(): array
+    {
+        $webhooks = env('VISITS_WEBHOOKS');
+        return $webhooks === null ? [] : explode(',', $webhooks);
+    }
+};
+
+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),
+        'visits_webhooks' => $helper->getVisitsWebhooks(),
+    ],
+
+    'not_found_redirects' => $helper->getNotFoundRedirectsConfig(),
+
+    'logger' => [
+        'Shlink' => [
+            'handlers' => [
+                'shlink_handler' => [
+                    'name' => StreamHandler::class,
+                    'params' => [
+                        'level' => Logger::INFO,
+                        'stream' => 'php://stdout',
+                    ],
+                ],
+            ],
+        ],
+    ],
+
+    '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/Error.json

@@ -1,13 +1,32 @@
 {
     "type": "object",
+    "required": ["type", "title", "detail", "status"],
     "properties": {
-        "code": {
+        "type": {
             "type": "string",
             "description": "A machine unique code"
         },
+        "title": {
+            "type": "string",
+            "description": "A unique title"
+        },
+        "detail": {
+            "type": "string",
+            "description": "A human-friendly error description"
+        },
+        "status": {
+            "type": "number",
+            "description": "HTTP response status code"
+        },
+        "code": {
+            "type": "string",
+            "description": "**[Deprecated] Use type instead. Not returned for v2 of the REST API** A machine unique code",
+            "deprecated": true
+        },
         "message": {
             "type": "string",
-            "description": "A human-friendly error message"
+            "description": "**[Deprecated] Use detail instead. Not returned for v2 of the REST API** A human-friendly error message",
+            "deprecated": true
         }
     }
 }

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/Pagination.json

@@ -3,11 +3,23 @@
     "properties": {
         "currentPage": {
             "type": "integer",
-            "description": "The number of current page being displayed."
+            "description": "The number of current page."
         },
         "pagesCount": {
             "type": "integer",
-            "description": "The total number of pages that can be displayed."
+            "description": "The total number of pages that can be obtained."
+        },
+        "itemsPerPage": {
+            "type": "integer",
+            "description": "The number of items for every page."
+        },
+        "itemsInCurrentPage": {
+            "type": "integer",
+            "description": "The number of items in current page (could be smaller than itemsPerPage)."
+        },
+        "totalItems": {
+            "type": "integer",
+            "description": "The total number of items among all pages."
         }
     }
 }

docs/swagger/definitions/ShortUrl.json

@@ -5,7 +5,11 @@
             "type": "string",
             "description": "The short code for this short URL."
         },
-        "originalUrl": {
+        "shortUrl": {
+            "type": "string",
+            "description": "The short URL."
+        },
+        "longUrl": {
             "type": "string",
             "description": "The original long URL."
         },
@@ -24,6 +28,14 @@
                 "type": "string"
             },
             "description": "A list of tags applied to this short URL"
+        },
+        "meta": {
+            "$ref": "./ShortUrlMeta.json"
+        },
+        "originalUrl": {
+            "deprecated": true,
+            "type": "string",
+            "description": "The original long URL. [DEPRECATED. Use longUrl instead]"
         }
     }
 }

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
+        }
+    }
+}