-
Notifications
You must be signed in to change notification settings - Fork 143
Add Sign-in Domains page #970
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
heisbrot
wants to merge
15
commits into
main
Choose a base branch
from
docs/sign-in-domains
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
ca4c63e
Add Sign-in Domains page
heisbrot 4ce1722
Tighten the Sign-in Domains page
heisbrot 02bfc99
Trim the Sign-in Domains page further
heisbrot c487a6e
Move Sign-in Domains under Settings, and lead with the two domains
heisbrot 2a3374d
Lead with what sign-in domains are for
heisbrot 4c9900a
Sharpen the intro and drop the primary-domain aside
heisbrot 25e0a15
Shorten the one-account-per-domain note
heisbrot ec61e05
Drop the SSO section, and nest the page under Authentication
heisbrot 277dd33
Follow the dashboard: Sign-in Domains lives under Authentication
heisbrot 77502ea
Move the page under Single Sign-On
heisbrot f70363d
Put the page at manage/team/sign-in-domains
heisbrot 51b9dd0
Fix wording and a stale example domain
heisbrot f169ca0
Drop the authentication clause from the recap
heisbrot b1e846a
Add the Sign-in Domains screenshots
heisbrot a7fe57b
Point domain verification help at NetBird Support
heisbrot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+115 KB
public/docs-static/img/manage/team/sign-in-domains/authentication-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+142 KB
public/docs-static/img/manage/team/sign-in-domains/dns-verification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import {Note, Warning} from "@/components/mdx" | ||
|
|
||
| export const description = | ||
| 'Users on your business email domain join your account automatically. Add and verify the other domains your business uses, so their users join the same account instead of creating one of their own.' | ||
|
|
||
| # Allow Users from Other Domains to Join Your Account | ||
|
|
||
| By default, users who sign in with the same business email domain as yours join the same account. | ||
| For example, everyone on `@company.com` lands in your network, with the same peers and policies. | ||
|
|
||
| In most cases a business uses more than one domain: a country domain like `company.co.uk`, a subsidiary like `company-berlin.de`, or a second brand. | ||
| A colleague signing in as `jane@company.co.uk` is not recognized as yours unless you [invite them manually](/manage/team/add-users-to-your-network), so they | ||
| get an account of their own. | ||
|
|
||
| **Sign-in domains** allow users from other domains to join your account without manually inviting them beforehand. | ||
| You prove ownership of those domains, and everyone across your organization joins the same account automatically. | ||
|
|
||
| <Note> | ||
| **Availability**: Sign-in Domains is only available on NetBird Cloud. | ||
| </Note> | ||
| <Note> | ||
| **Permissions**: Only an Owner or Admin can manage sign-in domains. Learn more about [user roles](/manage/team/user-roles). | ||
| </Note> | ||
|
|
||
| <Warning> | ||
| Verifying a domain does not move users who already have an account of their own. It decides where **new** users land, so add your domains before onboarding a team from another domain rather than after. | ||
|
|
||
| If someone turns out to have an earlier account they were not aware of, have them reach out to [NetBird Support](/help/netbird-support). The team verifies their identity and points them to whoever administers that account. | ||
| </Warning> | ||
|
|
||
| ## Add Domain | ||
|
|
||
| Go to **Settings → Authentication**, find **Sign-in Domains**, then click **Add** and enter the domain, e.g. `company.co.uk`. | ||
|
|
||
| <p> | ||
| <img src="/docs-static/img/manage/team/sign-in-domains/authentication-tab.png" | ||
| alt="The Sign-in Domains section of the Authentication tab, listing the account's domains with their verification status" className="imagewrapper-big"/> | ||
| </p> | ||
|
|
||
| The domain starts as **Pending** until you prove you own it. | ||
|
|
||
| ## Verify Domain | ||
|
|
||
| Click **Verify** on the pending domain. NetBird shows a TXT record to publish at the root of the domain, so on `company.co.uk` itself rather than `www.company.co.uk`. | ||
|
|
||
| <p> | ||
| <img src="/docs-static/img/manage/team/sign-in-domains/dns-verification.png" | ||
| alt="The verification dialog showing the TXT record name and value to publish in DNS" className="imagewrapper-big"/> | ||
| </p> | ||
|
|
||
| Add the record, then click **Start Verification**. NetBird keeps checking on its own, so you can leave the page. The domain becomes **Verified** once the record is found. If it never appears the domain ends up **Unverified**, and **Verify** starts the checks again. | ||
|
|
||
| If you cannot change DNS, contact [NetBird Support](/help/netbird-support) from an email address on the domain instead, and the team will verify it for you. | ||
|
|
||
| <Note> | ||
| A domain can only be verified by one account. If another account already holds it, your checks keep failing — contact [NetBird Support](/help/netbird-support). | ||
| </Note> | ||
|
|
||
| Once the domain is Verified, a user signing in for the first time with an address on it joins your account. | ||
|
|
||
| <p> | ||
| <img src="/docs-static/img/manage/team/sign-in-domains/login.png" | ||
| alt="The NetBird login page, where a user signing in with an email address on a verified domain joins the existing account" className="imagewrapper-big"/> | ||
| </p> | ||
|
|
||
| ## Remove Domain | ||
|
|
||
| Click the delete icon on the domain's row. The domain you signed up with cannot be removed, and neither can a domain an SSO integration still uses. | ||
|
|
||
| Removing a domain does not remove or lock out users who already joined through it. It only stops matching new sign-ins, who get accounts of their own again. | ||
|
|
||
| ## Recap | ||
|
|
||
| - A sign-in domain tells NetBird that an email domain belongs to your account, so new users join your network instead of creating one of their own. | ||
| - Your signup domain is there from the start and cannot be removed; add and verify any others yourself. | ||
| - Verification is a TXT record at the root of the domain, re-checked automatically until it is found. | ||
| - It changes where new users land, not where existing ones already are. | ||
|
|
||
| ## Related Docs | ||
|
|
||
| - [Authenticate to NetBird with Single Sign-On](/manage/team/single-sign-on) | ||
| - [Add users to your network](/manage/team/add-users-to-your-network) | ||
| - [User roles](/manage/team/user-roles) | ||
| - [Approve users](/manage/team/approve-users) | ||
| - [Provision users and groups from your IdP](/manage/team/idp-sync) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.