shlink -Download - shlink Quellcode-Download

shlink

Anderer Quellcode

v4.2.5

Herunterladen

Ein PHP-basierter, selbst gehosteter URL-Shortener, mit dem Sie verkürzte URLs unter Ihrer eigenen Domain bereitstellen können.

Inhaltsverzeichnis

Vollständige Dokumentation
Docker-Image
Selbst gehostet

Herunterladen
Konfigurieren

Shlink verwenden
Mitwirken

Vollständige Dokumentation

Dieses Dokument enthält die Grundlagen für den Einstieg in Shlink. Wenn Sie alles erfahren möchten, was Sie damit machen können, besuchen Sie die vollständige durchsuchbare Dokumentation.

Docker-Image

Sie können lernen, wie Sie das offizielle Docker-Image verwenden, indem Sie die Dokumente lesen.

Die Idee ist, dass Sie einfach einen Container mit dem Image generieren und die benutzerdefinierte Konfiguration über Env-Variablen bereitstellen können.

Selbst gehostet

Stellen Sie zunächst sicher, dass der Host, auf dem Sie shlink ausführen möchten, diese Anforderungen erfüllt:

PHP 8.2 oder 8.3
Die nächsten PHP-Erweiterungen: json, curl, pdo, intl, gd und gmp/bcmath.

Die Erweiterung apcu wird empfohlen, wenn Sie RoadRunner nicht verwenden möchten.
Die XML-Erweiterung ist erforderlich, wenn Sie QR-Codes im SVG-Format generieren möchten.
Sockets und bcmath-Erweiterungen sind erforderlich, wenn Sie eine Integration mit einer RabbitMQ-Instanz wünschen.

MySQL, MariaDB, PostgreSQL, MicrosoftSQL oder SQLite.

Sie benötigen außerdem die entsprechende PDO-Variante für die Datenbank, die Sie verwenden möchten: pdo_mysql , pdo_pgsql , pdo_sqlsrv oder pdo_sqlite .

Herunterladen

Um Shlink auszuführen, benötigen Sie eine erstellte Version des Projekts. Es gibt zwei Möglichkeiten, es zu bekommen.

Verwenden einer dist-Datei
Der einfachste Weg, Shlink zu installieren, ist die Verwendung eines der vorgefertigten verteilbaren Pakete.
Gehen Sie zur neuesten Version und laden Sie die Datei shlink*_dist.zip herunter, die Ihren Anforderungen entspricht. Sie finden eine für jede unterstützte PHP-Version.
Dekomprimieren Sie abschließend die Datei am Speicherort Ihrer Wahl.
Aus Quellen bauen
Wenn Sie das Projekt aus irgendeinem Grund selbst erstellen möchten, befolgen Sie diese Schritte:
Danach befindet sich im build -Verzeichnis eine dist-Datei, die Sie am Speicherort Ihrer Wahl dekomprimieren müssen.
Notiz
Dies ist der Prozess, der bei der Veröffentlichung neuer Shlink-Versionen verwendet wird. Nachdem die neue Version mit Git markiert wurde, wird die GitHub-Version automatisch von einem GitHub-Workflow erstellt, indem die generierte dist-Datei daran angehängt wird.

Klonen Sie das Projekt mit git ( git clone https://github.com/shlinkio/shlink.git ) oder laden Sie es herunter, indem Sie auf die grüne Schaltfläche „Klonen oder herunterladen“ klicken.
Laden Sie den Composer PHP-Paketmanager im Projektordner herunter.
Führen Sie ./build.sh 3.0.0 aus und ersetzen Sie die Version durch die Versionsnummer, die Sie erstellen möchten (die Versionsnummer wird als Teil des generierten dist-Dateinamens verwendet und um den zurückgegebenen Wert festzulegen, wenn shlink -V von ausgeführt wird). Befehlszeile).

Konfigurieren

Unabhängig davon, wie Sie das Projekt erstellt haben, müssen Sie es jetzt konfigurieren, indem Sie die folgenden Schritte ausführen:

Wenn Sie MySQL, MariaDB, PostgreSQL oder Microsoft SQL Server verwenden möchten, erstellen Sie eine leere Datenbank mit dem Namen Ihrer Wahl.
Erteilen Sie rekursiv Schreibberechtigungen für das data . Shlink verwendet es, um einige Informationen zwischenzuspeichern.
Richten Sie die Anwendung ein, indem Sie das vendor/bin/shlink-installer install ausführen. Es handelt sich um ein Befehlszeilentool, das Sie durch den Installationsprozess führt. Bedenken Sie, dass dieses Tool direkt auf dem Server ausgeführt werden muss, auf dem Sie Shlink hosten möchten. Führen Sie es nicht aus, bevor Sie es dorthin hochgeladen/verschoben haben.
Generieren Sie Ihren ersten API-Schlüssel, indem Sie bin/cli api-key:generate ausführen. Sie benötigen den Schlüssel, um mit der Shlink-API zu interagieren.

Shlink verwenden

Sobald Shlink installiert ist, gibt es im Wesentlichen zwei Möglichkeiten, mit ihm zu interagieren:

Die Befehlszeile : Versuchen Sie, bin/cli auszuführen, um alle verfügbaren Befehle anzuzeigen.
Sie können alle mit der Flagge --help / -h ausgeführt werden, um zu sehen, wie sie verwendet werden und welche Optionen verfügbar sind.
Es ist wahrscheinlich eine gute Idee, den CLI-Einstiegspunkt ( bin/cli ) irgendwo in Ihrem Pfad zu verknüpfen, damit Sie shlink von jedem Verzeichnis aus ausführen können.
Die REST-API : Die vollständigen Dokumente zur Verwendung der API finden Sie hier. Eine Sandbox, die auch jeden Endpunkt dokumentiert, finden Sie im API Spec-Portal.
Allerdings möchten Sie die Roh-API wahrscheinlich nicht selbst nutzen. Aus diesem Grund wird ein schöner Web-Client bereitgestellt, der direkt über https://app.shlink.io verwendet oder von Ihnen selbst gehostet werden kann.

Mit der API und der CLI können Sie größtenteils die gleichen Vorgänge ausführen, mit Ausnahme der API-Schlüsselverwaltung, die nur über die Befehlszeilenschnittstelle ausgeführt werden kann.

Mitwirken

Wenn Sie herausfinden möchten, wie Sie das Projekt im Entwicklungsmodus ausführen oder Beiträge bereitstellen können, lesen Sie das Dokument CONTRIBUTING.