快速开始
本指南帮助您在 5 分钟内完成 Shortlinker 的配置和基本使用。
前置条件
请先完成 安装指南 中的任一安装方式。
第一步：基础配置
方式一：使用 TOML 配置文件（推荐）
推荐使用 generate-config 命令生成配置文件：
bash
./shortlinker generate-config
# 生成 config.toml，包含所有可配置项及默认值然后根据需要修改 config.toml：
toml
[server]
host = "127.0.0.1"
port = 8080
[features]
default_url = "https://example.com"
# 可选：启用管理功能（Admin API + Health API）
# - Health 支持 Bearer Token（HEALTH_TOKEN）或 Admin 登录后的 JWT Cookie
# [api]
# admin_token = "your_admin_token"TIP
如果不创建配置文件，程序会使用内置的默认配置运行。
方式二：使用环境变量
创建配置文件 .env：
bash
# 最小配置
SERVER_HOST=127.0.0.1
SERVER_PORT=8080
DEFAULT_URL=https://example.com
# 可选：启用管理功能（Admin API + Health API）
# - Health 支持 Bearer Token（HEALTH_TOKEN）或 Admin 登录后的 JWT Cookie
# ADMIN_TOKEN=your_admin_token第二步：启动服务
bash
# 启动服务器
./shortlinker
# 看到以下输出表示成功：
# [INFO] Starting server at http://127.0.0.1:8080
# [INFO] SQLite storage initialized with 0 links第三步：添加短链接
bash
# 自定义短码
./shortlinker add github https://github.com
# 随机短码
./shortlinker add https://www.google.com
# 输出：✓ 已添加短链接: aB3dF1 -> https://www.google.com第四步：测试访问
bash
# 测试重定向
curl -I http://localhost:8080/github
# HTTP/1.1 307 Temporary Redirect
# Location: https://github.com
# 浏览器访问
# http://localhost:8080/github常用操作
bash
# 查看所有短链接
./shortlinker list
# 删除短链接
./shortlinker remove github
# 添加临时链接
./shortlinker add temp https://example.com --expire 1d
# 强制覆盖
./shortlinker add github https://github.com --force服务管理
bash
# 停止服务
# 方式1：Ctrl+C
# 方式2：发送信号
kill $(cat shortlinker.pid)
# 重载短链接数据/缓存（Unix 系统）
# 注意：SIGUSR1 只会触发短链接数据/缓存重载，不会重载运行时配置。
# 运行时配置可通过 Admin API `/admin/v1/config/reload` 重载，或直接重启服务。
kill -USR1 $(cat shortlinker.pid)生产环境快速配置
推荐配置
bash
# 生产环境 .env 配置
SERVER_HOST=127.0.0.1
SERVER_PORT=8080
DATABASE_URL=sqlite:///data/links.db
DEFAULT_URL=https://your-domain.com
# 启用 API 功能
ADMIN_TOKEN=your_secure_admin_token反向代理示例
nginx
# Nginx 配置示例
server {
listen 80;
server_name your-domain.com;
location / {
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host $host;
}
}Docker 快速部署
bash
# 使用 Docker Compose
version: '3.8'
services:
shortlinker:
image: e1saps/shortlinker
ports:
- "127.0.0.1:8080:8080"
volumes:
- ./data:/data
environment:
- DATABASE_URL=sqlite:///data/links.db下一步
恭喜！您已经成功配置了 Shortlinker。接下来可以：