Skip to content

Commit 2ea0ba9

Browse files
update docs
1 parent 75c731a commit 2ea0ba9

12 files changed

Lines changed: 19 additions & 18 deletions

docs/docs/configuration/auth/access-settings.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ By default, Sourcebot requires new members to be approved by an owner of the dep
1111
to configure this behavior.
1212

1313
### Configuration
14-
Member approval can be configured by an owner of the deployment by navigating to **Settings -> Access**, or by setting the `REQUIRE_APPROVAL_NEW_MEMBERS` environment variable. When the environment variable is set, the UI toggle is disabled and the setting is controlled by the environment variable.
14+
Member approval can be configured by an owner of the deployment by navigating to **Settings -> Security**.
1515

16-
![Member Approval Toggle](/images/member_approval_toggle.png)
16+
<Frame>
17+
<img src="/images/member_approval_toggle.png" alt="Require approval for new members toggle in Settings → Access" />
18+
</Frame>
1719

1820
### Managing Requests
1921

@@ -27,7 +29,9 @@ Owners can see and manage all pending join requests by navigating to **Settings
2729
If member approval is required, an owner of the deployment can enable an invite link. When enabled, users
2830
can use this invite link to register and be automatically added to the organization without approval:
2931

30-
![Invite Link Toggle](/images/invite_link_toggle.png)
32+
<Frame>
33+
<img src="/images/invite_link_toggle.png" alt="Enable invite links toggle in Settings → Access" />
34+
</Frame>
3135

3236

3337
# Anonymous access
@@ -36,6 +40,10 @@ can use this invite link to register and be automatically added to the organizat
3640

3741
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.
3842

39-
This can be enabled by navigating to **Settings -> Access** or by setting the `FORCE_ENABLE_ANONYMOUS_ACCESS` environment variable.
43+
This can be enabled by navigating to **Settings -> Access**.
44+
45+
<Frame>
46+
<img src="/images/anonymous_access_toggle.png" alt="Enable anonymous access toggle in Settings → Access" />
47+
</Frame>
4048

4149
When accessing Sourcebot anonymously, a user's permissions are limited to that of the [Guest](/docs/configuration/auth/roles-and-permissions) role.

docs/docs/configuration/auth/providers.mdx

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,18 @@ If there's an authentication provider you'd like us to support, please [reach ou
1010
# Core Authentication Providers
1111

1212
### Email / Password
13-
---
1413
Email / password authentication is enabled by default. You can toggle it from **Settings → Security** using the **Email login** setting.
1514

16-
The `AUTH_CREDENTIALS_LOGIN_ENABLED` environment variable is deprecated. It still works, but when it is set it overrides the UI setting and locks the toggle. Leave it unset to manage email login from the UI.
17-
18-
Email login can't be disabled when no other login method is configured (no SSO identity provider and no email-code login), since that would leave no way to sign in.
15+
<Frame>
16+
<img src="/images/email_password_login_setting.png" alt="Email & password login setting toggle in Settings → Security" />
17+
</Frame>
1918

2019
### Email codes
21-
---
22-
Email codes are 6 digit codes sent to a provided email. Email codes are enabled when transactional emails are configured using the following environment variables:
23-
24-
- `AUTH_EMAIL_CODE_LOGIN_ENABLED`
25-
- `SMTP_CONNECTION_URL`
26-
- `EMAIL_FROM_ADDRESS`
27-
20+
Email codes are 6 digit codes sent to a provided email. Email codes are enabled when [transactional emails](/docs/configuration/transactional-emails) and the **Email code** setting is toggled from **Settings → Security**:
2821

29-
See [transactional emails](/docs/configuration/transactional-emails) for more details.
22+
<Frame>
23+
<img src="/images/email_code_login_setting.png" alt="Email code login setting toggle in Settings → Security" />
24+
</Frame>
3025

3126
# Enterprise Authentication Providers
3227

docs/docs/configuration/environment-variables.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ The following environment variables allow you to configure your Sourcebot deploy
1010

1111
| Variable | Default | Description |
1212
| :------- | :------ | :---------- |
13-
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/auth/authentication) for more info </p> |
1413
| `AUTH_SECRET` **(required)** | - | <p>Used to validate login session cookies. Genearte one with `openssl rand -base64 33`.</p> |
1514
| `AUTH_SESSION_MAX_AGE_SECONDS` | `2592000` (30 days) | <p>Relative time from now in seconds when to expire the session.</p> |
1615
| `AUTH_SESSION_UPDATE_AGE_SECONDS` | `86400` (1 day) | <p>How often the session should be updated in seconds. If set to `0`, session is updated every time.</p> |
@@ -23,7 +22,6 @@ The following environment variables allow you to configure your Sourcebot deploy
2322
| `DATA_DIR` | `/data` | <p>The directory within the container to store all persistent data. Typically, this directory will be volume mapped such that data is persisted across container restarts (e.g., `docker run -v $(pwd):/data`)</p> |
2423
| `DATABASE_URL` **(required)** | - | <p>Connection string of your Postgres database, e.g. `postgresql://user:password@host:5432/sourcebot`.</p><p>If you'd like to use a non-default schema, you can provide it as a parameter in the database url.</p><p>You can also use `DATABASE_HOST`, `DATABASE_USERNAME`, `DATABASE_PASSWORD`, `DATABASE_NAME`, and `DATABASE_ARGS` to construct the database url.</p> |
2524
| `EMAIL_FROM_ADDRESS` | `-` | <p>The email address that transactional emails will be sent from. See [this doc](/docs/configuration/transactional-emails) for more info.</p> |
26-
| `REQUIRE_APPROVAL_NEW_MEMBERS` | - | <p>When set, controls whether new users require approval before accessing your deployment. If not set, the setting can be configured via the UI. See [member approval](/docs/configuration/auth/access-settings#member-approval) for more info.</p>
2725
| `REDIS_URL` **(required)** | - | <p>Connection string of your Redis instance, e.g. `redis://host:6379`.</p><p>To enable TLS, see [this doc](/docs/deployment/infrastructure/redis#tls).</p> |
2826
| `REDIS_REMOVE_ON_COMPLETE` | `0` | <p>Controls how many completed jobs are allowed to remain in Redis queues</p> |
2927
| `REDIS_REMOVE_ON_FAIL` | `100` | <p>Controls how many failed jobs are allowed to remain in Redis queues</p> |
32.3 KB
Loading

docs/images/demote_to_member.png

-9.85 KB
Loading
28.4 KB
Loading
29.7 KB
Loading

docs/images/invite_link_toggle.png

-113 KB
Loading

docs/images/managing_owners.png

-98.9 KB
Loading
-210 KB
Loading

0 commit comments

Comments
 (0)