Skip to content

Commit 022be3d

Browse files
authored
Revise Docker deployment documentation for clarity
Updated the Docker deployment documentation to clarify use cases for authoring notebooks and deploying applications.
1 parent c39254b commit 022be3d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/deployment/docker.md

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

33
There are two main use cases to deploy Livebook in the cloud. The first is to read and write notebooks in the cloud, instead of your machine. The second is to deploy notebooks as applications.
44

5-
## Livebook in the cloud
5+
## For authoring notebooks
66

7-
You can deploy Livebook inside your infrastructure using Docker. The Dockerfile below provides a great starting point:
7+
The following snippets assume you are deploying Livebook inside your infrastructure to author notebooks. In those cases, Livebook must be single-user, as configuration is stored in disk and shared across all users.
8+
9+
### Docker
10+
11+
The Dockerfile below provides a great starting point:
812

913
```dockerfile
1014
FROM ghcr.io/livebook-dev/livebook
@@ -22,10 +26,6 @@ RUN chmod 777 /data
2226

2327
We also recommend setting the `LIVEBOOK_PASSWORD` environment variable to a secret value. If it is not set, you will find the token to access Livebook in the logs. See all other supported [environment variables](../../README.md#environment-variables) to learn more.
2428

25-
If you want to run several Livebook instances behind a load balancer, you need to enable clustering. See the [Clustering](clustering.md) section.
26-
27-
If you plan to limit access to your Livebook via a proxy, we recommend leaving the "/public" route of your instances still public. This route is used for integration with the [Livebook Badge](https://livebook.dev/badge/) and other conveniences.
28-
2929
### Docker compose
3030

3131
If using Docker Compose the following template is a good starting point:
@@ -77,7 +77,7 @@ kind: Deployment
7777
metadata:
7878
name: livebook
7979
spec:
80-
# When deploying Livebook for authoring notebooks to Kubernetes,
80+
# When deploying Livebook to author notebooks in the cloud,
8181
# the number of replicas must be 1, since Livebook considers you
8282
# will assign one instance per user.
8383
replicas: 1
@@ -141,7 +141,7 @@ The setup above does not set up a data directory, which means once you restart t
141141

142142
## Deploy notebooks as applications
143143

144-
It is possible to deploy any notebook as an application in Livebook. Inside the notebook, open up the Application pane on the sidebar (with a rocket icon), click "Manual Docker deployment", and follow the required steps.
144+
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.
145145

146146
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.
147147

0 commit comments

Comments
 (0)