HowtoForge

Wie man Shlink URL Shortener mit Nginx auf Ubuntu 20.04 installiert

von ·

Shlink ist ein Open-Source und selbstgehosteter URL-Shortener, der in PHP geschrieben wurde. Er wird verwendet, um Kurz-URLs von der Kommandozeile aus zu generieren und zu verwalten. Es erlaubt dir, alle Besuche deiner Kurz-URLs zu verfolgen, einschließlich, Standort, Browser oder Referrer. Er kann mit Tools von Drittanbietern über die Shlink API integriert werden. Es bietet ein Kommandozeilen-Interface zum Kürzen von URLs.

In diesem Tutorial zeige ich dir, wie du Shlink auf Ubuntu 20.04 installierst.

Voraussetzungen

  • Ein Server, auf dem Ubuntu 20.04 läuft.
  • Ein gültiger Domainname, der auf die IP deines Servers zeigt.
  • Ein Root-Passwort ist auf dem Server konfiguriert.

Erste Schritte

Aktualisiere zunächst die Systempakete auf die aktuelle Version, indem du den folgenden Befehl ausführst:

apt-get update -y

Sobald alle Pakete aktualisiert sind, kannst du mit dem nächsten Schritt fortfahren.

LEMP-Server installieren

Als erstes installierst du Nginx, PHP, MariaDB und andere benötigte Pakete mit dem folgenden Befehl:

apt-get install nginx mariadb-server php-apcu php7.4 php7.4-fpm php7.4-mysql php7.4-gd php7.4-common php7.4-curl php7.4-intl php7.4-gmp php7.4-xml php-dev php-pear unzip -y

Sobald alle Pakete installiert sind, kannst du mit dem nächsten Schritt fortfahren.

Shlink Datenbank erstellen

Shlink benutzt MariaDB als Datenbank-Backend. Daher musst du eine Datenbank und einen Benutzer für Shlink erstellen. Verbinde dich zuerst mit der MariaDB mit dem folgenden Befehl:

mysql

Sobald du verbunden bist, erstelle eine Datenbank und einen Benutzer mit dem folgenden Befehl:

MariaDB [(none)]> CREATE DATABASE shlink;
MariaDB [(none)]> GRANT ALL ON shlink.* TO 'shlink'@'localhost' IDENTIFIED BY 'password';

Als nächstes lösche die Privilegien und verlasse die MariaDB mit dem folgenden Befehl:

MariaDB [(none)]> FLUSH PRIVILEGES;
MariaDB [(none)]> EXIT;

Shlink herunterladen

Als erstes musst du die neueste Version von Shlink von der offiziellen Downloadseite herunterladen:

wget https://github.com/shlinkio/shlink/releases/download/v2.7.1/shlink2.7.1_php7.4_dist.zip

Sobald der Download abgeschlossen ist, entpacke die heruntergeladene Datei mit dem folgenden Befehl:

unzip shlink2.7.1_php7.4_dist.zip

Als nächstes verschiebst du das entpackte Verzeichnis in das Nginx Web Root Verzeichnis:

mv shlink2.7.1_php7.4_dist /var/www/html/shlink

Setze als Nächstes die richtigen Rechte und Eigentümer mit dem folgenden Befehl:

chown -R www-data:www-data /var/www/html/shlink/
chmod -R 755 /var/www/html/shlink/

Shlink installieren

Als nächstes führst du den folgenden Befehl aus, um die Installation zu starten:

sudo -u www-data php7.4 /var/www/html/shlink/bin/install

Du wirst aufgefordert, die Datenbank wie unten gezeigt auszuwählen:

 Welcome to Shlink!!
 This tool will guide you through the installation process.

DATABASE
========

 Select database type [MySQL]:
  [0] MySQL
  [1] MariaDB
  [2] PostgreSQL
  [3] MicrosoftSQL
  [4] SQLite
 > 1

Wähle eine beliebige Option und drücke Enter. Du wirst aufgefordert, den Namen der Datenbank einzugeben, wie unten gezeigt:

 Database name [shlink]:
 >

Gib den Namen deiner Datenbank an oder drücke Enter, um die Standardeinstellung zu wählen. Du wirst aufgefordert, den Datenbank-Host anzugeben:

 Database host [localhost]:
 >

