cos-uploadfile

A custom n8n node to upload files to Tencent Cloud Object Storage (COS).

Package Information

Downloads: 4 weekly / 87 monthly
Latest Version: 1.1.3
Author: Your Name/Organization

Documentation


好的,这是一个为您的 n8n 腾讯云 COS 文件上传节点生成的 README.md 文档。它包含了所有必要的安装、使用、配置说明,并采用了清晰、专业的格式。


n8n 腾讯云 COS 文件上传节点


一个用于 n8n 的自定义节点,旨在简化将本地文件上传到腾讯云对象存储(COS)的过程。


🚀 功能特性

  • 本地文件上传: 轻松将指定本地路径的文件上传至腾讯云 COS。
  • HTML内容上传: 支持将HTML内容写入临时文件并上传到COS,适合处理动态生成的网页内容。
  • 安全凭证管理: 通过 n8n 的凭证系统安全配置您的 SecretIdSecretKey,避免在工作流中暴露敏感信息。
  • 灵活配置: 支持自定义存储桶名称、地域和对象键,满足不同的存储需求。
  • 健壮的错误处理: 在上传失败时提供明确的错误信息,便于调试和工作流异常处理。

📋 更新日志

v1.1.0 (最新)

  • 新增HTML内容上传功能

    • 支持将HTML内容直接写入临时文件并上传
    • 新增上传模式选择:本地文件上传 / HTML内容上传
    • 自动清理临时文件,避免磁盘空间浪费
    • 支持自定义HTML文件名
  • 🔧 技术架构优化

    • cos-js-sdk-v5 切换到 cos-nodejs-sdk-v5
    • 修复Node.js环境下文件上传兼容性问题
    • 优化错误处理和调试信息
  • 🎨 用户体验改进

    • 新增条件显示功能,根据上传模式动态显示相关配置项
    • 改进节点配置界面,提供更直观的操作体验
    • 增强错误信息,包含调试用的文件列表信息

v1.0.5

  • 🎉 初始版本发布
    • 基础本地文件上传功能
    • 腾讯云COS凭证管理
    • 多地域支持

🛠️ 安装

1. 从 npm 安装 (推荐)

最推荐的安装方式是通过 n8n 的社区节点安装界面。

  1. 打开您的 n8n 实例 UI。
  2. 导航到 "Settings" (设置) -> "Community Nodes" (社区节点)。
  3. 点击 "Install a community node" (安装社区节点)。
  4. 在 "npm package name" 字段中输入您的包名:
    n8n-nodes-cos-uploadfile
    
  5. 点击 "Install" (安装)。
  6. 安装完成后,您需要重启 n8n 服务以加载新节点。

2. 手动安装 (高级用户)

如果您希望手动安装,可以按照以下步骤操作:

  1. 在您的 n8n 用户目录中找到或创建 custom 文件夹。

    • Linux/macOS: ~/.n8n/custom/
    • Windows: %USERPROFILE%\.n8n\custom\
    • Docker: 如果您通过 Docker 运行 n8n,通常需要将宿主机的一个目录映射到容器内的 /home/node/.n8n/custom/
  2. 进入该 custom 目录。

  3. 在新目录中安装您的节点包:

    cd ~/.n8n/custom/ # 替换为您的实际路径
    npm install n8n-nodes-cos-uploadfile
    
  4. 重启 n8n 服务。


⚙️ 如何使用

1. 配置腾讯云 COS API 凭证

在您使用此节点之前,您需要配置您的腾讯云 COS API 凭证(SecretIdSecretKey)。

  1. 在 n8n UI 中,点击左侧导航栏的 "Credentials" (凭证) 图标。
  2. 点击 "New Credential" (新建凭证)。
  3. 在 "Credential Type" (凭证类型) 中搜索并选择 "腾讯云 COS API"
  4. 在弹出的对话框中,输入您的 SecretIdSecretKey
  5. 点击 "Create" (创建) 保存凭证。

2. 在工作流中使用节点

  1. 在您的 n8n 工作流中添加一个新节点。

  2. 在节点搜索框中输入 "COS 文件上传" 或 "Tencent COS Upload"。

  3. 选择 "腾讯云 COS 文件上传" 节点。

  4. 在节点配置中:

    • Credential (凭证): 从下拉菜单中选择您之前创建的 "腾讯云 COS API" 凭证。
    • 上传模式: 选择 "本地文件上传" 或 "HTML内容上传"。

    本地文件上传模式:

    • 本地文件路径 (File Path): 输入您希望上传的本地文件的绝对路径 (例如:/home/user/documents/report.pdfC:\Users\User\Desktop\image.jpg)。

    HTML内容上传模式:

    • HTML内容: 输入要上传的HTML代码内容。
    • HTML文件名: 设置生成的HTML文件名(默认:index.html)。

    通用配置:

    • 存储桶名称 (Bucket): 输入您的腾讯云 COS 存储桶的完整名称(例如:my-test-bucket-125xxxxxxxxx,包含 APPID)。
    • 存储桶地域 (Region): 从下拉菜单中选择您的存储桶所在的地域(例如:广州 (ap-guangzhou))。
    • 对象键 (Key): 输入文件在 COS 中存储的完整路径和文件名(例如:my-folder/my-report.pdf)。
  5. 配置完成后,运行工作流。节点将根据选择的上传模式执行相应的上传操作。

3. 使用场景示例

场景一:上传本地文件

  • 选择"本地文件上传"模式
  • 填写本地文件路径
  • 配置COS存储信息
  • 执行上传

场景二:上传HTML内容

  • 选择"HTML内容上传"模式
  • 在HTML内容框中粘贴网页代码
  • 设置HTML文件名(如 index.html
  • 配置COS存储信息
  • 系统自动创建临时文件并上传

🤝 贡献

欢迎任何形式的贡献!如果您有功能建议、Bug 报告或想提交代码,请随时访问本项目的 GitHub 仓库


📄 许可证

本项目根据 MIT 许可证发布。详情请查看 LICENSE 文件。


Discussion