基于 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 获取