基於 PHP 的自架 URL 縮短器,可用於在您自己的網域下提供縮短的 URL。
本文檔包含 Shlink 入門的基礎知識。如果您想了解可以使用它執行的所有操作,請造訪完整的可搜尋文件。
您可以透過閱讀文件來了解如何使用官方的 docker 映像。
這個想法是,您可以使用圖像生成一個容器並透過環境變數提供自訂配置。
首先,請確保要執行 shlink 的主機符合以下要求:
pdo_mysql
、 pdo_pgsql
、 pdo_sqlsrv
或pdo_sqlite
。為了運行 Shlink,您將需要該專案的建置版本。有兩種方法可以獲得它。
使用 dist 文件
安裝 shlink 最簡單的方法是使用預先捆綁的可分發套件之一。
前往最新版本並下載適合您需求的shlink*_dist.zip
檔案。您將為每個受支援的 PHP 版本找到一個。
最後,將文件解壓縮到您選擇的位置。
從源頭構建
如果您出於任何原因想自己建立項目,請按照以下步驟操作:
git clone https://github.com/shlinkio/shlink.git
),或透過點擊克隆或下載綠色按鈕來下載。./build.sh 3.0.0
,將版本替換為您要建立的版本號碼(版本號用作產生的 dist 檔案名稱的一部分,並設定從執行shlink -V
時傳回的值命令列)。之後,您將在build
目錄中看到一個 dist 文件,您需要將其解壓縮到您選擇的位置。
筆記
這是發布新的 Shlink 版本時使用的過程。使用 git 標記新版本後,GitHub 工作流程將自動建立 GitHub 版本,並將產生的 dist 檔案附加到其中。
無論您如何建置項目,您現在都需要按照以下步驟配置它:
data
目錄的寫入權限。 Shlink用它來快取一些資訊。vendor/bin/shlink-installer install
腳本來設定應用程式。它是一個命令列工具,將引導您完成安裝過程。請注意,該工具必須直接在您計劃託管 Shlink 的伺服器上執行。在將其上傳/移動到那裡之前請勿運行它。bin/cli api-key:generate
產生您的第一個 API 金鑰。您將需要金鑰才能與 Shlink 的 API 互動。 安裝 shlink 後,有兩種主要方式與其互動:
命令列:嘗試執行bin/cli
以查看所有可用命令。
所有這些都可以使用--help
/ -h
標誌運行,以查看如何使用它們以及所有可用選項。
將 CLI 入口點 ( bin/cli
) 符號連結到路徑中的某個位置可能是個好主意,以便您可以從任何目錄執行 shlink。
REST API :有關如何使用 API 的完整文件可以在此處找到,也可以在 API 規範入口網站中找到也記錄每個端點的沙箱。
但是,您可能不想自己使用原始 API。這就是為什麼提供了一個很好的 Web 用戶端,可以直接從 https://app.shlink.io 使用,或由您自己託管。
API 和 CLI 都允許您執行大部分相同的操作,但 API 金鑰管理除外,該管理只能從命令列介面完成。
如果您想了解如何在開發模式下運行專案或如何提供貢獻,請閱讀貢獻文件。
本產品包含由 MaxMind 創建的 GeoLite2 數據,可從 https://www.maxmind.com 取得