Slink 项目部署与配置完全指南

环境准备：搭建运行环境

安装基础依赖

在开始部署 Slink 前，需要确保系统已安装 Git、Docker 和 Docker Compose。这些工具是项目运行的基础，Git 用于获取代码，Docker 提供容器化运行环境，Docker Compose 则简化多容器应用的管理。

获取项目代码

使用 Git 克隆项目仓库到本地，仓库地址为：

git clone https://gitcode.com/gh_mirrors/sl/slink

进入项目目录：

cd slink

项目模块关系说明

Slink 项目采用模块化设计，核心代码位于 services/api/src/ 目录，前端界面代码在 services/client/ 目录。配置文件集中在 docker/config/ 和 services/api/config/ 目录，启动脚本和容器化配置则通过 docker/ 目录下的文件管理。这些模块协同工作，通过 Docker 容器实现服务的快速部署和运行。

快速部署：两种环境启动方案

开发环境启动

开发环境适合代码调试和功能开发，使用以下命令启动：

docker-compose -f docker-compose.dev.yaml up -d

该命令会启动开发模式的容器，包含代码热重载功能，修改代码后无需重启服务即可生效。启动成功后，访问 http://localhost:5173 即可打开 Slink 应用。

生产环境启动

生产环境注重稳定性和性能，使用以下命令启动：

docker-compose up -d

生产环境会优化资源使用，并禁用开发相关功能。启动后，通过 http://localhost 访问应用。建议在生产环境中配置域名和 SSL 证书，提升安全性。

图：Slink 的图片上传界面，支持拖放和多种格式上传

配置优化：自定义项目设置

核心配置文件说明

项目的主要配置文件位于 services/api/config/ 目录，其中 settings.yaml 包含应用的核心设置。以下是关键配置项及其作用：

• database：配置数据库连接信息，确保数据持久化存储。
• server：设置服务端口和地址，控制应用访问入口。
• storage：定义文件存储方式，支持本地存储和云存储。

环境变量应用场景

环境变量可以动态调整配置，无需修改配置文件。以下是两个常用场景：

1. 修改服务端口：

export PORT=8080
docker-compose up -d

2. 切换存储 provider：

export STORAGE_PROVIDER=s3
docker-compose up -d

常见问题排查

• 服务无法启动：检查端口是否被占用，可通过 netstat -tuln 查看端口使用情况。
• 数据库连接失败：确认数据库配置正确，Docker 容器网络是否通畅。
• 文件上传失败：检查存储路径权限，确保容器有写入权限。

图：Slink 的图片管理界面，支持调整尺寸、添加标签和分享链接

高级配置技巧

对于有特殊需求的用户，可以修改 docker/config/runtime/production.conf 文件，调整服务运行参数。例如，修改缓存策略或日志级别，优化应用性能。修改后需重启服务使配置生效：

docker-compose restart

使用指南：基本操作演示

上传图片

登录应用后，进入上传页面，可通过拖放图片或点击上传区域选择文件。支持 PNG、JPG、GIF 等多种格式，上传后自动生成唯一链接。

管理图片

在上传历史页面，可以查看所有上传的图片，支持按标签筛选。点击图片可进入详情页，进行下载、分享、调整尺寸等操作。

图：Slink 的上传历史界面，展示已上传图片并支持标签筛选

分享图片

在图片详情页，点击“Copy”按钮复制分享链接，或选择不同格式的链接进行分享。支持直接嵌入到网页或通过社交媒体分享。

通过以上步骤，你可以快速部署和使用 Slink 项目，享受自建图片分享服务的便利。如需进一步定制，可以查阅项目源码中的文档或修改相关配置文件。