配置#

认证#

您可以通过设置用户管理来保护n8n，这是n8n内置的身份验证功能。

n8n支持LDAP和SAML。

凭证覆盖#

为了向用户提供OAuth登录功能，可以在全局范围内覆盖credentials。这些凭证数据对用户不可见，但后端会自动使用它们。

在编辑器界面中，n8n默认隐藏所有被覆盖的字段。这意味着用户可以通过点击凭据上的"connect"按钮使用OAuth进行身份验证。

n8n提供两种应用凭证覆盖的方式：使用环境变量和使用REST API。

使用环境变量#

您可以通过设置环境变量CREDENTIALS_OVERWRITE_DATA为{ CREDENTIAL_NAME: { PARAMETER: VALUE }}来配置凭证覆盖。

使用REST API#

推荐的方式是通过自定义REST端点加载数据。将CREDENTIALS_OVERWRITE_ENDPOINT设置为该端点应提供的路径。

例如：

1. 通过设置n8n运行环境中的环境变量来激活端点：

   1	export CREDENTIALS_OVERWRITE_ENDPOINT=send-credentials

2. 然后需要一个包含凭证的JSON文件来进行覆盖。例如，一个用于覆盖Asana和GitHub凭证的oauth-credentials.json文件可能如下所示：

   1 2 3 4 5 6 7 8 9 10

   { "asanaOAuth2Api": { "clientId": "", "clientSecret": "" }, "githubOAuth2Api": { "clientId": "", "clientSecret": "" } }

3. 然后通过使用curl发送将其应用到实例：

   1	curl -H "Content-Type: application/json" --data @oauth-credentials.json http://localhost:5678/send-credentials

环境变量#

n8n有许多环境变量可供配置。以下是托管解决方案中最相关的环境变量：

后端钩子#

可以定义外部钩子，当特定操作运行时，n8n会执行这些钩子。例如，您可以使用这些钩子来记录数据、修改数据，或通过抛出错误来禁止某个操作。

可用钩子#

注册钩子#

通过注册包含钩子函数的钩子文件来设置钩子。 要注册钩子，请设置环境变量 EXTERNAL_HOOK_FILES。

您可以将变量设置为单个文件：

EXTERNAL_HOOK_FILES=/data/hook.js

或者包含多个以分号分隔的文件：

EXTERNAL_HOOK_FILES=/data/hook1.js;/data/hook2.js

后端钩子文件#

Hook文件是遵循以下格式的常规JavaScript文件：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

module.exports = {
    "frontend": {
        "settings": [
            async function (settings) {
                settings.oauthCallbackUrls.oauth1 = 'https://n8n.example.com/oauth1/callback';
                settings.oauthCallbackUrls.oauth2 = 'https://n8n.example.com/oauth2/callback';
            }
        ]
    },
    "workflow": {
        "activate": [
            async function (workflowData) {
                const activeWorkflows = await this.dbCollections.Workflow.count({ active: true });

                if (activeWorkflows > 1) {
                    throw new Error(
                        'Active workflow limit reached.'
                    );
                }
            }
        ]
    }
}

后端钩子函数#

钩子或钩子文件可以包含多个钩子函数，所有函数会依次执行。

如果钩子函数的参数是对象，可以通过修改该参数的数据来改变n8n的行为。

你也可以在任何钩子函数中使用this.dbCollections访问数据库（参考后端钩子文件中的代码示例）。

前端外部钩子#

与后端外部钩子类似，可以在前端代码中定义由n8n执行的外部钩子，当用户执行特定操作时触发。例如，您可以使用它们来记录数据和修改数据。

可用钩子#

注册钩子#

You can set hooks by loading the hooks script on the page. One way to do this is by creating a hooks file in the project and adding a script tag in your editor-ui/public/index.html file:

1

<script src="frontend-hooks.js"></script>

前端钩子文件#

前端外部钩子文件是遵循以下格式的常规JavaScript文件：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

window.n8nExternalHooks = {
  nodeView: {
    mount: [
      function (store, meta) {
        // do something
      },
    ],
    createNodeActiveChanged: [
      function (store, meta) {
        // do something
      },
      function (store, meta) {
        // do something else
      },
    ],
    addNodeButton: [
      function (store, meta) {
        // do something
      },
    ],
  },
};

前端钩子函数#

您可以为每个钩子定义多个钩子函数。每个钩子函数调用时会传入以下参数：

• store: Vuex存储对象。您可以使用它来更改或从存储中获取数据。
• metadata: 包含钩子提供的任何数据的对象。要查看传递的内容，请在editor-ui包中搜索该钩子。