diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-name-domain.png b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-name-domain.png new file mode 100644 index 00000000..8d4258ee Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-name-domain.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-permissions.png b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-permissions.png new file mode 100644 index 00000000..199b3e31 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-permissions.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-plan.png b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-plan.png new file mode 100644 index 00000000..176cca15 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-plan.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-verify-domain.png b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-verify-domain.png new file mode 100644 index 00000000..303d61c1 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-new-tenant-verify-domain.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-tenant-dns.png b/public/docs-static/img/how-to-guides/msp-portal/add-tenant-dns.png new file mode 100644 index 00000000..5fd3643f Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-tenant-dns.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-tenant-permissions.png b/public/docs-static/img/how-to-guides/msp-portal/add-tenant-permissions.png new file mode 100644 index 00000000..e91f9c5d Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-tenant-permissions.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/add-tenant.png b/public/docs-static/img/how-to-guides/msp-portal/add-tenant.png new file mode 100644 index 00000000..d3cacfa8 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/add-tenant.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenant-audit-log.png b/public/docs-static/img/how-to-guides/msp-portal/tenant-audit-log.png new file mode 100644 index 00000000..8fc3ba07 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenant-audit-log.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenant-switch.png b/public/docs-static/img/how-to-guides/msp-portal/tenant-switch.png new file mode 100644 index 00000000..334b35cf Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenant-switch.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenants-closeup.png b/public/docs-static/img/how-to-guides/msp-portal/tenants-closeup.png new file mode 100644 index 00000000..6492bfd4 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenants-closeup.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenants-dashboard.png b/public/docs-static/img/how-to-guides/msp-portal/tenants-dashboard.png new file mode 100644 index 00000000..16728ff4 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenants-dashboard.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenants-switcher.png b/public/docs-static/img/how-to-guides/msp-portal/tenants-switcher.png new file mode 100644 index 00000000..bf066ae4 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenants-switcher.png differ diff --git a/public/docs-static/img/how-to-guides/msp-portal/tenants.png b/public/docs-static/img/how-to-guides/msp-portal/tenants.png new file mode 100644 index 00000000..f5ac13a9 Binary files /dev/null and b/public/docs-static/img/how-to-guides/msp-portal/tenants.png differ diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 2a648683..1777e72c 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -203,6 +203,15 @@ export const docsNavigation = [ ] }, + + { + title: 'For Partners', + isOpen: false, + links: [ + { title: 'Managed Service Providers', href: '/how-to/msp-portal' }, + + ] + }, ], }, @@ -213,10 +222,9 @@ export const docsNavigation = [ { title: 'Serverless and NetBird', href: '/how-to/netbird-on-faas' }, { title: 'Routing peers and Kubernetes', href: '/how-to/routing-peers-and-kubernetes'}, { title: 'NetBird Client on AWS ECS', href: '/how-to/examples'}, - { title: 'Netbird on Mikrotik Router', href: '/how-to/client-on-mikrotik-router' }, + { title: 'NetBird on Mikrotik Router', href: '/how-to/client-on-mikrotik-router' }, ], - }, { title: 'SELF-HOST NETBIRD', diff --git a/src/pages/how-to/msp-portal.mdx b/src/pages/how-to/msp-portal.mdx new file mode 100644 index 00000000..6f3d60e5 --- /dev/null +++ b/src/pages/how-to/msp-portal.mdx @@ -0,0 +1,95 @@ +# NetBird MSP Portal for Managed Service Providers + +NetBird Cloud offers a multi-tenant MSP Portal for Managed Service Providers (MSPs) and Managed Security Service Providers (MSSPs) +to manage customers (tenants) from a single place. As an MSP, you can manage multiple NetBird accounts under your organization, +configure network settings, billing, and control network access for each tenant just like you would for your own NetBird account. + +An MSP account is a standard NetBird account with the added 'Tenants' section, allowing for the management of customer networks. +With an MSP account, you can also manage your own internal network, just like with a regular NetBird account. + +

+ tenants +

+ +The MSP Portal is designed to help you efficiently manage multiple tenant networks, providing a seamless experience for +switching between tenants and your MSP account. You can do so without the need to log in and out of different accounts +or inconvenient customer-specific URLs. + +

+ tenant-switch +

+ +## How to Apply for an MSP Account? +To apply for an MSP account, follow these steps: + +* Ensure you have an active NetBird subscription ([Team plan](https://netbird.io/pricing) or higher). +* Visit our MSP application form at [https://netbird.io/msp](https://netbird.io/demo?form=msp&utm_source=docs&utm_medium=docs&utm_content=msp-portal). +* Complete the application form with your details and company information. + +Submit the form for review by our team. Our team will evaluate your application and, if approved, grant you MSP status +and access to the MSP Portal. + +## Access the MSP Portal +Once approved as an MSP, you will see the 'Tenants' section in your NetBird dashboard. +You can now add new tenant accounts under your organization. + +## Add New Tenants + +In the 'Tenants' section of your dashboard, click on the 'Add Tenant' button to add a new tenant account. + +1. Provide the tenant's name and domain: +

+ add-new-tenant-name-domain +

+ +2. Define who can access the tenant account by selecting user groups of your account. Only users from the selected groups will +be able to access the tenant account. +

+ add-new-tenant-permissions +

+ +3. To ensure that you have rights to manage the tenant, you need to verify the ownership of the tenant domain by adding +a TXT DNS record to the tenant's domain: +

+ add-new-tenant-verify-domain +

+ +4. Once the domain is verified, select a plan for the tenant. You can opt for the Free Trial if you'd like to demo your +product to the customer before committing to a paid plan. + +

+ add-new-tenant-plan +

+ + + If you want to add an existing NetBird account as a tenant, please write us at msp@netbird.io providing the + tenant's owner email address. + + +## Manage Tenants + +Every user in your MSP account that has permissions to manage tenants can switch between the MSP account and tenant +accounts using the tenant switcher in the top right corner. + +Choose the tenant you want to manage from the dropdown list to switch to the tenant account and the system will redirect +you to the tenant's network. + +

+ tenant-switch +

+ + + If no tenants appear in the dropdown list, it may be because your user lacks the necessary permissions to manage tenants. + Please verify that your user is assigned to the appropriate groups listed under the 'Permission Groups' column in the 'Tenants' + table. + + +Once you switch to a tenant account, you can manage the tenant's network settings, enable integrations, control network access, and more. +Your user will have the 'Admin' role within the tenant account, granting you full administrative access. + +Note that your user will not appear in the 'Team' -> 'Users' section of the tenant account, as user management is handled +through the MSP account. However, your user will be visible in the Audit Log, labeled as 'External.' + +

+ audit-log +

\ No newline at end of file