From 0a1786c89aacb5426ad99d11d3c2e468561761ab Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Fri, 13 Sep 2019 20:36:40 +0200
Subject: [PATCH] Added support for basepath on docker image

---
 CHANGELOG.md                             | 14 +++++++++++++-
 docker/README.md                         |  2 ++
 docker/config/shlink_in_docker.local.php |  4 ++++
 3 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6ce4977c..9c341e91 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,7 +8,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 #### Added
 
-* *Nothing*
+* [#482](https://github.com/shlinkio/shlink/issues/482) Added support to serve shlink under a sub path.
+
+    The `router.base_path` config option can be defined now to set the base path from which shlink is served.
+
+    ```php
+    return [
+        'router' => [
+            'base_path' => '/foo/bar',
+        ],
+    ];
+    ```
+
+    This option will also be available on shlink-installer 1.3.0, so the installer will ask for it. It can also be provided for the docker image as the `BASE_PATH` env var.
 
 #### Changed
 
diff --git a/docker/README.md b/docker/README.md
index 2f2a4012..9f62c818 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -103,6 +103,7 @@ This is the complete list of supported env vars:
 * `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`.
 * `NOT_FOUND_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.
+* `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 `''`.
 * `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.
@@ -130,6 +131,7 @@ docker run \
     -e VALIDATE_URLS=false \
     -e "NOT_FOUND_REDIRECT_TO=https://www.google.com" \
     -e "REDIS_SERVERS=tcp://172.20.0.1:6379,tcp://172.20.0.2:6379" \
+    -e "BASE_PATH=/my-campaign" \
     shlinkio/shlink
 ```
 
diff --git a/docker/config/shlink_in_docker.local.php b/docker/config/shlink_in_docker.local.php
index e84a4467..1ee7eaed 100644
--- a/docker/config/shlink_in_docker.local.php
+++ b/docker/config/shlink_in_docker.local.php
@@ -168,4 +168,8 @@ return [
         'servers' => env('REDIS_SERVERS'),
     ],
 
+    'router' => [
+        'base_path' => env('BASE_PATH', ''),
+    ],
+
 ];