Skip to content

Commit 784c039

Browse files
committed
Update docs
1 parent 51439ef commit 784c039

8 files changed

Lines changed: 13 additions & 47 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ The following environment variables can be used to configure Livebook on boot:
244244

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

250250
* `basic_auth:<username>:<password>`

docs/authentication.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
Livebook has three levels of authentication:
44

5-
* **Instance authentication**: this authenticates the user on all routes of your Livebook instance, including deployed notebooks and the admin section. We provide a variety of authentication options here, including Single Sign On (SSO) and domain-based authentication via [Livebook Teams](https://livebook.dev/teams), as well as Zero Trust Authentication for airgapped environments. See the "Instance authentication" section for more information.
5+
* **Instance authentication**: this authenticates the user on all routes of your Livebook instance, including deployed notebooks and the admin section. See the "Instance authentication" section for more information.
66

77
* **Admin authentication**: this authenticates access to Livebook admin interface within an instance, where users can create, write, and manage notebooks. Both password and token authentication are available. See the ["Admin authentication"](#admin-authentication) section for more information.
88

99
* **Deployed notebook passwords**: additionally, when deploying notebooks as applications, each application may be password protected with a unique password. Only users authenticated as admin or with the password will be able to access them.
1010

1111
## Instance authentication
1212

13-
When using [Livebook Teams](https://livebook.dev/teams), you can easily deploy instances of Livebook to run as application servers or as development servers. Those instances will, by default, use Livebook Teams to authenticate. The following authentication methods are supported by Livebook Teams:
13+
You can configure Livebook with different instance authentication mechanisms by setting the `LIVEBOOK_IDENTITY_PROVIDER` provider environment variable. The supported values are:
1414

15-
* **Livebook Teams account**: allow members of your Livebook Teams organization to authenticate using their Livebook Teams accounts.
15+
* `basic_auth:<username>:<password>`
16+
* `cloudflare:<your-team-name (domain)>`
17+
* `google_iap:<your-audience (aud)>`
18+
* `tailscale:<tailscale-cli-socket-path>`
19+
* `custom:YourElixirModule`
1620

17-
* **Email domain**: allow users to authenticate using email accounts from specific domains, such as your company’s Google Workspace domain.
18-
19-
* **[OpenID Connect Single Sign-On (SSO)](/oidc_sso.html)**: Allow users to authenticate via an OpenID Connect Single Sign-On provider, such as Okta, Microsoft Entra or Keycloak.
20-
21-
If your application servers must run in an airgapped environments and cannot reach out to Livebook Teams servers, we also provide a variety of options that can be configured directly in your Dockerfiles. See the "Airgapped Authentication" section in the sidebar.
21+
See the "Zero Trust Authentication" section in the sidebar.
2222

2323
## Admin authentication
2424

docs/authentication/basic_auth.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,3 @@ Setting up Basic Authentication is a simple mechanism for protecting all routes
55
## How to
66

77
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.
8-
9-
## Livebook Teams
10-
11-
[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.
12-
13-
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).
14-
15-
To get started, open up Livebook, click "Add Organization" on the sidebar. Then, inside the notebook of your choice, click "Deploy with Livebook Teams".

docs/authentication/cloudflare.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,3 @@ https://developers.cloudflare.com/cloudflare-one/glossary/#team-name.
1414

1515
For more information about Cloudflare Zero Trust, see:
1616
https://developers.cloudflare.com/cloudflare-one/.
17-
18-
## Livebook Teams
19-
20-
[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.
21-
22-
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).
23-
24-
To get started, open up Livebook, click "Add Organization" on the sidebar. Then, inside the notebook of your choice, click "Deploy with Livebook Teams".

docs/authentication/google_iap.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,3 @@ For more information about Google IAP, see https://cloud.google.com/iap/docs/con
1414
Only access with Google accounts is supported. See https://cloud.google.com/iap/docs/authenticate-users-google-accounts.
1515

1616
For more details about how to find your JWT audience, see https://cloud.google.com/iap/docs/signed-headers-howto and look for "Signed Header JWT Audience."
17-
18-
## Livebook Teams
19-
20-
[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.
21-
22-
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).
23-
24-
To get started, open up Livebook, click "Add Organization" on the sidebar. Then, inside the notebook of your choice, click "Deploy with Livebook Teams".

docs/authentication/tailscale.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,3 @@ else
5757
[ -z "$tailscale_ip" ] && echo "- Could not determine Tailscale IP"
5858
fi
5959
```
60-
61-
## Livebook Teams
62-
63-
[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.
64-
65-
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).
66-
67-
To get started, open up Livebook, click "Add Organization" on the sidebar. Then, inside the notebook of your choice, click "Deploy with Livebook Teams".

docs/deployment/docker.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,10 @@ data:
139139
140140
The setup above does not set up a data directory, which means once you restart the instance, any configuration will be lost. If you have a persistent volume, you can point the `LIVEBOOK_DATA_PATH` environment variable to it.
141141

142+
You may also want to configure [both instance and admin authentication](authentication.md).
143+
142144
## Deploy notebooks as applications
143145

144146
It is possible to deploy any notebook as an application in Livebook. To do so, choose a notebook, open up the Application pane on the sidebar (with a rocket icon), click "Manual Docker deployment", and follow the required steps for your desired platform.
145147

146-
If you are using [Livebook Teams](https://livebook.dev/teams/), you can also deploy with the click of a button by running Livebook servers inside your infrastructure. To get started, open up Livebook and click "Add Organization" on the sidebar. Once completed, open up the Application pane on the sidebar (with a rocket icon), click "Deploy with Livebook Teams", and follow the deployment steps.
147-
148-
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.
149-
150-
Livebook Teams also support airgapped deployments, pre-configured environment variables, shared team secrets, file storages, and more.
148+
When deploying notebooks as applications, you may also want to configure [both instance and admin authentication](authentication.md).

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ defmodule Livebook.MixProject do
274274
groups_for_extras: [
275275
"Livebook Teams": Path.wildcard("docs/teams/*"),
276276
Deployment: Path.wildcard("docs/deployment/*"),
277-
"Airgapped Authentication": Path.wildcard("docs/authentication/*")
277+
"Zero Trust Authentication": Path.wildcard("docs/authentication/*")
278278
]
279279
]
280280
end

0 commit comments

Comments
 (0)