Skip to content

Commit 5abadc1

Browse files
msukkarimsukkari
committed
add docs for access settings
1 parent 0d7054b commit 5abadc1

File tree

7 files changed

+40
-44
lines changed

7 files changed

+40
-44
lines changed

‎docs/docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
"pages": [
7474
"docs/configuration/auth/overview",
7575
"docs/configuration/auth/providers",
76-
"docs/configuration/auth/inviting-members",
76+
"docs/configuration/auth/access-settings",
7777
"docs/configuration/auth/roles-and-permissions",
7878
"docs/configuration/auth/faq"
7979
]

docs/docs/configuration/auth/inviting-members.mdx renamed to docs/docs/configuration/auth/access-settings.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
---
2-
title: Inviting Members
3-
sidebarTitle: Inviting members
2+
title: Access Settings
3+
sidebarTitle: Access settings
44
---
55

6-
There are various ways to configure how members can join a Sourcebot deployment.
6+
There are various settings to control how users access your Sourcebot deployment.
77

8-
## Member Approval
8+
# Anonymous access
99

10-
**By default, Sourcebot requires new members to be approved by the owner of the deployment**. This section explains how approvals work and how
10+
<Note>Anonymous access cannot be enabled if you have an enterprise license. If you have any questions about this restriction [reach out to us](https://www.sourcebot.dev/contact).</Note>
11+
12+
By default, your Sourcebot deployment is gated with a login page. If you'd like users to access the deployment anonymously, you can enable anonymous access.
13+
14+
This can be enabled by navigating to **Settings -> Access** or by setting the `forceEnableAnonymousAccess` setting in your configuration file.
15+
16+
# Member Approval
17+
18+
By default, Sourcebot requires new members to be approved by the owner of the deployment. This section explains how approvals work and how
1119
to configure this behavior.
1220

1321
### Configuration

‎docs/docs/deployment-guide.mdx‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,6 @@ import SupportedPlatforms from '/snippets/platform-support.mdx'
77
The following guide will walk you through the steps to deploy Sourcebot on your own infrastructure. Sourcebot is distributed as a [single docker container](/docs/overview#architecture) that can be deployed to a k8s cluster, a VM, or any platform that supports docker.
88

99

10-
## Walkthrough video
11-
---
12-
13-
Watch this quick walkthrough video to learn how to deploy Sourcebot using Docker.
14-
15-
<iframe
16-
src="https://youtube.com/embed/TPQh0z7Qcjg"
17-
title="YouTube video player"
18-
frameborder="0"
19-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
20-
allowfullscreen
21-
className="aspect-video w-full"
22-
></iframe>
23-
24-
## Step-by-step guide
25-
---
26-
2710
<Note>Hit an issue? Please let us know on [GitHub discussions](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support) or by [emailing us](mailto:team@sourcebot.dev).</Note>
2811

2912
<Steps>

‎packages/web/src/app/[domain]/settings/access/page.tsx‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ export default async function AccessPage({ params: { domain } }: AccessPageProps
1717
<div className="flex flex-col gap-6">
1818
<div>
1919
<h3 className="text-lg font-medium">Access Control</h3>
20-
<p className="text-sm text-muted-foreground">Configure how users can access your Sourcebot deployment.</p>
20+
<p className="text-sm text-muted-foreground">Configure how users can access your Sourcebot deployment.{" "}
21+
<a
22+
href="https://docs.sourcebot.dev/docs/configuration/auth/access-settings"
23+
target="_blank"
24+
rel="noopener"
25+
className="underline text-[var(--primary)] hover:text-[var(--primary)]/80 transition-colors"
26+
>
27+
Learn more
28+
</a>
29+
</p>
2130
</div>
2231

2332
<OrganizationAccessSettings />

‎packages/web/src/app/components/anonymousAccessToggle.tsx‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,7 @@ export function AnonymousAccessToggle({ hasAnonymousAccessEntitlement, anonymous
5959
</h3>
6060
<div className="max-w-2xl">
6161
<p className="text-sm text-[var(--muted-foreground)] leading-relaxed">
62-
When enabled, users can access your deployment without logging in.{" "}
63-
<a
64-
href="https://docs.sourcebot.dev/docs/configuration/auth/anonymous-access"
65-
target="_blank"
66-
rel="noopener"
67-
className="underline text-[var(--primary)] hover:text-[var(--primary)]/80 transition-colors"
68-
>
69-
Learn More
70-
</a>
62+
When enabled, users can access your deployment without logging in.
7163
</p>
7264
{showPlanMessage && (
7365
<div className="mt-3 p-3 rounded-md bg-[var(--muted)] border border-[var(--border)]">

‎packages/web/src/app/components/memberApprovalRequiredToggle.tsx‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,7 @@ export function MemberApprovalRequiredToggle({ memberApprovalRequired, onToggleC
5454
</h3>
5555
<div className="max-w-2xl">
5656
<p className="text-sm text-[var(--muted-foreground)] leading-relaxed">
57-
When enabled, new users will need approval from an organization owner before they can access your deployment.{" "}
58-
<a
59-
href="https://docs.sourcebot.dev/docs/configuration/auth/inviting-members"
60-
target="_blank"
61-
rel="noopener"
62-
className="underline text-[var(--primary)] hover:text-[var(--primary)]/80 transition-colors"
63-
>
64-
Learn More
65-
</a>
57+
When enabled, new users will need approval from an organization owner before they can access your deployment.
6658
</p>
6759
</div>
6860
</div>

‎packages/web/src/app/onboard/page.tsx‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,20 @@ export default async function Onboarding({ searchParams }: OnboardingProps) {
158158
},
159159
{
160160
id: "configure-org",
161-
title: "Configure Your Organization",
162-
subtitle: "Set up your organization's security settings.",
161+
title: "Configure Access Settings",
162+
subtitle: (
163+
<>
164+
Set up your organization's access settings.{" "}
165+
<a
166+
href="https://docs.sourcebot.dev/docs/configuration/auth/access-settings"
167+
target="_blank"
168+
rel="noopener"
169+
className="underline text-[var(--primary)] hover:text-[var(--primary)]/80 transition-colors"
170+
>
171+
Learn more
172+
</a>
173+
</>
174+
),
163175
component: (
164176
<div className="space-y-6">
165177
<OrganizationAccessSettings />

0 commit comments

Comments
 (0)