Gib deinen Datenbank-Host an oder drücke Enter, um die Standardeinstellung zu wählen. Du wirst aufgefordert, den Datenbankport anzugeben:

 Database port [3306]:
 >

Gib deinen Datenbankport an oder drücke Enter, um die Standardeinstellung zu wählen. Du wirst aufgefordert, deinen Datenbank-Benutzernamen einzugeben:

 Database username:
 > shlink

Gib deinen Datenbank-Benutzernamen ein und drücke Enter. Du wirst nach dem Passwort für deinen Datenbankbenutzer gefragt:

 Database password:
 > password

Gib dein Datenbank-Benutzerpasswort ein und drücke Enter. Du wirst gefragt, ob du einen Unix-Socket angeben möchtest.

 Unix socket (leave empty to not use a socket):
 >

Lass es leer und drücke Enter. Du wirst nach dem Domainnamen gefragt:

URL SHORTENER
=============

 Default domain for generated short URLs:
 > shlink.linuxbuz.com

Gib deinen Domainnamen ein und drücke Enter. Du wirst gefragt, ob du das Schema auswählen möchtest:

 Select schema for generated short URLs [http]:
  [0] http
  [1] https
 > 0

Wähle eine Option und drücke Enter. Du wirst gefragt, ob du lange URLs validieren möchtest:

 Do you want to validate long urls by 200 HTTP status code on response? (yes/no) [yes]:
 >

Wähle die Standardoption und drücke Enter. Du wirst aufgefordert, die Länge der generierten Shortcodes anzugeben:

 What is the default length you want generated short codes to have? (You will still be able to override this on every created short URL) [5]:
 >

Wähle den Standardwert und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Do you want Shlink to resolve the short URL title based on the long URL 's title tag (if any)? Otherwise, it will be kept empty unless explicitly provided. (yes/no) [no]:
 >

