first commit
This commit is contained in:
224
docs/installation/credentials.md
Normal file
224
docs/installation/credentials.md
Normal file
@@ -0,0 +1,224 @@
|
||||
# 凭证管理 (Credentials)
|
||||
|
||||
**凭证是n8n连接外部世界的"钥匙"**。它用于安全地存储和管理连接外部服务(如数据库、API、邮箱)所需的授权信息(如API密钥、OAuth令牌、用户名密码等)。
|
||||
|
||||
## 📚 学习资源
|
||||
|
||||
- **图文教程**:[n8n凭证管理实战指南](https://jishuzhan.net/article/1951148541186977794)
|
||||
- **官方文档**:[Credentials Management](https://docs.n8n.io/credentials/)
|
||||
|
||||
## 🔐 凭证的重要性
|
||||
|
||||
**🛡️ 安全存储**:n8n对凭证进行加密存储,保护您的账户安全
|
||||
**🎯 集中管理**:在一个地方统一创建、查看和管理所有凭证
|
||||
**♻️ 重复使用**:创建一次凭证后,可在多个工作流和节点中重复使用
|
||||
**📋 最佳实践**:将敏感信息与工作流逻辑分离,更安全、更易于维护
|
||||
|
||||
## 🔧 凭证类型和配置
|
||||
|
||||
### 常用凭证类型
|
||||
|
||||
| 凭证类型 | 用途 | 配置信息 |
|
||||
|---------|------|----------|
|
||||
| **API Key** | 第三方服务认证 | API密钥、密钥名称 |
|
||||
| **OAuth2** | 社交媒体、云服务 | 客户端ID、密钥、授权URL |
|
||||
| **基本认证** | 简单用户名密码 | 用户名、密码 |
|
||||
| **数据库连接** | 数据库访问 | 主机、端口、用户名、密码 |
|
||||
| **SMTP邮箱** | 邮件发送 | 服务器、端口、认证信息 |
|
||||
|
||||
### 大模型凭证配置
|
||||
|
||||
AI模型集成是n8n的重要功能,需要配置相应的API凭证:
|
||||
|
||||
=== "OpenAI GPT"
|
||||
```yaml
|
||||
凭证类型: OpenAI
|
||||
API Key: sk-xxxxxxxxxxxxxxxxxxxxxxxx
|
||||
Organization ID: org-xxxxxxxxxxxxxxxx (可选)
|
||||
API Base URL: https://api.openai.com/v1 (默认)
|
||||
```
|
||||
|
||||
=== "Claude (Anthropic)"
|
||||
```yaml
|
||||
凭证类型: Anthropic
|
||||
API Key: sk-ant-xxxxxxxxxxxxxxxxxxxxxxxx
|
||||
API Version: 2023-06-01
|
||||
```
|
||||
|
||||
=== "Google Gemini"
|
||||
```yaml
|
||||
凭证类型: Google AI
|
||||
API Key: AIzaxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
=== "本地模型 (Ollama)"
|
||||
```yaml
|
||||
凭证类型: HTTP Request
|
||||
Base URL: http://localhost:11434
|
||||
认证: 无 (本地部署)
|
||||
```
|
||||
|
||||
### 邮箱凭证配置
|
||||
|
||||
邮件自动化是常见需求,以下是主流邮箱服务配置:
|
||||
|
||||
=== "Gmail"
|
||||
```yaml
|
||||
类型: Gmail OAuth2
|
||||
客户端ID: your-client-id.googleusercontent.com
|
||||
客户端密钥: your-client-secret
|
||||
刷新令牌: 通过OAuth流程获得
|
||||
```
|
||||
|
||||
!!! tip "Gmail设置提示"
|
||||
需要在Google Cloud Console启用Gmail API并创建OAuth2凭证
|
||||
|
||||
=== "Outlook/Hotmail"
|
||||
```yaml
|
||||
类型: Microsoft OAuth2
|
||||
应用程序ID: your-application-id
|
||||
客户端密钥: your-client-secret
|
||||
租户ID: common (个人账户)
|
||||
```
|
||||
|
||||
=== "企业邮箱 (SMTP)"
|
||||
```yaml
|
||||
类型: SMTP
|
||||
主机: smtp.yourcompany.com
|
||||
端口: 587 (TLS) 或 465 (SSL)
|
||||
用户名: your-email@company.com
|
||||
密码: your-app-password
|
||||
安全连接: STARTTLS
|
||||
```
|
||||
|
||||
### 数据库凭证配置
|
||||
|
||||
=== "MySQL"
|
||||
```yaml
|
||||
类型: MySQL
|
||||
主机: localhost 或 mysql.example.com
|
||||
端口: 3306
|
||||
数据库: your_database_name
|
||||
用户名: your_username
|
||||
密码: your_password
|
||||
SSL: 启用 (生产环境推荐)
|
||||
```
|
||||
|
||||
=== "PostgreSQL"
|
||||
```yaml
|
||||
类型: PostgreSQL
|
||||
主机: localhost
|
||||
端口: 5432
|
||||
数据库: your_database
|
||||
用户名: postgres
|
||||
密码: your_password
|
||||
SSL模式: require
|
||||
```
|
||||
|
||||
=== "MongoDB"
|
||||
```yaml
|
||||
类型: MongoDB
|
||||
连接字符串: mongodb://username:password@host:port/database
|
||||
数据库: your_database_name
|
||||
认证数据库: admin
|
||||
```
|
||||
|
||||
## 🔒 安全最佳实践
|
||||
|
||||
### 凭证安全原则
|
||||
|
||||
!!! danger "安全清单"
|
||||
- [ ] **强密码策略**:使用复杂且唯一的密码
|
||||
- [ ] **最小权限原则**:只授予必要的权限
|
||||
- [ ] **定期轮换**:定期更新API密钥和密码
|
||||
- [ ] **访问审计**:记录凭证使用情况
|
||||
- [ ] **环境隔离**:开发/测试/生产环境使用不同凭证
|
||||
|
||||
### 凭证命名规范
|
||||
|
||||
建议采用清晰的命名规范:
|
||||
|
||||
```
|
||||
服务名_环境_用途_版本
|
||||
例如:
|
||||
- gmail_prod_marketing_v1
|
||||
- mysql_dev_analytics_v2
|
||||
- openai_prod_chatbot_v1
|
||||
```
|
||||
|
||||
### 权限控制
|
||||
|
||||
| 权限级别 | 适用场景 | 权限范围 |
|
||||
|----------|----------|----------|
|
||||
| **只读** | 数据查询、报告生成 | 查看权限 |
|
||||
| **读写** | 数据同步、内容管理 | 增删改查 |
|
||||
| **管理员** | 系统集成、完整控制 | 全部权限 |
|
||||
|
||||
## 🛠️ 凭证创建和管理
|
||||
|
||||
### 创建新凭证
|
||||
|
||||
1. **进入凭证管理**
|
||||
- 点击左侧菜单 "Credentials"
|
||||
- 或在节点配置中点击 "Create New"
|
||||
|
||||
2. **选择凭证类型**
|
||||
- 从预定义类型中选择
|
||||
- 或选择 "Generic Authentication" 自定义
|
||||
|
||||
3. **填写配置信息**
|
||||
- 输入必要的认证信息
|
||||
- 设置凭证名称和描述
|
||||
|
||||
4. **测试连接**
|
||||
- 使用 "Test" 功能验证凭证
|
||||
- 确保连接成功后保存
|
||||
|
||||
### 凭证使用流程
|
||||
|
||||
**创建凭证** → **配置参数** → **测试连接** → **保存凭证** → **在节点中使用** → **工作流执行**
|
||||
|
||||
## 🔄 凭证维护和故障排除
|
||||
|
||||
### 常见问题和解决方案
|
||||
|
||||
| 问题 | 可能原因 | 解决方案 |
|
||||
|------|----------|----------|
|
||||
| **认证失败** | 密码或密钥错误 | 重新获取并更新凭证 |
|
||||
| **权限不足** | 账户权限限制 | 检查并提升账户权限 |
|
||||
| **连接超时** | 网络或服务器问题 | 检查网络连接和服务状态 |
|
||||
| **凭证过期** | Token或密钥过期 | 重新授权或更新凭证 |
|
||||
|
||||
### 维护策略
|
||||
|
||||
**定期检查**:
|
||||
```bash
|
||||
# 凭证健康检查清单
|
||||
□ 测试所有活跃凭证的连接状态
|
||||
□ 检查即将过期的Token
|
||||
□ 更新弱密码和过期凭证
|
||||
□ 清理不再使用的凭证
|
||||
□ 备份重要凭证配置
|
||||
```
|
||||
|
||||
**监控和告警**:
|
||||
- 设置凭证失效监控
|
||||
- 配置自动化健康检查工作流
|
||||
- 建立凭证问题通知机制
|
||||
|
||||
## 📚 实践示例
|
||||
|
||||
### 示例:配置Gmail发送工作报告
|
||||
|
||||
1. **创建Gmail OAuth2凭证**
|
||||
2. **设计工作流**:定时触发 → 生成报告数据 → 格式化邮件内容 → Gmail发送邮件
|
||||
3. **配置邮件节点使用凭证**
|
||||
4. **测试和部署**
|
||||
|
||||
详细图文示例请参考:[n8n凭证管理实战指南](https://jishuzhan.net/article/1951148541186977794)
|
||||
|
||||
---
|
||||
|
||||
掌握凭证管理是安全使用n8n的基础,也是构建可靠自动化系统的关键。
|
||||
|
||||
[上一章:界面介绍](interface/){ .md-button } [下一章:n8n汉化](localization/){ .md-button .md-button--primary }
|
||||
196
docs/installation/interface.md
Normal file
196
docs/installation/interface.md
Normal file
@@ -0,0 +1,196 @@
|
||||
# 界面介绍
|
||||
|
||||
## 📚 学习资源
|
||||
|
||||
- **详细界面教程**:[n8n界面完全指南](https://n8n.akashio.com/article/n8n-ui)
|
||||
- **快捷键大全**:在界面中按 `?` 查看完整快捷键列表
|
||||
- **视频教程**:观看官方界面操作演示
|
||||
|
||||
n8n的界面直观易用,主要由工作流画布、节点面板、参数配置区和执行日志等部分组成。
|
||||
|
||||
## 🖥️ 主界面布局
|
||||
|
||||
**顶部工具栏** → **左侧节点面板** + **中央画布区域** + **右侧属性面板** → **底部执行面板**
|
||||
|
||||
- **顶部工具栏**:工作流名称、保存、执行、激活/停用、设置
|
||||
- **左侧节点面板**:节点库,拖拽添加功能
|
||||
- **中央画布区域**:工作流设计区域
|
||||
- **右侧属性面板**:节点配置和参数设置
|
||||
- **底部执行面板**:执行历史和调试信息
|
||||
|
||||
## 🔧 核心功能区域
|
||||
|
||||
### 1. 顶部工具栏
|
||||
|
||||
| 功能 | 图标 | 说明 |
|
||||
|------|------|------|
|
||||
| **工作流名称** | 📝 | 点击可重命名工作流 |
|
||||
| **保存** | 💾 | 保存当前工作流 |
|
||||
| **执行** | ▶️ | 手动执行工作流 |
|
||||
| **激活/停用** | 🔄 | 控制工作流自动运行 |
|
||||
| **设置** | ⚙️ | 工作流设置和配置 |
|
||||
|
||||
### 2. 左侧节点面板
|
||||
|
||||
**功能分类**:
|
||||
- 🔥 **触发器 (Triggers)**:工作流的起点
|
||||
- 📥 **输入 (Input)**:数据获取节点
|
||||
- 🔄 **处理 (Process)**:数据处理和转换
|
||||
- 🧠 **逻辑 (Logic)**:条件判断和流程控制
|
||||
- 📤 **输出 (Output)**:结果输出和通知
|
||||
|
||||
**使用方法**:
|
||||
1. 浏览或搜索所需节点
|
||||
2. 拖拽到画布中央
|
||||
3. 连接节点建立数据流
|
||||
|
||||
### 3. 中央画布区域
|
||||
|
||||
这是设计工作流的主要区域:
|
||||
|
||||
**基本操作**:
|
||||
- **添加节点**:从左侧拖拽或按 `Tab` 键
|
||||
- **连接节点**:拖拽节点间的连接点
|
||||
- **移动节点**:直接拖拽节点位置
|
||||
- **删除节点**:选中后按 `Delete` 键
|
||||
|
||||
**画布快捷键**:
|
||||
|
||||
| 操作 | 快捷键 | 说明 |
|
||||
|------|--------|------|
|
||||
| 添加节点 | `Tab` | 快速添加节点菜单 |
|
||||
| 保存工作流 | `Ctrl + S` | 保存当前工作流 |
|
||||
| 执行工作流 | `Ctrl + Enter` | 手动执行 |
|
||||
| 全选 | `Ctrl + A` | 选择所有节点 |
|
||||
| 复制/粘贴 | `Ctrl + C/V` | 复制粘贴节点 |
|
||||
| 撤销/重做 | `Ctrl + Z/Y` | 撤销重做操作 |
|
||||
|
||||
### 4. 右侧属性面板
|
||||
|
||||
当选中节点时显示:
|
||||
|
||||
- **节点配置**:参数设置和选项
|
||||
- **凭证管理**:API密钥和认证信息
|
||||
- **表达式编辑器**:动态数据处理
|
||||
- **测试功能**:单独测试节点功能
|
||||
|
||||
### 5. 底部执行面板
|
||||
|
||||
显示工作流执行信息:
|
||||
|
||||
- **执行历史**:历史运行记录
|
||||
- **调试信息**:节点执行状态和数据
|
||||
- **错误日志**:失败原因和修复建议
|
||||
- **性能监控**:执行时间和资源使用
|
||||
|
||||
## 🎨 界面主题和定制
|
||||
|
||||
### 主题切换
|
||||
|
||||
n8n支持明暗两种主题:
|
||||
|
||||
=== "明亮主题"
|
||||
- 适合白天工作环境
|
||||
- 高对比度,清晰易读
|
||||
- 经典的工作界面风格
|
||||
|
||||
=== "暗色主题"
|
||||
- 适合长时间编程工作
|
||||
- 护眼,减少疲劳
|
||||
- 现代化的设计风格
|
||||
|
||||
### 布局自定义
|
||||
|
||||
**面板调整**:
|
||||
- 拖拽面板分割线调整大小
|
||||
- 双击面板标题折叠/展开
|
||||
- 右键菜单隐藏不需要的面板
|
||||
|
||||
**画布设置**:
|
||||
- 网格显示开关
|
||||
- 缩放级别控制
|
||||
- 节点对齐辅助线
|
||||
|
||||
## 🔍 搜索和导航
|
||||
|
||||
### 全局搜索
|
||||
|
||||
**搜索范围**:
|
||||
- 节点名称和描述
|
||||
- 工作流名称
|
||||
- 凭证名称
|
||||
- 执行历史
|
||||
|
||||
**搜索技巧**:
|
||||
- 使用关键词快速定位
|
||||
- 支持模糊匹配
|
||||
- 搜索结果按相关度排序
|
||||
|
||||
### 面包屑导航
|
||||
|
||||
显示当前位置和路径:
|
||||
```
|
||||
工作流 > 节点名称 > 配置选项
|
||||
```
|
||||
|
||||
## 📱 响应式设计
|
||||
|
||||
n8n界面支持不同屏幕尺寸:
|
||||
|
||||
| 屏幕尺寸 | 布局调整 | 建议操作 |
|
||||
|----------|----------|----------|
|
||||
| **大屏 (>1920px)** | 所有面板完整显示 | 最佳体验,推荐使用 |
|
||||
| **标准 (1366-1920px)** | 面板可调整大小 | 良好体验,主流配置 |
|
||||
| **小屏 (1024-1366px)** | 面板自动折叠 | 基本可用,建议折叠侧栏 |
|
||||
| **平板 (<1024px)** | 移动端适配布局 | 查看功能,不建议编辑 |
|
||||
|
||||
## 🎯 界面使用技巧
|
||||
|
||||
### 高效工作技巧
|
||||
|
||||
1. **快捷键组合**:
|
||||
```
|
||||
Ctrl + Tab # 快速添加节点
|
||||
Ctrl + D # 复制当前节点
|
||||
Shift + 方向键 # 精确移动节点
|
||||
```
|
||||
|
||||
2. **批量操作**:
|
||||
- 框选多个节点批量操作
|
||||
- 批量删除、复制和移动
|
||||
- 批量配置相同参数
|
||||
|
||||
3. **工作流组织**:
|
||||
- 使用注释节点添加说明
|
||||
- 合理命名节点和工作流
|
||||
- 使用颜色标记重要节点
|
||||
|
||||
### 调试和测试
|
||||
|
||||
1. **步骤执行**:
|
||||
- 单独测试每个节点
|
||||
- 查看数据流转过程
|
||||
- 验证输出结果
|
||||
|
||||
2. **错误处理**:
|
||||
- 查看详细错误信息
|
||||
- 使用错误触发器
|
||||
- 设置重试机制
|
||||
|
||||
!!! tip "界面优化建议"
|
||||
- 定期清理不用的工作流
|
||||
- 合理组织工作流文件夹
|
||||
- 使用标签系统分类管理
|
||||
- 定期导出备份重要工作流
|
||||
|
||||
## 📚 延伸学习
|
||||
|
||||
- **详细界面教程**:[n8n界面完全指南](https://n8n.akashio.com/article/n8n-ui)
|
||||
- **快捷键大全**:在界面中按 `?` 查看完整快捷键列表
|
||||
- **视频教程**:观看官方界面操作演示
|
||||
|
||||
---
|
||||
|
||||
掌握了界面操作后,您就可以高效地设计和管理工作流了!
|
||||
|
||||
[上一章:本地部署](local-deployment/){ .md-button } [下一章:凭证管理](credentials/){ .md-button .md-button--primary }
|
||||
75
docs/installation/local-deployment.md
Normal file
75
docs/installation/local-deployment.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# 本地/私有化部署
|
||||
|
||||
对于需要数据隐私控制、内网集成或大规模使用的场景,本地部署是最佳选择。
|
||||
|
||||
## 🚀 最简单的部署方式
|
||||
|
||||
### Docker部署(推荐)
|
||||
|
||||
**前置要求**:安装Docker和Docker Compose
|
||||
|
||||
**一键部署**:
|
||||
```bash
|
||||
# 创建目录
|
||||
mkdir n8n && cd n8n
|
||||
|
||||
# 下载配置文件
|
||||
curl -o docker-compose.yml https://raw.githubusercontent.com/n8n-io/n8n/master/docker/compose/withPostgres/docker-compose.yml
|
||||
|
||||
# 启动服务
|
||||
docker-compose up -d
|
||||
|
||||
# 访问 http://localhost:5678
|
||||
```
|
||||
|
||||
### npm安装(开发者)
|
||||
|
||||
**前置要求**:Node.js 18.10+
|
||||
|
||||
```bash
|
||||
# 全局安装n8n
|
||||
npm install n8n -g
|
||||
|
||||
# 启动n8n
|
||||
n8n start
|
||||
|
||||
# 访问 http://localhost:5678
|
||||
```
|
||||
|
||||
## 📚 学习资源
|
||||
|
||||
- **图文教程**:[n8n本地部署详解](https://blog.csdn.net/2501_90561511/article/details/147479401)
|
||||
- **视频教程**:[n8n Docker部署实战](https://www.bilibili.com/video/BV1kZNrzpEy6)
|
||||
- **官方文档**:[n8n Self-hosting](https://docs.n8n.io/hosting/)
|
||||
|
||||
## 🔧 基础配置
|
||||
|
||||
### 重要配置说明
|
||||
|
||||
**Volume映射配置**:
|
||||
- **数据存储**:`/home/node/.n8n` - 存储工作流和凭证
|
||||
- **文件访问**:`/files` - 工作流读写本地文件
|
||||
|
||||
**基础环境变量**:
|
||||
```bash
|
||||
GENERIC_TIMEZONE=Asia/Shanghai
|
||||
N8N_BASIC_AUTH_ACTIVE=true
|
||||
N8N_BASIC_AUTH_USER=admin
|
||||
N8N_BASIC_AUTH_PASSWORD=your-secure-password
|
||||
```
|
||||
|
||||
## 🏭 生产环境部署
|
||||
|
||||
对于生产环境部署,需要更详细的配置和安全设置。请参考:[生产环境部署指南](production-deployment.md)
|
||||
|
||||
## 📚 相关资源
|
||||
|
||||
- **图文教程**:[n8n本地部署详解](https://blog.csdn.net/2501_90561511/article/details/147479401)
|
||||
- **视频教程**:[n8n Docker部署实战](https://www.bilibili.com/video/BV1kZNrzpEy6)
|
||||
- **官方文档**:[n8n Self-hosting](https://docs.n8n.io/hosting/)
|
||||
|
||||
---
|
||||
|
||||
现在您已经成功部署了n8n!接下来可以开始配置界面和创建第一个工作流。
|
||||
|
||||
[上一章:快速开始](quick-start/){ .md-button } [下一章:界面介绍](interface/){ .md-button .md-button--primary }
|
||||
368
docs/installation/localization.md
Normal file
368
docs/installation/localization.md
Normal file
@@ -0,0 +1,368 @@
|
||||
# n8n汉化
|
||||
|
||||
## 📚 学习资源
|
||||
|
||||
- **汉化教程**:[n8n汉化指南](https://zhuanlan.zhihu.com/p/1937586953865372387)
|
||||
- **官方文档**:[n8n官方文档](https://docs.n8n.io)
|
||||
- **中文文档**:[n8n中文文档](https://docs.n8ncn.io)
|
||||
|
||||
在使用Docker部署时,可以通过添加环境变量和挂载中文语言包的方式实现界面汉化。
|
||||
|
||||
## 🌏 汉化的必要性
|
||||
|
||||
### 为什么需要汉化
|
||||
|
||||
<div class="feature-grid">
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">👥</div>
|
||||
<h3>团队协作</h3>
|
||||
<p>降低团队成员的学习门槛,提高工作效率</p>
|
||||
</div>
|
||||
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">📖</div>
|
||||
<h3>理解准确</h3>
|
||||
<p>避免因语言理解偏差导致的配置错误</p>
|
||||
</div>
|
||||
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">🎯</div>
|
||||
<h3>专注业务</h3>
|
||||
<p>减少语言障碍,专注于业务逻辑设计</p>
|
||||
</div>
|
||||
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">🚀</div>
|
||||
<h3>快速上手</h3>
|
||||
<p>新用户能更快熟悉界面和功能</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
## 🐳 Docker部署汉化方案
|
||||
|
||||
### 方案一:环境变量汉化
|
||||
|
||||
最简单的汉化方式是通过环境变量设置:
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
n8n:
|
||||
image: n8nio/n8n
|
||||
container_name: n8n
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5678:5678"
|
||||
environment:
|
||||
# 基础配置
|
||||
- GENERIC_TIMEZONE=Asia/Shanghai
|
||||
- N8N_DEFAULT_LOCALE=zh-CN
|
||||
- N8N_DEFAULT_BINARY_DATA_MODE=filesystem
|
||||
|
||||
# 界面汉化
|
||||
- LOCALE=zh-CN
|
||||
- LC_ALL=zh_CN.UTF-8
|
||||
- LANG=zh_CN.UTF-8
|
||||
|
||||
# 认证配置
|
||||
- N8N_BASIC_AUTH_ACTIVE=true
|
||||
- N8N_BASIC_AUTH_USER=admin
|
||||
- N8N_BASIC_AUTH_PASSWORD=your-password
|
||||
volumes:
|
||||
- n8n_data:/home/node/.n8n
|
||||
- /data/n8n/files:/files
|
||||
|
||||
volumes:
|
||||
n8n_data:
|
||||
```
|
||||
|
||||
### 方案二:挂载语言包
|
||||
|
||||
更完整的汉化需要挂载自定义语言包:
|
||||
|
||||
```yaml title="docker-compose.zh.yml"
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
n8n:
|
||||
image: n8nio/n8n
|
||||
container_name: n8n-zh
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5678:5678"
|
||||
environment:
|
||||
- GENERIC_TIMEZONE=Asia/Shanghai
|
||||
- N8N_DEFAULT_LOCALE=zh-CN
|
||||
- NODE_ENV=production
|
||||
volumes:
|
||||
- n8n_data:/home/node/.n8n
|
||||
- /data/n8n/files:/files
|
||||
# 挂载中文语言包
|
||||
- ./locales:/usr/local/lib/node_modules/n8n/dist/packages/editor-ui/dist/static/locales
|
||||
depends_on:
|
||||
- postgres
|
||||
|
||||
postgres:
|
||||
image: postgres:13
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- POSTGRES_USER=n8n
|
||||
- POSTGRES_PASSWORD=n8n_password
|
||||
- POSTGRES_DB=n8n
|
||||
# 设置数据库字符集
|
||||
- POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=zh_CN.UTF-8 --lc-ctype=zh_CN.UTF-8
|
||||
volumes:
|
||||
- postgres_data:/var/lib/postgresql/data
|
||||
|
||||
volumes:
|
||||
n8n_data:
|
||||
postgres_data:
|
||||
```
|
||||
|
||||
## 📁 语言包文件结构
|
||||
|
||||
### 创建本地语言包目录
|
||||
|
||||
```bash
|
||||
# 创建语言包目录
|
||||
mkdir -p /data/n8n/locales
|
||||
|
||||
# 下载中文语言包
|
||||
curl -o /data/n8n/locales/zh-CN.json https://raw.githubusercontent.com/n8n-io/n8n/master/packages/editor-ui/src/plugins/i18n/locales/zh.json
|
||||
```
|
||||
|
||||
### 自定义翻译内容
|
||||
|
||||
```json title="locales/zh-CN.json"
|
||||
{
|
||||
"n8n": {
|
||||
"auth": {
|
||||
"signin": "登录",
|
||||
"signup": "注册",
|
||||
"signout": "退出登录",
|
||||
"forgotPassword": "忘记密码"
|
||||
},
|
||||
"generic": {
|
||||
"save": "保存",
|
||||
"cancel": "取消",
|
||||
"delete": "删除",
|
||||
"edit": "编辑",
|
||||
"create": "创建",
|
||||
"search": "搜索",
|
||||
"loading": "加载中..."
|
||||
},
|
||||
"workflows": {
|
||||
"new": "新建工作流",
|
||||
"save": "保存工作流",
|
||||
"execute": "执行工作流",
|
||||
"activate": "激活",
|
||||
"deactivate": "停用"
|
||||
},
|
||||
"nodes": {
|
||||
"add": "添加节点",
|
||||
"delete": "删除节点",
|
||||
"duplicate": "复制节点",
|
||||
"rename": "重命名"
|
||||
},
|
||||
"credentials": {
|
||||
"title": "凭证管理",
|
||||
"create": "创建凭证",
|
||||
"edit": "编辑凭证",
|
||||
"test": "测试连接"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🛠️ 完整汉化部署脚本
|
||||
|
||||
### 一键汉化部署脚本
|
||||
|
||||
```bash title="setup-n8n-zh.sh"
|
||||
#!/bin/bash
|
||||
|
||||
# n8n中文版一键部署脚本
|
||||
|
||||
set -e
|
||||
|
||||
echo "🚀 开始部署n8n中文版..."
|
||||
|
||||
# 创建必要目录
|
||||
echo "📁 创建目录结构..."
|
||||
mkdir -p /data/n8n/{config,files,locales,backups}
|
||||
|
||||
# 下载语言包
|
||||
echo "🌏 下载中文语言包..."
|
||||
curl -s -o /data/n8n/locales/zh-CN.json \
|
||||
https://raw.githubusercontent.com/n8n-io/n8n/master/packages/editor-ui/src/plugins/i18n/locales/zh.json
|
||||
|
||||
# 创建docker-compose配置
|
||||
echo "🐳 创建Docker配置..."
|
||||
cat > /data/n8n/docker-compose.yml << 'EOF'
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:13
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- POSTGRES_USER=n8n
|
||||
- POSTGRES_PASSWORD=n8n_secure_password
|
||||
- POSTGRES_DB=n8n
|
||||
- POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=zh_CN.UTF-8 --lc-ctype=zh_CN.UTF-8
|
||||
volumes:
|
||||
- postgres_data:/var/lib/postgresql/data
|
||||
networks:
|
||||
- n8n-network
|
||||
|
||||
n8n:
|
||||
image: n8nio/n8n:latest
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "5678:5678"
|
||||
environment:
|
||||
# 数据库配置
|
||||
- DB_TYPE=postgresdb
|
||||
- DB_POSTGRESDB_HOST=postgres
|
||||
- DB_POSTGRESDB_PORT=5432
|
||||
- DB_POSTGRESDB_DATABASE=n8n
|
||||
- DB_POSTGRESDB_USER=n8n
|
||||
- DB_POSTGRESDB_PASSWORD=n8n_secure_password
|
||||
|
||||
# 基础配置
|
||||
- GENERIC_TIMEZONE=Asia/Shanghai
|
||||
- N8N_DEFAULT_LOCALE=zh-CN
|
||||
- N8N_ENCRYPTION_KEY=your-encryption-key-32-chars
|
||||
|
||||
# 界面汉化
|
||||
- LOCALE=zh-CN
|
||||
- LC_ALL=zh_CN.UTF-8
|
||||
- LANG=zh_CN.UTF-8
|
||||
|
||||
# 安全配置
|
||||
- N8N_BASIC_AUTH_ACTIVE=true
|
||||
- N8N_BASIC_AUTH_USER=admin
|
||||
- N8N_BASIC_AUTH_PASSWORD=admin_secure_password
|
||||
|
||||
# Webhook配置
|
||||
- WEBHOOK_URL=http://localhost:5678/
|
||||
|
||||
volumes:
|
||||
- /data/n8n/config:/home/node/.n8n
|
||||
- /data/n8n/files:/files
|
||||
- /data/n8n/locales:/usr/local/lib/node_modules/n8n/dist/packages/editor-ui/dist/static/locales
|
||||
depends_on:
|
||||
- postgres
|
||||
networks:
|
||||
- n8n-network
|
||||
|
||||
volumes:
|
||||
postgres_data:
|
||||
|
||||
networks:
|
||||
n8n-network:
|
||||
driver: bridge
|
||||
EOF
|
||||
|
||||
# 启动服务
|
||||
echo "🚀 启动n8n服务..."
|
||||
cd /data/n8n
|
||||
docker-compose up -d
|
||||
|
||||
# 等待服务启动
|
||||
echo "⏳ 等待服务启动..."
|
||||
sleep 30
|
||||
|
||||
# 检查服务状态
|
||||
echo "🔍 检查服务状态..."
|
||||
docker-compose ps
|
||||
|
||||
# 显示访问信息
|
||||
echo "✅ n8n中文版部署完成!"
|
||||
echo "🌐 访问地址: http://localhost:5678"
|
||||
echo "👤 用户名: admin"
|
||||
echo "🔑 密码: admin_secure_password"
|
||||
echo ""
|
||||
echo "📚 管理命令:"
|
||||
echo " 查看日志: cd /data/n8n && docker-compose logs -f"
|
||||
echo " 重启服务: cd /data/n8n && docker-compose restart"
|
||||
echo " 停止服务: cd /data/n8n && docker-compose down"
|
||||
echo " 备份数据: cd /data/n8n && docker-compose exec postgres pg_dump -U n8n n8n > backups/backup-\$(date +%Y%m%d).sql"
|
||||
```
|
||||
|
||||
### 运行部署脚本
|
||||
|
||||
```bash
|
||||
# 下载并执行部署脚本
|
||||
curl -sL https://raw.githubusercontent.com/your-repo/n8n-zh/main/setup.sh | bash
|
||||
|
||||
# 或者手动执行
|
||||
chmod +x setup-n8n-zh.sh
|
||||
./setup-n8n-zh.sh
|
||||
```
|
||||
|
||||
## 🎨 界面汉化效果
|
||||
|
||||
### 汉化前后对比
|
||||
|
||||
| 功能区域 | 英文原版 | 中文汉化 |
|
||||
|----------|----------|----------|
|
||||
| **主菜单** | Workflows, Credentials, Executions | 工作流, 凭证, 执行历史 |
|
||||
| **节点类型** | Triggers, Inputs, Processes, Outputs | 触发器, 输入, 处理, 输出 |
|
||||
| **操作按钮** | Execute, Save, Activate, Settings | 执行, 保存, 激活, 设置 |
|
||||
| **状态信息** | Running, Success, Error, Waiting | 运行中, 成功, 错误, 等待中 |
|
||||
|
||||
### 汉化覆盖范围
|
||||
|
||||
✅ **已汉化内容**:
|
||||
- 主界面菜单和导航
|
||||
- 节点分类和常用节点名称
|
||||
- 工作流操作按钮
|
||||
- 错误提示信息
|
||||
- 设置界面选项
|
||||
|
||||
⚠️ **部分汉化内容**:
|
||||
- 某些第三方节点名称
|
||||
- 高级配置选项
|
||||
- 开发者相关功能
|
||||
|
||||
❌ **未汉化内容**:
|
||||
- 社区节点描述
|
||||
- 技术文档链接
|
||||
- 日志详细信息
|
||||
|
||||
## 🔧 汉化问题排查
|
||||
|
||||
### 常见问题和解决方案
|
||||
|
||||
| 问题 | 症状 | 解决方案 |
|
||||
|------|------|----------|
|
||||
| **语言包未生效** | 界面仍显示英文 | 检查挂载路径和环境变量 |
|
||||
| **部分乱码** | 某些文字显示异常 | 确认字符集设置为UTF-8 |
|
||||
| **功能异常** | 汉化后功能出错 | 使用官方语言包版本 |
|
||||
|
||||
### 验证汉化是否成功
|
||||
|
||||
```bash
|
||||
# 检查容器环境变量
|
||||
docker exec n8n env | grep -E "(LANG|LOCALE)"
|
||||
|
||||
# 检查语言包文件
|
||||
docker exec n8n ls -la /usr/local/lib/node_modules/n8n/dist/packages/editor-ui/dist/static/locales/
|
||||
|
||||
# 查看n8n日志
|
||||
docker-compose logs n8n | grep -i locale
|
||||
```
|
||||
|
||||
## 📚 参考资源
|
||||
|
||||
- **详细汉化教程**: [n8n完整汉化指南](https://zhuanlan.zhihu.com/p/1937586953865372387)
|
||||
- **官方多语言支持**: [n8n Internationalization](https://docs.n8n.io/hosting/configuration/#internationalization)
|
||||
- **社区汉化项目**: GitHub上的中文社区维护版本
|
||||
|
||||
---
|
||||
|
||||
通过汉化,您的团队可以更高效地使用n8n,减少语言障碍带来的学习成本。
|
||||
|
||||
[上一章:凭证管理](credentials.md){ .md-button } [下一章:常用节点](../learning/common-nodes.md){ .md-button .md-button--primary }
|
||||
180
docs/installation/quick-start.md
Normal file
180
docs/installation/quick-start.md
Normal file
@@ -0,0 +1,180 @@
|
||||
# 快速开始(n8n Cloud)
|
||||
|
||||
对于希望立即体验而无需任何部署的用户,n8n官方云服务是最佳选择。
|
||||
|
||||
## ☁️ n8n Cloud优势
|
||||
|
||||
**⚡ 即时启动**:无需下载、安装或配置,注册后立即可用
|
||||
**🛡️ 免维护**:官方负责所有技术维护,自动更新和备份
|
||||
**🌍 全球访问**:任何地方都能访问您的工作流,支持团队协作
|
||||
**🔒 企业级安全**:SOC2认证,数据加密存储,符合GDPR标准
|
||||
|
||||
## 🚀 5分钟快速上手
|
||||
|
||||
### 第一步:注册账户
|
||||
|
||||
1. 访问 [n8n.io](https://n8n.io/)
|
||||
2. 点击 "Get started for free" 按钮
|
||||
3. 使用邮箱注册或选择第三方登录(GitHub、Google)
|
||||
|
||||
!!! tip "注册建议"
|
||||
建议使用企业邮箱注册,便于后续的团队协作功能
|
||||
|
||||
### 第二步:创建第一个工作流
|
||||
|
||||
注册完成后,您将进入n8n的主界面:
|
||||
|
||||
1. **点击 "Create Workflow"** 创建新工作流
|
||||
2. **添加触发节点**:选择 "Manual Trigger" 开始
|
||||
3. **添加处理节点**:尝试添加 "Set" 节点设置数据
|
||||
4. **连接节点**:拖拽连线连接各个节点
|
||||
|
||||
<div class="workflow-diagram">
|
||||
<div class="workflow-step">
|
||||
<div class="step-box trigger">📋 手动触发</div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box process">⚙️ 设置节点</div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box request">🌐 HTTP请求</div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box output">📧 发送邮件</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
**工作流执行顺序:**
|
||||
1. **手动触发** - 用户点击开始按钮
|
||||
2. **设置节点** - 配置和处理数据
|
||||
3. **HTTP请求** - 调用外部API获取信息
|
||||
4. **发送邮件** - 将结果通过邮件发送
|
||||
|
||||
### 第三步:测试执行
|
||||
|
||||
1. 点击工作流左上角的 "Execute Workflow" 按钮
|
||||
2. 观察每个节点的执行状态和数据流转
|
||||
3. 检查输出结果是否符合预期
|
||||
|
||||
### 第四步:保存和部署
|
||||
|
||||
1. **保存工作流**:Ctrl+S 或点击保存按钮
|
||||
2. **激活工作流**:打开右上角的激活开关
|
||||
3. **测试生产运行**:工作流将按设定条件自动运行
|
||||
|
||||
## 📱 云端界面导览
|
||||
|
||||
### 主要功能区域
|
||||
|
||||
| 区域 | 功能说明 | 快捷键 |
|
||||
|------|----------|--------|
|
||||
| **节点面板** | 左侧节点库,拖拽添加功能 | N |
|
||||
| **画布区域** | 中央工作流设计区域 | - |
|
||||
| **属性面板** | 右侧节点配置面板 | - |
|
||||
| **执行面板** | 底部执行历史和日志 | E |
|
||||
|
||||
### 常用快捷键
|
||||
|
||||
| 功能 | Windows/Linux | Mac |
|
||||
|------|---------------|-----|
|
||||
| 保存工作流 | `Ctrl + S` | `Cmd + S` |
|
||||
| 执行工作流 | `Ctrl + Enter` | `Cmd + Enter` |
|
||||
| 添加节点 | `Tab` | `Tab` |
|
||||
| 删除节点 | `Delete` | `Delete` |
|
||||
| 复制节点 | `Ctrl + C` | `Cmd + C` |
|
||||
| 粘贴节点 | `Ctrl + V` | `Cmd + V` |
|
||||
|
||||
## 🎯 第一个实用工作流
|
||||
|
||||
让我们创建一个简单但实用的工作流:**每日天气邮件提醒**
|
||||
|
||||
### 工作流设计
|
||||
|
||||
<div class="workflow-diagram">
|
||||
<div class="workflow-step">
|
||||
<div class="step-box trigger">⏰ 定时触发<br><small>每天8:00</small></div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box request">🌤️ 天气API<br><small>获取天气数据</small></div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box process">📊 数据处理<br><small>格式化天气信息</small></div>
|
||||
<div class="arrow">→</div>
|
||||
<div class="step-box output">📧 邮件发送<br><small>天气预报推送</small></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
**天气邮件工作流说明:**
|
||||
- **定时触发器** → 每天早上8点自动启动
|
||||
- **天气API请求** → 从OpenWeatherMap获取当地天气
|
||||
- **数据处理** → 提取温度、湿度、天气描述等信息
|
||||
- **邮件发送** → 发送格式化的天气预报到指定邮箱
|
||||
|
||||
### 配置步骤
|
||||
|
||||
=== "1. 定时触发器"
|
||||
- 选择 "Schedule Trigger" 节点
|
||||
- 设置触发时间:每天上午8:00
|
||||
- 配置时区:选择您所在的时区
|
||||
|
||||
=== "2. 天气API请求"
|
||||
- 添加 "HTTP Request" 节点
|
||||
- URL: `https://api.openweathermap.org/data/2.5/weather`
|
||||
- 参数: `q=Beijing&appid=YOUR_API_KEY`
|
||||
- 请求方法: GET
|
||||
|
||||
=== "3. 数据处理"
|
||||
- 添加 "Set" 节点
|
||||
- 提取温度、天气描述等字段
|
||||
- 格式化为友好的文本信息
|
||||
|
||||
=== "4. 邮件发送"
|
||||
- 添加 "Email" 节点
|
||||
- 配置SMTP凭证
|
||||
- 设置收件人和邮件模板
|
||||
|
||||
## 🎁 免费额度说明
|
||||
|
||||
n8n Cloud提供慷慨的免费额度:
|
||||
|
||||
<div class="stats-grid">
|
||||
<div class="stat-item">
|
||||
<span class="stat-number">5,000</span>
|
||||
<span class="stat-label">每月执行次数</span>
|
||||
</div>
|
||||
<div class="stat-item">
|
||||
<span class="stat-number">无限</span>
|
||||
<span class="stat-label">工作流数量</span>
|
||||
</div>
|
||||
<div class="stat-item">
|
||||
<span class="stat-number">2</span>
|
||||
<span class="stat-label">团队成员</span>
|
||||
</div>
|
||||
<div class="stat-item">
|
||||
<span class="stat-number">7天</span>
|
||||
<span class="stat-label">执行历史</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
!!! info "升级建议"
|
||||
如果您需要更多执行次数或高级功能,可以考虑升级到付费计划。企业用户通常在第一个月就能通过效率提升收回成本。
|
||||
|
||||
## 🔄 从云端到本地
|
||||
|
||||
当您熟悉n8n后,可能会考虑本地部署:
|
||||
|
||||
| 云端 → 本地的考虑因素 | 说明 |
|
||||
|-------------------|------|
|
||||
| **数据敏感性** | 如果处理敏感数据,本地部署更安全 |
|
||||
| **成本控制** | 大量使用时,本地部署成本更低 |
|
||||
| **定制需求** | 需要自定义节点或深度集成 |
|
||||
| **网络环境** | 内网系统集成需要本地部署 |
|
||||
|
||||
## 📚 延伸学习
|
||||
|
||||
完成快速开始后,建议继续学习:
|
||||
|
||||
- [界面介绍](interface/) - 深入了解n8n界面
|
||||
- [常用节点](../learning/common-nodes/) - 掌握核心功能节点
|
||||
- [基本工作流创建](../learning/basic-workflows/) - 系统学习工作流设计
|
||||
|
||||
---
|
||||
|
||||
恭喜您完成了n8n的快速开始!现在您已经具备了创建基本自动化工作流的能力。
|
||||
|
||||
[下一章:本地部署](local-deployment/){ .md-button .md-button--primary }
|
||||
Reference in New Issue
Block a user