Firekylin
A Simple & Fast Node Blogging Platform Base On ThinkJS 3 & ReactJS & ES2015+.
安装
推荐通过 CLI 创建独立的 Firekylin 项目。核心程序安装在 node_modules，项目目录只保存配置、主题、上传文件和数据，升级时不会覆盖用户文件：
npx firekylin new my-blog
cd my-blog
npm start初始化命令会交互式选择 SQLite、MySQL、TiDB 或 PostgreSQL，建立数据表并创建管理员账号。TiDB 复用 MySQL 协议，并自动启用 TLS 1.2 及证书校验。默认主题会复制到 themes/firekylin，后续升级不会覆盖这份主题。
开发模式使用 npm run dev（等价于 firekylin -D）。升级核心程序时在项目中更新 firekylin 依赖即可。
非交互安装
CI 或容器中可通过参数完成初始化：
npx firekylin new my-blog --non-interactive --skip-install \
--db-type sqlite --db-path data/firekylin.sqlite --db-prefix fk_ \
--site-title "My Blog" --site-url "https://example.com" \
--admin-user admin --admin-password 'change-me' --admin-email [email protected] \
--package-manager npmMySQL/TiDB/PostgreSQL 另使用 --db-host、--db-port、--db-name、--db-user 和 --db-password。命令行密码可能进入 shell history；交互安装更适合人工部署。使用 --skip-install 时需在初始化后自行执行包管理器的安装命令。
如果数据库和表已经存在，或准备稍后手工填写 firekylin.config.js，可以使用 --skip-initialize。该选项只创建项目骨架并标记为已安装，不会进入交互配置，也不会连接数据库、建库、建表或创建管理员。可通过 --db-type 指定配置骨架的数据库类型，未指定时默认为 SQLite。
旧版“源码目录即站点目录”的 production.js、development.js 和网页安装流程仍保留，供已有部署继续使用。
多实例 / Serverless 后台登录
后台认证使用无状态 JWT Cookie，签名密钥由数据库中的 jwt_secret 统一保存，旧版 comment_jwt_secret 会自动迁移，无需额外环境变量。首次升级需要重新登录。详细说明参见 JWT 认证和迁移文档。
评论社交登录
评论登录支持 Waline OAuth 服务提供的 GitHub、微博、QQ、OIDC 等社交账号。默认使用 https://oauth.lithub.cc，也可以通过 OAUTH_URL 环境变量指向自行部署的 Waline Auth 服务。首次社交登录会自动创建“评论者”用户；已登录的后台用户可以在自己的用户编辑页绑定或解绑社交账号，管理员可在用户列表查看绑定情况。
如何使用
常见问题
如果您在使用过程中遇到问题，请查看 问题解答 中的解答，或者在 GitHub 上提问。
用户列表
如果你的博客也是用 FireKylin 构建的，请到 https://github.com/firekylin/firekylin/issues/34 提交网址。
内置 MCP Server
Firekylin 自带 MCP HTTP 服务，无需安装额外插件，也不需要手工创建 Token 或配置用户 ID。默认地址为 /mcp，客户端通过 OAuth 2.1 跳转到 Firekylin 登录并确认授权，自动获取与当前用户绑定的访问令牌。可以让 Codex、Claude Code 等 MCP 客户端在授权范围内读取文章、管理草稿（高风险发布、删除操作仍需要单次审批支持）。使用和安全说明见 MCP Server 文档。
开发者文档
扩展 Widget
在 Firekylin 项目目录中可以用 CLI 快速创建并登记一个 Widget 插件：
firekylin plugin recent-posts命令会生成 plugins/recent-posts/（包含实现、类型声明和使用说明），并把入口写入 firekylin.config.js 的 widgets 数组。插件名使用字母、数字和连字符；生成后重启 worker 即可加载。
项目可以在 firekylin.config.js 中声明 Widget 入口。入口相对项目根目录解析，并在 worker 启动时加载：
module.exports = {
database: {/ ... /},
widgets: ['./widgets/index.js']
};入口导出一个同步初始化函数。函数会收到稳定的 Widget、ContentsWidget 和 MetasWidget 基类，并返回“名称 → Widget 类”的映射。内容类 Widget 推荐继承 ContentsWidget，以复用 permalink、摘要、分类标签、作者和权限等处理：
module.exports = ({ContentsWidget}) => ({
Widget_Custom_Posts: class extends ContentsWidget {
async execute() {
const limit = Number(this.parameter.limit) || 5;
const rows = await this.model('post').limit(limit).select();
this.pushAll(rows);
}
}
});主题也可以在自身的 package.json 中声明入口。只有当前启用主题的服务端代码会被加载：
{
"firekylin": {
"widgets": "./widgets/index.js",
"widgetOverrides": ["Widget_Contents_Post_Recent"]
}
}模板调用方式与内置 Widget 相同：
<% const posts = await firekylin.widget('Widget_Custom_Posts', {limit: 8}); %>
<% while (posts.next()) { %><a href="<%= posts.permalink %>"><%= posts.title %></a><% } %>Widget 重名默认会阻止启动或渲染，并同时报告两个来源。需要替换已有 Widget 时，必须在项目配置或主题的 firekylin 配置中通过 widgetOverrides 显式列出名称。主题不能覆盖用于确定当前主题的 Widget_Options。扩展代码运行在 Firekylin 服务端进程中，应只安装可信扩展；修改后需重启 worker。
文章或页面模板可以通过一行输出内置评论区：
<%~ firekylin.comment() %>comment() 会自动判断当前内容是否允许评论，并读取后台的分页、语言及强制登录设置。主题无需自行引入评论客户端或编写初始化脚本。可选参数包括 className、title、loadingText 和 Waline dist 目录地址 resourceURL：
<%~ firekylin.comment({className: 'article-comments', title: '评论'}) %>如需升级 Waline 客户端或使用自建 CDN，可以指定资源目录，Firekylin 会在其下加载 waline.js 和 waline.css：
<%~ firekylin.comment({resourceURL: 'https://cdn.jsdelivr.net/npm/@waline/[email protected]/dist'}) %>通过 firekylin new 创建的项目会在根目录包含 firekylin.d.ts。支持 TypeScript 类型服务的编辑器或 Eta 插件可据此补全内置 Widget 名称、参数、数据字段和实例方法；声明只提供编辑期提示，不会改变 Widget 的注册和运行行为。类型主体由 firekylin 依赖提供，因此升级依赖即可同步最新定义。已有项目也可以手动添加：
/// <reference types="firekylin" />自定义 Widget 可以在项目中的任意 .d.ts 文件里扩展注册表：
declare namespace Firekylin {
interface CustomPostsParameters {
limit?: number;
}
class CustomPostsWidget extends ContentsWidget<ContentRow, CustomPostsParameters> {
featured(): boolean;
}
interface WidgetRegistry {
Widget_Custom_Posts: WidgetDefinition<CustomPostsParameters, CustomPostsWidget>;
}
}
之后调用 firekylin.widget('Widget_Custom_Posts', {limit: 8}) 时，参数和返回实例都会按扩展声明进行推导。带缓存标识的名称（如 Widget_Custom_Posts@sidebar）也会使用同一份 Widget 类型。
捐赠支持
你的每一份帮助都将使 Firekylin 做的更好，走的更远！我们一直在坚持不懈地努力，并坚持让 Firekylin 完全开源免费，你的帮助将使我们更有动力和信心！
欢迎使用支付宝或者微信扫描二维码进行捐赠！已捐赠用户将在 捐赠列表 中列出。
