如何将Node-RED代码推送至GitHub且不泄露敏感信息?
Node-RED敏感信息安全配置方案(适配GitHub提交场景)
方案1:环境变量方案(和Python os.environ.get 逻辑完全一致)
- 配置方式:Node-RED 1.0及以上版本默认支持读取项目根目录下的
.env文件,你可以将所有敏感信息写入该文件,格式为键=值,示例:WIFI_PASSWORD=你的WiFi实际密码 DB_MYSQL_PWD=你的数据库访问密码 NR_CRED_SECRET=你的自定义凭证加密密钥 - 提交规则配置:在项目的
.gitignore文件中添加.env,确保该文件不会被上传到GitHub。 - 调用方式:
- 可视化节点配置时,密码、认证令牌等敏感字段直接填写
${环境变量键名}即可,例如MQTT节点的密码字段填${WIFI_PASSWORD},Node-RED运行时会自动替换为对应的实际值。 - 函数节点中可以直接调用
env.get("环境变量键名")获取对应值,使用逻辑和Python的os.environ.get完全一致。 - 如需在
settings.js中读取敏感值,直接调用Node.js原生的process.env.环境变量键名即可。
- 可视化节点配置时,密码、认证令牌等敏感字段直接填写
方案2:Node-RED内置凭证加密方案
- Node-RED默认会把所有节点中配置的凭证类信息(密码、密钥、令牌等)单独存储在
credentials_<项目名>.json文件中,不会和普通流配置混写在同一文件。 - 你可以在
settings.js中配置credentialSecret: process.env.NR_CRED_SECRET,所有凭证文件会用该密钥加密,就算误将凭证文件提交到GitHub,没有密钥也无法解密出原始敏感信息。 - 也可以直接将
credentials_*.json加入.gitignore,完全不提交凭证文件,本地使用时自行配置即可。 - 若开启了Node-RED的内置项目管理功能,初始化项目时会自动生成符合规则的
.gitignore文件,无需手动调整基础规则。
核心注意事项
- 所有本地私有配置(.env、自定义本地配置文件等)必须提前加入
.gitignore,避免误提交。 settings.js中不要硬编码任何敏感信息,所有敏感值统一通过环境变量读取,这样settings.js本身可以安全提交到GitHub。- 不要将
credentialSecret的明文值写入任何提交到GitHub的文件中。
内容的提问来源于stack exchange,提问作者Portfedh
相关产品推荐
相关产品推荐

