本仓库分叉于 https://github.com/x-dr/short 并且已经在源代码的基础上做了修改。

源代码使用 MIT 许可证进行授权，本经过二次修改的程序同源代码的许可证，二次分发或者修改时请保留原作者和修改作者的版权信息。

最新版本在 2024/08/25 的 v1.3.0。

注意：v1.3.0 之前的版本与此版本不兼容，因为在数据表中多了一个字段 password，如要覆盖升级，请手动在 links 数据表中添加新字段 password，类型为 TEXT。

ALTER TABLE links
ADD COLUMN password TEXT;

一个使用 Cloudflare Pages 创建的 URL 缩短器。

支持设置密码和管理短链、使用 Turnstile 人机验证、黑名单域名管理、跳转页面配置、多域名使用，可通过环境变量快速配置。

可靠的短链示例：https://c1n.top/

点击这里查看演示图片

可根据浏览器设置自动切换光亮、暗黑主题。

1. Fork 分叉本项目 : https://github.com/molikai-work/short。

2. 登录到Cloudflare控制台。

3. 在帐户主页中，选择Workers 和 Pages-> 创建应用程序 -> Pages -> 连接到 Git。（Cloudflare 支持多种语言，推荐将语言显示设置为与本教程相同的语言）

4. 选择你创建的项目存储库，在 设置构建和部署 部分中，全部默认即可，不需要修改框架预设、构建命令等内容。

5. 点击 保存并部署 ，稍等片刻等待网站构建完成。

6. 点击这里查看创建数据库操作的图示

(1) 进入 Cloudflare 的控制台，查看左侧侧边栏，选择 Workers 和 Pages 展开菜单后再选择 D1：

(2) 在 D1 页面点击右上角的 创建数据库 以打开创建数据库菜单：

(3) 填写 数据库名称 输入框，名称随意，确保绑定是为同一个数据库即可，下方的位置选项可不选（这里已经填好，示范）：

(4) 完成数据库创建，接下来在数据库的操作页面，请点击 控制台，并查看主部署教程的下一步（第7步）：

7. 在数据库控制台输入框粘贴下面语句执行 SQLite 的命令创建表执行即可。

DROP TABLE IF EXISTS links;
CREATE TABLE IF NOT EXISTS links (
  `id` integer PRIMARY KEY NOT NULL,
  `url` text,
  `slug` text,
  `password` text,
  `email` text,
  `ua` text,
  `ip` text,
  `status` text,
  `hostname` text ,
  `create_time` DATE
);
DROP TABLE IF EXISTS logs;
CREATE TABLE IF NOT EXISTS logs (
  `id` integer PRIMARY KEY NOT NULL,
  `url` text ,
  `slug` text,
  `referer` text,
  `ua` text ,
  `ip` text ,
  `status` text,
  `hostname` text ,
  `create_time` DATE
);
DROP TABLE IF EXISTS banUrl;
CREATE TABLE IF NOT EXISTS banUrl (
  `id` INTEGER PRIMARY KEY NOT NULL,
  `url` TEXT,
  `create_time` TEXT DEFAULT (strftime('%Y-%m-%dT%H:%M:%SZ', 'now'))
);
CREATE UNIQUE INDEX links_index ON links(slug);
CREATE INDEX logs_index ON logs(slug);
CREATE UNIQUE INDEX banUrl_index ON banUrl(url);

8. 选择部署完成项目，前往 Cloudflare Pages 项目控制面板依次点击 设置 -> 函数 -> D1 数据库绑定 -> 编辑绑定 ->添加变量，变量名称填写：DB -> D1 数据库选择 你刚刚创建好的 D1 数据库

9. 重新部署项目以刷新数据，完成。

你可以向 Cloudflare 的 D1 数据库的已创建短链数据库中的 banUrl 数据表添加数据以设置黑名单域名。

在此数据表中的域名均无法创建/解析短链。

请直接在 banUrl 数据表的 url 项添加要加黑名单的一级域名，如 example.com ，其他的数据项会自动填写。

这里推荐另一个项目 https://github.com/JacobLinCool/d1-manager，可视化 Cloudflare 的 D1 数据库的操作，更方便的设置和备份数据表。

你可以在 Cloudflare Pages 项目控制面板 设置 -> 环境变量 -> 制作 -> 为生产环境定义变量 中配置以下环境变量。

所有环境变量全部都是可选配置的，不配置则执行默认的相关函数，不影响正常使用。

你可以在项目 functions 文件夹下找到 utils.js 文件，可以在这里浏览通用函数和部分设置信息，例如在后端的短链的显示名称。

如果未在环境变量中配置关于 Turnstile 密钥的环境变量，请忽略本节信息。

如果你需要开启 Turnstile 验证功能，请：

1. 在 Turnstile 页面根据引导步骤申请获得站点密钥和密钥，然后配置环境变量 TURNSTILE_SECRET_KEY 的值为密钥内容。
2. 在项目根目录的 index.html 文件，将第 43 行的元素的 data-sitekey 属性设置为你的站点密钥。
3. 在项目 pages 目录下的 manage.html 文件，将第 45 行的元素的 data-sitekey 属性为设置你的站点密钥。

完成。

仅限未启用 Turnstile 验证的情况下可以任意使用 API 生成。

# POST /create
curl -X POST -H "Content-Type: application/json" -d '{"url":"https://example.com/"}' https://example.com/create

# 指定 slug，还支持 email、password
curl -X POST -H "Content-Type: application/json" -d '{"url":"https://example.com/","slug":"example"}' https://example.com/create

响应:

{
    "code": 200,
    "msg": "success",
    "time": 1717431484672,
    "url": "https://example.com/",
    "slug": "example",
    "link": "https://example.com/example"
}

表 links 短链记录

• id = 行数据在数据表中的唯一记录 ID
• url = 短链的目标 URL
• slug = 短链对应的唯一短 ID
• password = 短链的管理密码（SHA-256）
• email = 用户可选提交的 Email 地址
• ua = 用户的浏览器标识（注：此数据依靠客户端标头，可篡改）
• ip = 用户的 IP 地址
• status = 短链的状态，默认为 ok，ban 为封禁、ok 为正常、skip为 跳过黑名单
• hostname = 用户生成短链访问的主机名
• create_time = 短链生成时间

表 logs 短链访问记录

• id = 行数据在数据表中的唯一记录 ID
• url = 访问的短链的目标 URL
• slug = 访问的短链对应的唯一短 ID
• referer = 访问短链的用户来源（注：此数据依靠客户端标头，可篡改）
• ua = 访问的用户的浏览器标识（注：此数据依靠客户端标头，可篡改）
• ip = 访问的用户的 IP 地址
• status = 访问的短链的状态，跟随表 links 的设置
• hostname = 用户访问短链所访问的主机名
• create_time = 用户访问短链的时间

表 banUrl 域名黑名单

• id = 行数据在数据表中的唯一记录 ID
• url = 黑名单域名
• create_time = 黑名单添加时间