diff --git a/docs.json b/docs.json index 48cd6fc5e..7958d8427 100644 --- a/docs.json +++ b/docs.json @@ -530,6 +530,7 @@ "pages": [ "registry/overview", "registry/publishing", + "registry/claim-my-node", "registry/standards", "registry/cicd", "registry/specifications" diff --git a/images/registry/claim-my-node/choose-a-publisher.png b/images/registry/claim-my-node/choose-a-publisher.png new file mode 100644 index 000000000..14cfe7623 Binary files /dev/null and b/images/registry/claim-my-node/choose-a-publisher.png differ diff --git a/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png b/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png new file mode 100644 index 000000000..9a2fd7b92 Binary files /dev/null and b/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png differ diff --git a/package-lock.json b/package-lock.json index be2c28fd3..4a3bb2ec1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "docs", + "name": "sno-claim-my-node", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/registry/claim-my-node.mdx b/registry/claim-my-node.mdx new file mode 100644 index 000000000..96f9e422e --- /dev/null +++ b/registry/claim-my-node.mdx @@ -0,0 +1,92 @@ +--- +title: "Claim My Node" +--- + +## Overview + +The **Claim My Node** feature allows developers to claim ownership of custom nodes in the ComfyUI Registry. This system ensures that only the rightful authors can manage and update their published nodes, providing security and accountability within the community. + +## What are Unclaimed Nodes? + +As we migrate from ComfyUI Manager to the Comfy Registry with new standards, many custom nodes that were previously listed in the ComfyUI Manager legacy system now appear as "unclaimed" in the registry. These are nodes that: + +- Were originally published in the ComfyUI Manager legacy system +- Have been migrated to the Comfy Registry to meet the latest standards +- Are waiting for their original authors to claim ownership + +We provide an easy way for developers to claim these migrated nodes, ensuring a smooth transition from the legacy system to the new registry standard while maintaining proper ownership and control. + +## Getting Started + +To claim your nodes: + +1. **Navigate to Your Unclaimed Node Page**: Visit your unclaimed node page, Click "Claim my node!" button. + +2. **Create a Publisher (if you don't have one yet)**: + - If you haven't created a publisher yet, you'll be prompted to create one. A publisher is required to claim nodes and manage them effectively. + +3. **Select a Publisher**: Choose the publisher under which you want to claim the node. this step will redirect you to the claim page. + +Choose a Publisher - Light Mode +Choose a Publisher - Dark Mode + +To claim the node under the choosed publisher, follow these steps: + +1. **Review Node Information:** + - Check the node details, including the name, repository link, and publisher status as shown on the screen. + +Claim Node Process Stage 1 - Light Mode +Claim Node Process Stage 1 - Dark Mode + +2. **GitHub Authentication:** + - Click the "Continue with GitHub" button to start the authentication process. Ensure you're logged in to the correct GitHub account with admin rights to the repository. + +3. **Verify Admin Access:** + - Once logged in, the system will verify if you have admin privileges for the specified GitHub repository. This step is crucial to ensure you have the necessary permissions. + +4. **Claim the Node:** + - If the verification is successful, Click "Claim" to claim the node. The publisher status will change, indicating ownership. + +5. **Complete!:** + - After successfully claiming the node, you can continue on [publishing](./publishing) and managing your node as the rightful owner. + +## Frequently Asked Questions + + + + + Any GitHub user can submit a claim request, but claims are verified against the original node repository and author information. + + + + Claims are automatically approved once GitHub admin permissions to the repository are verified. This happens instantly upon submitting your claim. + + + + Once approved, you'll have full control over your node's management, including publish versions, updates meta, deprecation, and policy settings. + + + + No, claims are automatically validated against GitHub repository admin permissions. Only users with admin access to the original repository can successfully claim nodes. + + + + Claims are automatically processed based on GitHub admin permissions. If you don't have admin access to the repository, the claim will be automatically denied. Contact the repository owner to request admin access if you believe you should have ownership rights. + + \ No newline at end of file diff --git a/zh-CN/registry/claim-my-node.mdx b/zh-CN/registry/claim-my-node.mdx new file mode 100644 index 000000000..4b63c2e55 --- /dev/null +++ b/zh-CN/registry/claim-my-node.mdx @@ -0,0 +1,92 @@ +--- +title: "认领我的节点" +--- + +## 概览 + +**认领我的节点**功能允许开发者在 Comfy Registry 中认领自定义节点的所有权。该系统确保只有合法的作者才能管理和更新其发布的节点,为社区提供安全性和问责制。 + +## 什么是未认领的节点? + +随着我们从 ComfyUI Manager 迁移到具有新标准的 Comfy Registry,许多之前在 ComfyUI Manager 传统系统中列出的自定义节点现在在 Registry 中显示为"未认领"。这些节点包括: + +- 最初在 ComfyUI Manager 传统系统中发布的节点 +- 已迁移到 Comfy Registry 以符合最新标准的节点 +- 等待其原始作者认领所有权的节点 + +我们为开发者提供了一种简单的方式来认领这些迁移的节点,确保从传统系统平滑过渡到新的 Registry 标准,同时保持适当的所有权和控制。 + +## 入门指南 + +要认领您的节点: + +1. **导航到您的未认领节点页面**:访问您的未认领节点页面,点击"认领我的节点!"按钮。 + +2. **创建发布者(如果您还没有的话)**: + - 如果您还没有创建发布者,系统会提示您创建一个。认领节点和有效管理节点需要发布者身份。 + +3. **选择发布者**:选择您想要用来认领节点的发布者。此步骤将重定向您到在选定发布者下的认领页面。 + +选择发布者 - 浅色模式 +选择发布者 - 深色模式 + +要在选定的发布者下认领节点,请按照以下步骤操作: + +1. **查看节点信息:** + - 检查节点详细信息,包括屏幕上显示的名称、仓库链接和发布者状态。 + +认领节点流程第一步 - 浅色模式 +认领节点流程第一步 - 深色模式 + +2. **GitHub 身份验证:** + - 点击"使用 GitHub 继续"按钮开始身份验证过程。确保您已登录到对该仓库具有管理员权限的正确 GitHub 账户。 + +3. **验证管理员访问权限:** + - 登录后,系统将验证您是否对指定的 GitHub 仓库具有管理员权限。此步骤对于确保您具有必要的权限至关重要。 + +4. **认领节点:** + - 如果验证成功,点击"认领"来认领节点。发布者状态将发生变化,表示所有权。 + +5. **完成!:** + - 成功认领节点后,您可以作为合法所有者继续进行[发布](./publishing)和管理您的节点。 + +## 常见问题 + + + + + 任何 GitHub 用户都可以提交认领请求,但认领会根据原始节点仓库和作者信息进行验证。 + + + + 一旦验证了对仓库的 GitHub 管理员权限,认领就会自动批准。这在提交认领时立即发生。 + + + + 一旦获得批准,您将完全控制节点的管理,包括发布版本、更新元数据、弃用和策略设置。 + + + + 不可以,认领会根据 GitHub 仓库管理员权限自动验证。只有对原始仓库具有管理员访问权限的用户才能成功认领节点。 + + + + 认领基于 GitHub 管理员权限自动处理。如果您对仓库没有管理员访问权限,认领将自动被拒绝。如果您认为自己应该拥有所有权权利,请联系仓库所有者请求管理员访问权限。 + + \ No newline at end of file