diff --git a/README.md b/README.md index d7adb113c..79818e417 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ The following environment variables can be used to configure Livebook on boot: 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 HTTP. + * 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 @@ -264,8 +264,8 @@ The following environment variables can be used to configure Livebook on boot: 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. - This is relevant when deploying apps with offline hub. Must be set together with - LIVEBOOK_TEAMS_NAME, LIVEBOOK_TEAMS_KEY and LIVEBOOK_TEAMS_OFFLINE_KEY. + This is relevant when deploying airgapped apps. Must be set together with + 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 diff --git a/lib/livebook_web/live/hub/edit/team_component.ex b/lib/livebook_web/live/hub/edit/team_component.ex index 474ee64a0..2b3b07c8e 100644 --- a/lib/livebook_web/live/hub/edit/team_component.ex +++ b/lib/livebook_web/live/hub/edit/team_component.ex @@ -198,8 +198,9 @@ defmodule LivebookWeb.Hub.Edit.TeamComponent do
Then save the Dockerfile below in a repository with the Livebook notebooks
that belong to your Organization. You must change
- /path/to/my/notebooks
in the template below to point to a directory
- with all .livemd
files you want to deploy.
+ the value of the APPS_PATH
+ argument in the template below to point to a directory with all .livemd
+ files you want to deploy.
- Finally, you must set the following environment variables in your deployment platform: + You may additionally perform the following optional steps:
LIVEBOOK_TEAMS_KEY
- - set it to the "Livebook Teams key" value you can find at the top of this page
+ you may remove the default value for TEAMS_KEY
+ from your Dockerfile and set it as a build argument in your deployment
+ platform
LIVEBOOK_PASSWORD
- (optional) - set it to any value of your choice, if you want to access and debug
- your deployed notebooks in production
+ if you want to debug your deployed notebooks in production, you may
+ set the LIVEBOOK_PASSWORD
environment variable with a
+ value of at least 12 characters of your choice