From 323b9e0c67d960a9c31f936930fb1a39873d88ab Mon Sep 17 00:00:00 2001
From: TiynGER <kantemarten@googlemail.com>
Date: Sat, 9 May 2020 23:17:12 +0200
Subject: [PATCH] adding url-shortener

---
 applications/url-shortener.md | 94 +++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 applications/url-shortener.md

diff --git a/applications/url-shortener.md b/applications/url-shortener.md
new file mode 100644
index 0000000..2206121
--- /dev/null
+++ b/applications/url-shortener.md
@@ -0,0 +1,94 @@
+# URL-Shortener
+
+## Setup Server
+
+### Docker
+
+The official container and documentation was made by [yourls](https://hub.docker.com/_/yourls).
+
+#### YOURLS
+
+##### Environment-variables
+Set the following variables with the -e tag.
+
+| Name | Usage                                                | Default |
+| ---- | ---------------------------------------------------- | ------- |
+| YOURLS\_DB\_PASS | database password                        |         |
+| YOURLS\_SITE | domain/site name of yourls                   |         |
+| YOURLS\_USER | username for yourls admin                    |         |
+| YOURLS\_PASS | password for yourls admin                    |         |
+
+##### Volumes
+
+Set the following volumes with the -v tag.
+
+| Volume-Name      | Container mount | Description             |
+| ---------------- | --------------- | ----------------------- |
+| yourls           | /var/www/html   | yourls specific html    |
+
+##### Ports
+
+Set the following ports with the -p tag.
+
+| Container Port | Recommended outside port | Protocol | Description       |
+| -------------- | ------------------------ | -------- | ----------------- |
+| 80             | 80                       | TCP      | dns protocol port |
+
+#### MySQL
+
+##### Environment-variables
+Set the following variables with the -e tag.
+
+| Name | Usage                                                | Default |
+| ---- | ---------------------------------------------------- | ------- |
+| MYSQL\_ROOT\_PASSWORD | database password                   |         |
+
+##### Volumes
+
+Set the following volumes with the -v tag.
+
+| Volume-Name      | Container mount | Description             |
+| ---------------- | --------------- | ----------------------- |
+| mysql            | /var/cache/bind | database for yourls     |
+
+#### Rebuild
+
+```
+#!/bin/sh
+docker-compose down
+docker-compose up -d
+```
+
+#### Docker-Compose.yml
+
+```
+version: '3.1'
+services:
+    yourls:
+        image: yourls
+        restart: unless-stopped
+        ports:
+            - 7006:80
+        environment:
+            YOURLS_DB_PASS: mysql_pw
+            YOURLS_SITE: https://domain.tld
+            YOURLS_USER: admin_username
+            YOURLS_PASS: admin_password
+            YOURLS_PRIVATE: 'true'
+        volumes:
+            - yourls:/var/www/html
+
+    mysql:
+        image: mysql:5.7
+        restart: unless-stopped
+        environment:
+            MYSQL_ROOT_PASSWORD: mysql_pw
+        volumes:
+            - mysql:/var/lib/mysql
+
+volumes:
+    yourls:
+        driver: local
+    mysql:
+        driver: local
+```