Skip to content

Commit

Permalink
Update docs around authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
josevalim committed Nov 8, 2024
1 parent dd29be2 commit 7de7378
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 19 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ The following environment variables can be used to configure Livebook on boot:
user's operating system home.

* `LIVEBOOK_IDENTITY_PROVIDER` - controls whether Zero Trust Authentication
must be used as the identity provider. This is useful when deploying
Livebook inside a cloud platform, such as Cloudflare and Google.
must be used for this Livebook instance. This is useful when deploying
Livebook airgapped inside a cloud platform, such as Cloudflare and Google.
Supported values are:

* `basic_auth:<username>:<password>`
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Livebook has three levels of authentication:

* Instance authentication: this authenticates the user on all routes of your Livebook instance, including deployed notebooks and the admin section. This is done via Zero Trust Authentication and typically used when deploying Livebook to production. See the "Authentication" section on the sidebar for more information.
* Instance authentication: this authenticates the user on all routes of your Livebook instance, including deployed notebooks and the admin section. If you are deploying your Livebook instances with [Livebook Teams](https://livebook.dev/teams), all instances include Livebook Teams authentication by default. You can also manually configure your Livebook instance to have their own authentication, see the "Airgapped Authentication" section.

* Admin authentication: this authenticates access to Livebook admin interface, where users can create, write, and manage notebooks. Both password and token authentication are available. See the next section for more information.

Expand Down
11 changes: 2 additions & 9 deletions docs/authentication/basic_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,11 @@ Setting up Basic Authentication is a simple mechanism for protecting all routes

## How to

To integrate Basic Authentication with Livebook, set the `LIVEBOOK_IDENTITY_PROVIDER` environment variable to `basic_auth:<username>:<password>`.

To do it, run:

```bash
LIVEBOOK_IDENTITY_PROVIDER=basic_auth:user:pass \
livebook server
```
To integrate Basic Authentication with Livebook, set the `LIVEBOOK_IDENTITY_PROVIDER` environment variable to `basic_auth:<username>:<password>`, and then deploy or directly run your Livebook instance.

## Livebook Teams

[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with pre-configured Zero Trust Authentication, shared team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.
[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with built-in authentication via Livebook Teams. You can also pre-configure environment variables (such as `LIVEBOOK_IDENTITY_PROVIDER`), share team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.

Furthermore, if you are deploying multi-session apps via [Livebook Teams](https://livebook.dev/teams/), you can programmatically access data from the authenticated user by calling [`Kino.Workspace.app_info/0`](https://hexdocs.pm/kino/Kino.Workspace.html#app_info/0).

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ https://developers.cloudflare.com/cloudflare-one/.

## Livebook Teams

[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with pre-configured Zero Trust Authentication, shared team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.
[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with built-in authentication via Livebook Teams. You can also pre-configure environment variables (such as `LIVEBOOK_IDENTITY_PROVIDER`), share team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.

Furthermore, if you are deploying multi-session apps via [Livebook Teams](https://livebook.dev/teams/), you can programmatically access data from the authenticated user by calling [`Kino.Workspace.app_info/0`](https://hexdocs.pm/kino/Kino.Workspace.html#app_info/0).

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/google_iap.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For more details about how to find your JWT audience, see https://cloud.google.c

## Livebook Teams

[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with pre-configured Zero Trust Authentication, shared team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.
[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with built-in authentication via Livebook Teams. You can also pre-configure environment variables (such as `LIVEBOOK_IDENTITY_PROVIDER`), share team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.

Furthermore, if you are deploying multi-session apps via [Livebook Teams](https://livebook.dev/teams/), you can programmatically access data from the authenticated user by calling [`Kino.Workspace.app_info/0`](https://hexdocs.pm/kino/Kino.Workspace.html#app_info/0).

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/tailscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ livebook server

## Livebook Teams

[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with pre-configured Zero Trust Authentication, shared team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.
[Livebook Teams](https://livebook.dev/teams/) users can deploy notebooks with the click of a button with built-in authentication via Livebook Teams. You can also pre-configure environment variables (such as `LIVEBOOK_IDENTITY_PROVIDER`), share team secrets, and file storages. Both online and airgapped deployment mechanisms are supported.

Furthermore, if you are deploying multi-session apps via [Livebook Teams](https://livebook.dev/teams/), you can programmatically access data from the authenticated user by calling [`Kino.Workspace.app_info/0`](https://hexdocs.pm/kino/Kino.Workspace.html#app_info/0).

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You may set `LIVEBOOK_CLUSTER` to one of the following values.

### `auto`

Detects the hosting platform and automatically sets up a cluster using DNS configuration. Currently the only supported platform is Fly.io.
Detects the hosting platform and automatically sets up a cluster using DNS configuration. Currently the supported platforms are Fly.io and Kubernetes.

### `dns:QUERY`

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,4 @@ If you are using [Livebook Teams](https://livebook.dev/teams/), you can also dep

The deployment steps will show you to deploy your notebooks within Docker, Fly.io, and Kubernetes. This is effectively done by setting the `LIVEBOOK_TEAMS_AUTH`, which configures Livebook to run as a read-only instance connected to Livebook Teams.

Livebook Teams also support airgapped deployments, pre-configured Zero Trust Authentication, shared team secrets, file storages, and more.
Livebook Teams also support airgapped deployments, pre-configured environment variables, shared team secrets, file storages, and more.
3 changes: 1 addition & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ defmodule Livebook.MixProject do
defp remove_cookie(release) do
# We remove the COOKIE file when assembling the release, because we
# don't want to share the same cookie across users.

File.rm!(Path.join(release.path, "releases/COOKIE"))
release
end
Expand Down Expand Up @@ -237,7 +236,7 @@ defmodule Livebook.MixProject do
groups_for_extras: [
"Livebook Teams": Path.wildcard("docs/teams/*"),
Deployment: Path.wildcard("docs/deployment/*"),
Authentication: Path.wildcard("docs/authentication/*")
"Airgapped Authentication": Path.wildcard("docs/authentication/*")
]
]
end
Expand Down

0 comments on commit 7de7378

Please sign in to comment.