livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-02-21 05:19:42 +08:00
Code Issues Projects Releases Packages Wiki Activity

Add backticks to improve env var readability

Browse source
This commit is contained in:
José Valim 2023-10-24 23:50:29 +02:00
parent ee7866ffba
commit ccacabab2d
1 changed files with 45 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
README.md
View file

@ -164,73 +164,73 @@ Livebook if said token is supplied as part of the URL.
The following environment variables can be used to configure Livebook on boot:
* LIVEBOOK_ALLOW_URI_SCHEMES - sets additional allowed hyperlink schemes to the
* `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.
* LIVEBOOK_APP_SERVICE_URL - sets the application url to manage this
* `LIVEBOOK_APP_SERVICE_URL` - sets the application url to manage this
Livebook instance within the cloud provider platform.
* LIVEBOOK_APPS_PATH - the directory with app notebooks. When set, the apps
* `LIVEBOOK_APPS_PATH` - the directory with app notebooks. When set, the apps
are deployed on Livebook startup with the persisted settings. Password-protected
notebooks will receive a random password, unless LIVEBOOK_APPS_PATH_PASSWORD
notebooks will receive a random password, unless `LIVEBOOK_APPS_PATH_PASSWORD`
is set. When deploying using Livebook's Docker image, consider using
LIVEBOOK_APPS_PATH_WARMUP.
`LIVEBOOK_APPS_PATH_WARMUP`.
* LIVEBOOK_APPS_PATH_HUB_ID - deploy only the notebooks in
LIVEBOOK_APPS_PATH that belong to the given Hub ID
* `LIVEBOOK_APPS_PATH_HUB_ID` - deploy only the notebooks in
`LIVEBOOK_APPS_PATH` that belong to the given Hub ID
* LIVEBOOK_APPS_PATH_PASSWORD - the password to use for all protected apps
deployed from LIVEBOOK_APPS_PATH.
* `LIVEBOOK_APPS_PATH_PASSWORD` - the password to use for all protected apps
deployed from `LIVEBOOK_APPS_PATH`.
* LIVEBOOK_APPS_PATH_WARMUP - sets the warmup mode for apps deployed from
LIVEBOOK_APPS_PATH. Must be either "auto" (apps are warmed up on Livebook
* `LIVEBOOK_APPS_PATH_WARMUP` - sets the warmup mode for apps deployed from
`LIVEBOOK_APPS_PATH`. Must be either "auto" (apps are warmed up on Livebook
startup, right before app deployment) or "manual" (apps are warmed up when
building the Docker image; to do so add "RUN /app/bin/warmup_apps.sh" to
your image). Defaults to "auto".
* LIVEBOOK_BASE_URL_PATH - sets the base url path the web application is
* `LIVEBOOK_BASE_URL_PATH` - sets the base url path the web application is
served on. Useful when deploying behind a reverse proxy.
* LIVEBOOK_CACERTFILE - path to a local file containing CA certificates.
* `LIVEBOOK_CACERTFILE` - path to a local file containing CA certificates.
Those certificates are used during for server authentication when Livebook
accesses files from external sources.
* LIVEBOOK_CLUSTER - configures clustering strategy when running multiple
* `LIVEBOOK_CLUSTER` - configures clustering strategy when running multiple
instances of Livebook. See the "Clustering" section of our Docker Deployment
guide for more information: https://hexdocs.pm/livebook/docker.html
* LIVEBOOK_COOKIE - sets the cookie for running Livebook in a cluster.
* `LIVEBOOK_COOKIE` - sets the cookie for running Livebook in a cluster.
Defaults to a random string that is generated on boot.
* LIVEBOOK_DATA_PATH - the directory to store Livebook's internal
* `LIVEBOOK_DATA_PATH` - the directory to store Livebook's internal
configuration. Defaults to "livebook" under the default user data
directory.
* LIVEBOOK_DEBUG - enables verbose logging, when set to "true". Disabled
* `LIVEBOOK_DEBUG` - enables verbose logging, when set to "true". Disabled
by default.
* LIVEBOOK_DEFAULT_RUNTIME - sets the runtime type that is used by default
* `LIVEBOOK_DEFAULT_RUNTIME` - sets the runtime type that is used by default
when none is started explicitly for the given notebook. Must be either
"standalone" (Elixir standalone), "attached:NODE:COOKIE" (Attached node)
or "embedded" (Embedded). Defaults to "standalone".
* LIVEBOOK_DISTRIBUTION - sets the node distribution for running Livebook in a
* `LIVEBOOK_DISTRIBUTION` - sets the node distribution for running Livebook in a
cluster. Must be "name" (long names) or "sname" (short names). Note that this
sets RELEASE_DISTRIBUTION if present when creating a release. Defaults to "sname".
* LIVEBOOK_FORCE_SSL_HOST - sets a host to redirect to if the request is not over HTTPS.
* `LIVEBOOK_FORCE_SSL_HOST` - sets a host to redirect to if the request is not over HTTPS.
Note it does not apply when accessing Livebook via localhost. Defaults to nil.
* LIVEBOOK_HOME - sets the home path for the Livebook instance. This is the
* `LIVEBOOK_HOME` - sets the home path for the Livebook instance. This is the
default path used on file selection screens and others. Defaults to the
user's operating system home.
* LIVEBOOK_IDENTITY_PROVIDER - controls whether Zero Trust Authentication
* `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:
@ -238,56 +238,56 @@ The following environment variables can be used to configure Livebook on boot:
* "cloudflare:<your-team-name (domain)>"
* "google_iap:<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.
* LIVEBOOK_IFRAME_URL - sets the URL that Livebook loads iframes from.
By default iframes are loaded from local LIVEBOOK_IFRAME_PORT when accessing
* `LIVEBOOK_IFRAME_URL` - sets the URL that Livebook loads iframes from.
By default iframes are loaded from local `LIVEBOOK_IFRAME_PORT` when accessing
Livebook over http:// and from https://livebookusercontent.com when accessing over https://.
* LIVEBOOK_IP - sets the ip address to start the web application on.
* `LIVEBOOK_IP` - sets the ip address to start the web application on.
Must be a valid IPv4 or IPv6 address.
* LIVEBOOK_NODE - sets the node name for running Livebook in a cluster. Note that
* `LIVEBOOK_NODE` - sets the node name for running Livebook in a cluster. Note that
this sets RELEASE_NODE if present when creating a release.
* LIVEBOOK_PASSWORD - sets a password that must be used to access Livebook.
* `LIVEBOOK_PASSWORD` - sets a password that must be used to access Livebook.
Must be at least 12 characters. Defaults to token authentication.
* LIVEBOOK_PORT - sets the port Livebook runs on. If you want to run multiple
* `LIVEBOOK_PORT` - sets the port Livebook runs on. If you want to run multiple
instances on the same domain with the same credentials but on different ports,
you also need to set LIVEBOOK_SECRET_KEY_BASE. Defaults to 8080. If set to 0,
you also need to set `LIVEBOOK_SECRET_KEY_BASE`. Defaults to 8080. If set to 0,
a random port will be picked.
* LIVEBOOK_SECRET_KEY_BASE - sets a secret key that is used to sign and encrypt
* `LIVEBOOK_SECRET_KEY_BASE` - sets a secret key that is used to sign and encrypt
the session and other payloads used by Livebook. Must be at least 64 characters
long and it can be generated by commands such as: `openssl rand -base64 48`.
Defaults to a random secret on every boot.
* LIVEBOOK_SHUTDOWN_ENABLED - controls if a shutdown button should be shown
* `LIVEBOOK_SHUTDOWN_ENABLED` - controls if a shutdown button should be shown
in the homepage. Set it to "true" to enable it.
* LIVEBOOK_TEAMS_KEY - sets the secret Livebook Teams key for creating an offline hub.
Must be set together with LIVEBOOK_TEAMS_NAME and LIVEBOOK_TEAMS_OFFLINE_KEY.
* `LIVEBOOK_TEAMS_KEY` - sets the secret Livebook Teams key for creating an offline hub.
Must be set together with `LIVEBOOK_TEAMS_NAME` and `LIVEBOOK_TEAMS_OFFLINE_KEY`.
* LIVEBOOK_TEAMS_NAME - sets the Livebook Teams name for creating an offline hub.
Must be set together with LIVEBOOK_TEAMS_KEY and LIVEBOOK_TEAMS_OFFLINE_KEY.
* `LIVEBOOK_TEAMS_NAME` - sets the Livebook Teams name for creating an offline hub.
Must be set together with `LIVEBOOK_TEAMS_KEY` and `LIVEBOOK_TEAMS_OFFLINE_KEY`.
* LIVEBOOK_TEAMS_OFFLINE_KEY - sets the Livebook Teams public key for creating an offline hub.
Must be set together with LIVEBOOK_TEAMS_NAME and LIVEBOOK_TEAMS_KEY.
* `LIVEBOOK_TEAMS_OFFLINE_KEY` - sets the Livebook Teams public key for creating an offline hub.
Must be set together with `LIVEBOOK_TEAMS_NAME` and `LIVEBOOK_TEAMS_KEY`.
* LIVEBOOK_TEAMS_SECRETS - sets the Livebook Teams encrypted secrets for deploying apps with secrets.
* `LIVEBOOK_TEAMS_SECRETS` - sets the Livebook Teams encrypted secrets for deploying apps with secrets.
This is relevant when deploying airgapped apps. Must be set together with
LIVEBOOK_TEAMS_NAME, LIVEBOOK_TEAMS_KEY, and LIVEBOOK_TEAMS_OFFLINE_KEY.
`LIVEBOOK_TEAMS_NAME`, `LIVEBOOK_TEAMS_KEY`, and `LIVEBOOK_TEAMS_OFFLINE_KEY`.
* LIVEBOOK_TOKEN_ENABLED - controls whether token authentication is enabled.
Enabled by default unless LIVEBOOK_PASSWORD is set. Set it to "false" to
* `LIVEBOOK_TOKEN_ENABLED` - controls whether token authentication is enabled.
Enabled by default unless `LIVEBOOK_PASSWORD` is set. Set it to "false" to
disable it.
* LIVEBOOK_UPDATE_INSTRUCTIONS_URL - sets the URL to direct the user to for
* `LIVEBOOK_UPDATE_INSTRUCTIONS_URL` - sets the URL to direct the user to for
updating Livebook when a new version becomes available.
* LIVEBOOK_WITHIN_IFRAME - controls if the application is running inside an
* `LIVEBOOK_WITHIN_IFRAME` - controls if the application is running inside an
iframe. Set it to "true" to enable it. If you do enable it, then the application
must run with HTTPS.