docs/embed/white-labelling.md

metadata

contentType: howto

White labelling

--8<-- "_snippets/embed-license.md"

White labelling n8n means customizing the frontend styling and assets to match your brand identity. The process involves changing two packages in n8n's source code github.com/n8n-io/n8n{:target=_blank .external-link}:

• packages/design-system{:target=_blank .external-link}: n8n's storybook{:target=_blank .external-link} design system with CSS styles and Vue.js components
• packages/editor-ui{:target=_blank .external-link}: n8n's Vue.js{:target=_blank .external-link} frontend build with Vite.js{:target=_blank .external-link}

Prerequisites

You need the following installed on your development machine:

--8<-- "_snippets/integrations/creating-nodes/prerequisites.md"

Create a fork of n8n's repository{:target=_blank .external-link} and clone your new repository.

git clone https://github.com/<your-organization>/n8n.git n8n
cd n8n

Install all dependencies, build and start n8n.

npm install
npm run build
npm run start

Whenever you make changes you need to rebuild and restart n8n. While developing you can use npm run dev to automatically rebuild and restart n8n anytime you make code changes.

Theme colors

To customize theme colors open packages/design-system{:target=_blank .external-link} and start with:

• packages/design-system/src/css/_tokens.scss{:target=_blank .external-link}
• packages/design-system/src/css/_tokens.dark.scss{:target=_blank .external-link}

At the top of _tokens.scss you will find --color-primary variables as HSL colors:

@mixin theme {
    --color-primary-h: 6.9;
    --color-primary-s: 100%;
    --color-primary-l: 67.6%;

In the following example the primary color changes to #0099ff. To convert to HSL you can use a color converter tool{:target=_blank .external-link}.

@mixin theme {
    --color-primary-h: 204;
    --color-primary-s: 100%;
    --color-primary-l: 50%;

Theme logos

To change the editor’s logo assets look into packages/editor-ui/public{:target=_blank .external-link} and replace:

• favicon-16x16.png
• favicon-32x32.png
• favicon.ico
• n8n-logo.svg
• n8n-logo-collapsed.svg
• n8n-logo-expanded.svg

Replace these logo assets. n8n uses them in Vue.js components, including:

• MainSidebar.vue{:target=_blank .external-link}: top/left logo in the main sidebar.
• Logo.vue: reused in other components.

In the following example replace n8n-logo-collapsed.svg and n8n-logo-expanded.svg to update the main sidebar's logo assets.

If your logo assets require different sizing or placement you can customize SCSS styles at the bottom of MainSidebar.vue{:target=_blank .external-link}.

.logoItem {
    display: flex;
    justify-content: space-between;
    height: $header-height;
    line-height: $header-height;
    margin: 0 !important;
    border-radius: 0 !important;
    border-bottom: var(--border-width-base) var(--border-style-base) var(--color-background-xlight);
    cursor: default;

    &:hover, &:global(.is-active):hover {
        background-color: initial !important;
    }

    * { vertical-align: middle; }
    .icon {
        height: 18px;
        position: relative;
        left: 6px;
    }

}

Text localization

To change all text occurrences like n8n or n8n.io to your brand identity you can customize n8n's English internationalization file: packages/editor-ui/src/plugins/i18n/locales/en.json{:target=_blank .external-link}.

n8n uses the Vue I18n{:target=_blank .external-link} internationalization plugin for Vue.js to translate the majority of UI texts. To search and replace text occurrences inside en.json you can use Linked locale messages{:target=_blank .external-link}.

In the following example add the _brand.name translation key to white label n8n's AboutModal.vue{:target=_blank .external-link}.

{
    "_brand.name": "My Brand",
    //replace n8n with link to _brand.name
    "about.aboutN8n": "About @:_brand.name",
    "about.n8nVersion": "@:_brand.name Version",
}

Window title

To change n8n's window title to your brand name, edit the following:

• packages/editor-ui/index.html{:target=_blank .external-link}
• packages/editor-ui/src/components/mixins/titleChange.ts{:target=_blank .external-link}

The following example replaces all occurrences of n8n and n8n.io with My Brand in index.html and titleChange.ts.

<!DOCTYPE html>
<html lang="en">
<head>
    <!-- Replace html title attribute -->
    <title>My Brand - Workflow Automation</title>
</head>

$titleSet(workflow: string, status: WorkflowTitleStatus) {
    // replace n8n prefix
    window.document.title = `My Brand - ${icon} ${workflow}`;
},

$titleReset() {
    // replace n8n prefix
    document.title = `My Brand - Workflow Automation`;
},