livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-02-24 14:58:35 +08:00
Code Issues Projects Releases Packages Wiki Activity

Reorder README

Browse source
This commit is contained in:
José Valim 2023-06-29 13:35:14 +02:00
parent 29b712917e
commit 8dc28aa567
1 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -158,6 +158,11 @@ Livebook if said token is supplied as part of the URL.
The following environment variables can be used to configure Livebook on boot: The following environment variables can be used to configure Livebook on boot:
* LIVEBOOK_ALLOW_URI_SCHEMES - sets additional allowed hyperlink schemes to the
Markdown content. Livebook sanitizes links in Markdown, allowing only a few
standard schemes by default (such as http and https). Set it to a comma-separated
list of schemes.
* LIVEBOOK_APP_SERVICE_NAME - sets the application name used by the cloud * LIVEBOOK_APP_SERVICE_NAME - sets the application name used by the cloud
provider to aid debugging. provider to aid debugging.
@ -197,6 +202,14 @@ The following environment variables can be used to configure Livebook on boot:
default path used on file selection screens and others. Defaults to the default path used on file selection screens and others. Defaults to the
user's operating system home. 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.
Supported values are:
* "cloudflare:<your-team-name (domain)>"
* "googleiap:<your-audience (aud)>"
* LIVEBOOK_IFRAME_PORT - sets the port that Livebook serves iframes at. * LIVEBOOK_IFRAME_PORT - sets the port that Livebook serves iframes at.
This is relevant only when running Livebook without TLS. Defaults to 8081. This is relevant only when running Livebook without TLS. Defaults to 8081.
@ -237,17 +250,6 @@ The following environment variables can be used to configure Livebook on boot:
iframe. Set it to "true" to enable it. If you do enable it, then the application iframe. Set it to "true" to enable it. If you do enable it, then the application
must run with HTTPS. must run with HTTPS.
* LIVEBOOK_ALLOW_URI_SCHEMES - sets additional allowed hyperlink schemes to the
Markdown content. Livebook sanitizes links in Markdown, allowing only a few
standard schemes by default (such as http and https). Set it to a comma-separated
list of schemes.
* LIVEBOOK_IDENTITY_PROVIDER - controls whether Zero Trust Identity is enabled.
Set it to your provider and the correspondent key to enable it.
Currently supported providers are Cloudflare and GoogleIap.
The respective keys are the team name (domain) for CloudFlare and the audience (aud) for GoogleIAP.
E.g. `"cloudflare:<your-team-name>"`, `"googleiap:<your-audience>`
<!-- Environment variables --> <!-- Environment variables -->
When running Livebook Desktop, Livebook will invoke on boot a file named When running Livebook Desktop, Livebook will invoke on boot a file named