livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2024-11-13 03:06:06 +08:00
Code Issues Projects Releases Packages Wiki Activity

Update docs around authentication

Browse source
This commit is contained in:
José Valim 2024-11-08 07:58:57 +01:00
parent dd29be252b
commit 7de7378da6
9 changed files with 11 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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>`

2
docs/authentication.md
View file

@ -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.

11
docs/authentication/basic_auth.md
View file

@ -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).

2
docs/authentication/cloudflare.md
View file

@ -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).

2
docs/authentication/google_iap.md
View file

@ -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).

2
docs/authentication/tailscale.md
View file

@ -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).

2
docs/deployment/clustering.md
View file

@ -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`

2
docs/deployment/docker.md
View file

@ -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
mix.exs
View file

@ -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
@ -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