Wähle die Standardantwort und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Provide a GeoLite2 license key. (Leave empty to use default one, but it is strongly recommended to get your own. Go to https://shlink.io/documentation/geolite-license-key to know how to get it):
 >

Lass es leer und drücke Enter. Du solltest die folgende Ausgabe sehen:

 What kind of redirect do you want your short URLs to have? [All visits will always be tracked. Not that good for SEO.]:
  [302] All visits will always be tracked. Not that good for SEO.
  [301] Best option for SEO. Redirect will be cached for a short period of time, making some visits not to be tracked.
 > 301

Wähle eine beliebige Option und drücke Enter. Du solltest die folgende Ausgabe sehen:

 How long (in seconds) do you want your redirects to be cached by visitors? [30]:
 >

Wähle Standardwerte und drücke Enter. Du solltest die folgende Ausgabe sehen:

TRACKING
========

 Do you want track orphan visits? (visits to the base URL, invalid short URLs or other "not found" URLs) (yes/no) [yes]:
 >

Wähle die Standardoption und drücke die Eingabetaste. Du solltest die folgende Ausgabe sehen:

 Provide a parameter name that you will be able to use to disable tracking on specific request to short URLs (leave empty and this feature won't be enabled):
 >

Drücke einfach Enter. Du solltest die folgende Ausgabe sehen:

 Do you want to completely disable visits tracking? (yes/no) [no]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Do you want to disable tracking of visitors' IP addresses? (yes/no) [no]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Do you want visitors' remote IP addresses to be anonymized before persisting them to the database? (yes/no) [yes]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Do you want to disable tracking of visitors' "User Agents"? (yes/no) [no]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Do you want to disable tracking of visitors' "Referrers"? (yes/no) [no]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

REDIRECTS
=========

 Custom URL to redirect to when a user hits Shlink's base URL (If no value is provided, the user will see a default "404 not found" page):
 > http://shlink.linuxbuz.com

Gib deinen Domainnamen ein und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Custom URL to redirect to when a user hits an invalid short URL (If no value is provided, the user will see a default "404 not found" page):
 > http://shlink.linuxbuz.com

Gib deinen Domänennamen ein und drücke Enter. Du solltest die folgende Ausgabe sehen:

 Custom URL to redirect to when a user hits a not found URL other than an invalid short URL (If no value is provided, the user will see a default "404 not found" page):
 > http://shlink.linuxbuz.com

Gib deinen Domainnamen ein und drücke die Eingabetaste. Du solltest die folgende Ausgabe sehen:

APPLICATION
===========

 Do you want to enable a safety check which will not allow short URLs to be deleted after receiving a specific amount of visits? (yes/no) [yes]:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

 What is the amount of visits from which the system will not allow short URLs to be deleted? [15]:
 >

Wähle die Standardoption und drücke die Eingabetaste. Du solltest die folgende Ausgabe sehen:

 What is the path from which shlink is going to be served? (Leave empty if you plan to serve shlink from the root of the domain) []:
 >

Wähle die Standardoption und drücke Enter. Du solltest die folgende Ausgabe sehen:

INTEGRATIONS
============

 Provide a comma-separated list of redis server URIs which will be used for shared caching purposes under shlink multi-instance contexts (Leave empty if you don't want to use redis cache):
 > 

 Custom configuration properly generated!

Initializing database... Success!
Updating database... Success!
Generating proxies... Success!
Downloading GeoLite2 db file... Success!

                                                                                                                        
 [OK] Installation complete!

Nginx für Shlink konfigurieren

Als nächstes musst du eine Nginx Virtual Host Datei für Shlink erstellen. Du kannst sie mit dem folgenden Befehl erstellen:

nano /etc/nginx/conf.d/shlink.conf

Füge die folgenden Zeilen hinzu:

server {
   listen 80;
   server_name shlink.example.com;

   root /var/www/html/shlink/public;
   error_log /var/log/nginx/shlink.error;
   access_log /var/log/nginx/shlink.access;

   index index.php index.html index.htm index.nginx-debian.html;

   location / {
     # try to serve file directly, fallback to app.php
     try_files $uri /index.php$is_args$args;
   }

   # redirect some entire folders
     rewrite ^/(vendor|translations|build)/.* /index.php break;

   location ~ \.php$ {
     fastcgi_split_path_info ^(.+\.php)(/.+)$;
     fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
     fastcgi_index index.php;
     fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
     include fastcgi_params;
   }

}

Speichere und schließe die Datei und überprüfe dann Nginx auf Fehler mit dem folgenden Befehl:

nginx -t

Du solltest die folgende Ausgabe erhalten:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

Starte als nächstes den Nginx-Dienst neu, um die Änderungen zu übernehmen:

systemctl restart nginx

Du kannst den Status von Nginx auch mit dem folgenden Befehl überprüfen:

systemctl status nginx

Du solltest die folgende Ausgabe erhalten:

? nginx.service - A high performance web server and a reverse proxy server
     Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
     Active: active (running) since Wed 2021-06-02 05:28:30 UTC; 4s ago
       Docs: man:nginx(8)
    Process: 25639 ExecStartPre=/usr/sbin/nginx -t -q -g daemon on; master_process on; (code=exited, status=0/SUCCESS)
    Process: 25653 ExecStart=/usr/sbin/nginx -g daemon on; master_process on; (code=exited, status=0/SUCCESS)
   Main PID: 25655 (nginx)
      Tasks: 2 (limit: 2353)
     Memory: 2.6M
     CGroup: /system.slice/nginx.service
             ??25655 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
             ??25656 nginx: worker process

Jun 02 05:28:29 ubuntu2004 systemd[1]: Starting A high performance web server and a reverse proxy server...
Jun 02 05:28:30 ubuntu2004 systemd[1]: Started A high performance web server and a reverse proxy server.

Du kannst nun den eingerichteten Shlink-Client installieren, um die URL zu verkürzen.

Du kannst die Kurz-URL auch über die Kommandozeile auf deinem Server generieren:

sudo -u www-data php7.4 /var/www/html/shlink/bin/cli short-url:generate

Um alle Kurz-URLs aufzulisten, führe den folgenden Befehl aus:

sudo -u www-data php7.4 /var/www/html/shlink/bin/cli short-url:list

Um alle Hilfeinformationen anzuzeigen, führe den folgenden Befehl aus:

sudo -u www-data php7.4 /var/www/html/shlink/bin/cli

Fazit

Herzlichen Glückwunsch! Du hast Shlink URL shortener erfolgreich auf Ubuntu 20.04 installiert. Du kannst nun URLs über die CLI-Schnittstelle oder den webbasierten Client verkürzen.

Das könnte dich auch interessieren …