Shlink 自托管短链服务安装与使用教程

Shlink 自托管短链服务安装与使用教程

shlinkThe definitive self-hosted URL shortener项目地址:https://gitcode.com/gh_mirrors/sh/shlink

Shlink 是一个自托管的 URL 短链服务，它允许您创建自己的短网址并进行跟踪。以下是如何安装和配置 Shlink 的指南。

1. 项目目录结构及介绍

在解压或克隆 Shlink 代码库后，您将看到以下主要目录和文件：

shlink/
|-- bin/                # 包含可执行脚本，如 `shlink` CLI 工具
|-- config/             # 配置文件存储的地方
|-- src/                # 主要的源代码
|   |-- Api/            # API 相关代码
|   |-- Console/        # 控制台命令相关代码
|   |-- Infrastructure/ # 基础设施类，如数据库连接等
|   |-- Model/          # 数据模型
|   |-- Service/         # 核心服务
|   |-- Tests/           # 单元测试
|-- public/             # 可公开访问的静态资源
|-- var/                # 运行时数据存储位置，如日志和缓存
|-- composer.json       # 项目的依赖管理文件
|-- Dockerfile          # Docker 容器构建文件
|-- README.md           # 项目简介

2. 项目的启动文件介绍

Shlink 使用 Composer 管理依赖，并通过 bin/shlink 脚本来运行。这个脚本是 PHP CLI 应用的入口点。要启动 Shlink，打开终端进入项目根目录，然后运行：

php bin/shlink start

这将启动 Shlink 的服务器，使得您可以使用其提供的 REST API 和 CLI 工具。

3. 项目的配置文件介绍

默认情况下，Shlink 在 config 目录下有一系列的 .dist.php 文件，这些是配置示例。为了更改设置，首先复制相应的 .dist.php 文件并去掉扩展名，例如：

cp config/autoload/databases.php.dist config/autoload/databases.php

现在可以用文本编辑器打开 databases.php 并修改数据库连接设置，或者编辑其他配置文件以定制 Shlink 的行为。配置选项包括但不限于：

• Databases：用于存储短链接及其元数据的数据库配置。
• Server：HTTP server 相关设置，如端口和域名。
• Routing：URL 路由和重定向规则。
• Short URLs：短链生成策略和前缀。
• GeoIP：是否启用 IP 地理定位以及相关的设置。

一旦配置完成，记得重启 Shlink 使改动生效。

总结，Shlink 提供了一个灵活且功能丰富的短链服务，通过上述步骤您可以轻松地安装并按需配置该项目。更多详细的配置和使用指南可参考 Shlink 的官方文档。

shlinkThe definitive self-hosted URL shortener项目地址:https://gitcode.com/gh_mirrors/sh/shlink