用 GPT 为你的 n8n 工作流写文档站点

用 GPT 为你的 n8n 工作流写文档站点

一个 n8n 工作流，为你自己 n8n 实例上的工作流提供一个小型文档站点。一个页面列出每个工作流的状态、日期和节点数。打开某个工作流的文档时，站点会用 GPT 写出它的描述，画出它的节点的 Mermaid 流程图，并把页面存成 Markdown 文件。你可以在实时编辑器里修改页面并重新生成。

里面有什么

• workflow.json：n8n 导出的工作流，六十个节点，其中十二个是便签。里面没有任何凭据。
• README.md：这份说明。

和原来的副本相比，我们改了什么

• 原来的模型是 gpt-4-turbo，OpenAI 已在 2026 年 10 月 23 日把它关停。OpenAI Chat Model 现在请求 gpt-5.6-sol，也就是 OpenAI 指明的替代品。0.2 的温度设置去掉了：这个模型的页面没有列出温度设置，推理模型也可能不接受。
• CONFIG 把 project_path 指向 n8n 自己的 .n8n 目录里的一个文件夹，而 n8n 默认不让文件节点碰这个目录。现在它是占位符 <YOUR_DOCS_FOLDER>。
• md files 的 docs 分支接受任何包含 docs_ 的文件名。像 docs_x/../../y.md 这样的名称就可能指向文档文件夹之外。现在它只接受以 docs_ 开头、且不含 /、\ 或 .. 的名称。
• 两个 webhook 原来对所有人开放。现在每个都有一个 IP 允许列表，里面是占位符 <YOUR_IP_ADDRESS>，所以在你填上自己的地址之前，没有人能使用这个站点。
• docsify webhook 原来用一个固定的 id 作路径，那是从作者自己的 n8n 里的一个 webhook 抄来的。现在路径是 docsify，你要按下面的步骤把它设成和你自己实例一致。
• Mermaid 库原来没有指定版本，Docsify 只指定了 4。现在加载的是 Mermaid 12.2.0 和 Docsify 4.13.1。
• 提示词要求一个叫 workflow_desription 的键，而解析器期望的是 workflow_description。现在用的是后一种拼写。
• 指向 OpenAI 和 n8n 凭据的链接，以及两个 webhook 的 id，都已去掉。

开始之前

• 一个你可以重启或重新配置的自托管 n8n。这个工作流会把 Markdown 文件写到一个文件夹里，运行一条 shell 命令，并读取环境变量。
• n8n 的 API 已开启，并有一个 API 密钥。
• 一个 OpenAI API 密钥。
• 一个 n8n 可以写入的文件夹。n8n 把它的文件节点限制在 ~/.n8n-files 之内，除非 N8N_RESTRICT_FILE_ACCESS_TO 指定了别的文件夹，而且它会拦住 .n8n 文件夹本身。

设置

1. 在 n8n 里新建一个工作流，打开它的菜单，选 Import from File。选中 workflow.json。
2. 在 CONFIG 里，把 <YOUR_DOCS_FOLDER> 换成文件夹的完整路径。如果 n8n 没有设置 N8N_PROTOCOL 和 N8N_HOST，就把 instance_url 换成你的 n8n 的地址。
3. 从 n8n 2.0 起，Execute Command 节点默认被排除在外。要么从 NODES_EXCLUDE 里去掉 n8n-nodes-base.executeCommand，要么停用节点 mkdir 并自己建好文件夹。停用的节点会把数据继续传下去。
4. 添加一个 n8n API 凭据，填你的实例地址后接 /api/v1，再填你的密钥。在 Get All Workflows、Get Workflow tags 和 Fetch Single Workflow1 里选中它。
5. 添加一个 OpenAI 凭据，在 OpenAI Chat Model 里选中它。
6. 保存。打开 single workflow，看它的生产地址里的 id，也就是 /webhook/ 与 /:file 之间的那一段。打开 docsify，把它的路径 docsify 换成那个 id。
7. 在 docsify 和 single workflow 的 IP Allowlist 选项里，把 <YOUR_IP_ADDRESS> 换成可以使用这个站点的一个或几个地址。
8. 发布工作流，打开 <YOUR_N8N_HOST>/webhook/ 加上那个 id。

一次请求的过程

1. docsify 用 Main Page 回应第一次访问，那是一个 Docsify 应用。然后应用以 webhook 的路径为基础，向 single workflow 请求它需要的文件。
2. README.md 是总览。Get All Workflows 取出各工作流，Sort-workflows 把最近改过的排在最前，Fill Workflow Table 为每个写一行表格，带有查看、编辑或重新生成它的文档的链接。
3. summary.md 是左侧栏。Get Workflow tags 和 Workflow Tags 把实例里的标签变成一个列表，点其中一个就打开那个标签的总览。
4. 名为 docs_<workflow id>.md 的文件是某个工作流的页面。doc action 读取地址里的 action。对于查看和编辑，mkdir 建好文件夹，Load Doc File 去找已保存的页面。
5. 没有已保存的页面时，Fetch Single Workflow1 取出这个工作流，Generate Mermaid Chart 把它的节点画成流程图，Basic LLM Chain 向 GPT 要一段描述和各节点的设置。Generated Doc 把它们拼在一起，Save New Doc File 写出文件。
6. 编辑会打开 Edit Page，一个实时的 Markdown 编辑器，保存则把文本发回 single workflow。重新生成会把页面再写一遍。

想换个结果，改这里

• 页面存放的位置：CONFIG 里的 project_path。
• GPT 怎么写：Basic LLM Chain 里的系统消息，以及 OpenAI Chat Model 里的模型。
• 总览的列：Fill Workflow Table 和 Instance overview。
• 站点的外观：CONFIG 里 HTML_headers 中的 Docsify 主题。
• 流程图的形状：Generate Mermaid Chart 里的代码。

值得知道的事

• 每次第一次查看一个没有已保存页面的工作流，以及每次重新生成，都是一次付费的 OpenAI 调用，会把工作流的节点和设置发给 OpenAI。打开某个工作流的页面之前，请先检查它的参数里有没有密钥。
• 从 n8n 2.0 起，Execute Command 节点默认被排除在外（n8n 的重大变更页面，2026 年 11 月 12 日读取）。
• 原来的副本没有认证，它自己的便签也这么说。Basic Auth 不适用于这个页面：n8n 在沙盒 iframe 里渲染 webhook 的 HTML，那里没有 Basic Auth 所需的请求头。这里靠允许列表来守门。
• docsify 的路径和 single workflow 的 id 必须一致，否则页面能打开，但每个文件请求都会失败。
• instance_url 由 N8N_PROTOCOL 和 N8N_HOST 拼成。只有当 N8N_BLOCK_ENV_ACCESS_IN_NODE 为 true 时，n8n 才会拦住表达式里的环境变量，而它默认是 false。
• Mermaid 是个很大的文件。页面第一次加载要等一会儿。
• 请求一个站点不认识的文件名，不会得到任何回应。
• 你的工作流数据会发给 OpenAI。页面和流程图会从 jsDelivr 加载脚本。