pages cms

页面CMS

页面CMS是GitHub的开源内容管理系统。它特别适合静态现场生成器（例如Jekyll，Next.js，Vuepress，Hugo）。

它提供了一个用户友好的界面，可以直接在GitHub上编辑网站或应用程序的内容。

观看演示▶

文档

转到pagescms.org/docs。

建立

• next.js
• 尾风CSS
• shadcn/ui
• 细雨
• 动词
• Turso
• 重新发出

在线使用

最简单的入门方法是使用页面CMS的在线版本。您将能够使用GitHub帐户登录并获取最新版本的页面CMS。

此在线版本与此存储库中的内容相同，但是您也可以在本地安装自己的版本或在Vercel上（免费）遵循以下步骤（免费）。

安装和部署

创建一个GitHub应用程序

无论您是在本地安装页面CMS还是在线部署，都需要GitHub应用程序。

您可以在您的个人帐户（https://github.com/settings/apps）或您的一个组织（https://github.com/organization/organization//settings/apps）下创建它。

您将需要填写以下信息：

• github应用程序名称：使用“页面CMS”或您认为适当的任何内容（例如“页面CMS（dev）”）。
• 主页URL ：无论您想要什么，https：//pagescms.org都会做。
• 识别和授权用户：
  • 回调URL： /api/auth/github的URL：
    • http://localhost:3000/api/auth/github开发，
    • https://my-vercel-url.vercel.app/api/auth/github （或正在使用的任何自定义域）之类的东西，如果您在Vercel上部署时。
  • 到期用户授权令牌：否。
  • 在安装过程中请求用户授权（OAUTH）：是的。
  • 启用设备流：否。
• 后安装：
  • 设置URL（可选）：空白。
  • 重定向更新：否。
• Webhook ：
  • 活动：是的。
  • Webhook URL：（公共）URL /api/webhook/github ：
    • 为了开发，您需要使用Ngrok之类的东西。您最终会得到https://your-unique-subdomain.ngrok-free.app/api/webhook/github 。
    • 如果您在Vercel上部署，则类似于https://my-vercel-url.vercel.app/api/webhook/github （或您使用的任何自定义域）。
  • 秘密：生成一个随机字符串（例如，macOS/linux上的openssl rand -base64 32 ）
• 许可：
  • 存储库权限：
    • 管理：读写
    • 内容：读写
    • 元数据：只读
  • 组织许可：什么都没有。
  • 帐户权限：什么都没有。
• 订阅事件：
  • 安装目标
  • 存储库（创建GitHub应用程序后，您可能需要添加此内容）
• 此GitHub应用程序可以在哪里安装？ ：除非您打算仅在帐户上使用该github应用程序在下面创建的帐户上使用页面CMS，否则您需要选择“任何帐户”。

环境变量

多变的	评论
CRYPTO_KEY	用于在数据库中加密/解密GitHub令牌。在MacOS/Linux*上，您可以使用openssl rand -base64 32 。
GITHUB_APP_ID	GitHub应用程序ID中的GitHub应用程序详细信息页面。
GITHUB_APP_NAME	GitHub应用程序的机器名称（例如pages-cms ）应为GitHub应用程序详细信息页面的URL。
GITHUB_APP_PRIVATE_KEY	PEM文件，您可以下载uPong创建GitHub应用程序。
GITHUB_APP_WEBHOOK_SECRET	您为Webhook选择的秘密。这用于确保请求来自GitHub。
GITHUB_APP_CLIENT_ID	GitHub应用客户端ID从您的GitHub应用详细信息页面。
GITHUB_APP_CLIENT_SECRET	GitHub应用客户端秘密您在thegithub应用程序详细信息页面上生成。
RESEND_API_KEY	当您创建一个（免费）重新汇总帐户以处理电子邮件时，您会得到这一点。
SQLITE_URL	file:./local.db进行开发， libsql://pages-cms-username.turso.io例如，如果您使用turso（您应该使用Turso，Turso很棒）。
SQLITE_AUTH_TOKEN	留空供开发，否则请使用Turso提供的令牌（如果您使用的话）。
BASE_URL	选修的。如果您要部署到Vercel或在本地工作，则不需要。如果您要部署其他地方，则需要为应用程序指定基本URL（例如https://mycustomdomain.com ）。

地方发展

我们假设您已经创建了GitHub应用程序，并为Github应用程序Webhook设有运行隧道（例如，使用NGrok）：

1. 安装依赖项： npm install
2. 更新您的环境变量：将.env.example复制到.env并根据您的设置填写值（请参见上面的部分）。
3. 创建数据库： npm run db:migrate
4. 运行： npm run dev

部署在Vercel上

1. 创建一个SQLITE数据库：我建议使用Turso，因为它是免费的（而且很棒）

2. 部署到Vercel ：在此阶段，您有2个选择：

   1. 创建一个叉子：fork您的帐户中的pages-cms/pages-cms存储库并部署该叉子。这将使您获得更新。确保定义上面列出的所有环境变量。

   2. 使用部署按钮：

3. 更新您的github oauth应用程序：一旦您拥有vercel url（例如“ callback url”和“ webhook url”，您可能需要返回GitHub应用程序设置以更新某些设置。

自主

还有很多其他选择：Fly.io，数字海洋，渲染，SST，等。

执照

此存储库中的所有内容均根据MIT许可发布。