shlink
v4.2.5
PHP ベースのセルフホスト URL 短縮ツール。独自のドメインで短縮 URL を提供するために使用できます。
完全なドキュメント
Dockerイメージ
自己ホスト型
ダウンロード
設定する
シュリンクの使用
貢献する
このドキュメントには、Shlink を使い始めるための基本的な事項が含まれています。それを使ってできることをすべて知りたい場合は、検索可能な完全なドキュメントにアクセスしてください。
ドキュメントを読むことで、公式の Docker イメージの使用方法を学ぶことができます。
アイデアは、イメージを使用してコンテナーを生成し、環境変数を介してカスタム構成を提供できるということです。
まず、shlink を実行するホストが次の要件を満たしていることを確認します。
PHP 8.2 または 8.3
次の PHP 拡張子: json、curl、pdo、intl、gd、gmp/bcmath。
RoadRunner を使用する予定がない場合は、apcu 拡張機能をお勧めします。
svg 形式で QR コードを生成する場合は、xml 拡張子が必要です。
RabbitMQ インスタンスと統合する場合は、ソケットと bcmath 拡張機能が必要です。
MySQL、MariaDB、PostgreSQL、MicrosoftSQL、または SQLite。
使用する予定のデータベースに対応する pdo バリエーション ( pdo_mysql 、 pdo_pgsql 、 pdo_sqlsrvまたはpdo_sqliteも必要です。
Shlink を実行するには、プロジェクトのビルドされたバージョンが必要です。入手方法は2つあります。
dist ファイルの使用
shlink をインストールする最も簡単な方法は、事前にバンドルされている配布可能パッケージの 1 つを使用することです。
最新バージョンに移動し、ニーズに合ったshlink*_dist.zipファイルをダウンロードします。サポートされている PHP バージョンごとに 1 つ見つかります。
最後に、選択した場所でファイルを解凍します。
ソースから構築する
何らかの理由でプロジェクトを自分で構築したい場合は、次の手順に従ってください。
その後、 buildディレクトリ内に dist ファイルが作成されるので、これを任意の場所で解凍する必要があります。
注記
これは、新しい Shlink バージョンをリリースするときに使用されるプロセスです。新しいバージョンに git のタグを付けると、GitHub ワークフローによって GitHub リリースが自動的に作成され、生成された dist ファイルがそれに添付されます。
git を使用してプロジェクトのクローンを作成するか ( git clone https://github.com/shlinkio/shlink.git )、緑色の[クローンまたはダウンロード]ボタンをクリックしてダウンロードします。
Composer PHP パッケージ マネージャーをプロジェクト フォルダー内にダウンロードします。
./build.sh 3.0.0を実行し、 version をビルドするバージョン番号に置き換えます (バージョン番号は、生成された dist ファイル名の一部として使用され、 shlink -V実行したときに返される値を設定します)コマンドライン）。
プロジェクトをどのように構築したかに関係なく、次の手順に従ってプロジェクトを構成する必要があります。
MySQL、MariaDB、PostgreSQL、または Microsoft SQL Server を使用する場合は、任意の名前で空のデータベースを作成します。
dataディレクトリへの書き込み権限を再帰的に付与します。 Shlink はこれを使用して情報をキャッシュします。
vendor/bin/shlink-installer installスクリプトを実行して、アプリケーションをセットアップします。これは、インストール プロセスをガイドするコマンド ライン ツールです。このツールは、Shlink をホストする予定のサーバー上で直接実行する必要があることに注意してください。そこにアップロード/移動する前に実行しないでください。
bin/cli api-key:generate実行して、最初の API キーを生成します。 Shlink の API を操作するにはキーが必要です。
shlink がインストールされたら、それを操作するには主に 2 つの方法があります。
コマンドライン: bin/cliを実行して、利用可能なすべてのコマンドを確認してください。
これらはすべて--help / -hフラグを付けて実行すると、その使用方法と利用可能なすべてのオプションを確認できます。
CLI エントリ ポイント ( bin/cli ) をパス内のどこかにシンボリックリンクして、任意のディレクトリから shlink を実行できるようにすることをお勧めします。
REST API : API の使用方法に関する完全なドキュメントはここにあり、すべてのエンドポイントを文書化するサンドボックスも API 仕様ポータルにあります。
ただし、おそらく、生の API を自分で使用したくないでしょう。そのため、https://app.shlink.io から直接使用したり、自分でホストしたりできる優れた Web クライアントが提供されています。
API と CLI の両方で、ほとんど同じ操作を実行できます。ただし、API キー管理はコマンド ライン インターフェイスからのみ実行できます。
開発モードでプロジェクトを実行する方法、または貢献を提供する方法を知りたい場合は、「貢献」ドキュメントをお読みください。
この製品には、MaxMind によって作成された GeoLite2 データが含まれており、https://www.maxmind.com から入手できます。
