Skip to content

Commit a0e43fc

Browse files
committed
Use "container" instead of Docker when possible in start.md
and add note about DOCKER_HOST environment variable.
1 parent 5b37d9a commit a0e43fc

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed

docs/source/start.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,64 @@
22

33
This tutorial guides you through installing `repo2docker` and building your first environment image.
44

5-
(install)=
5+
## Prerequisite
66

7-
## Install `repo2docker`
7+
### Python
88

9-
`repo2docker` requires Python 3.6 or above on Linux and macOS.
9+
`repo2docker` requires Python 3.6 or above.
1010

11-
:::{admonition} Windows support is experimental
11+
### Container Engine
1212

13-
This [article about using Windows and the WSL](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly) (Windows Subsystem for Linux or
14-
Bash on Windows) provides additional information about Windows and Docker.
15-
:::
13+
`repo2docker` requires a container engine compatible with the specification published by the [Open Container Initiative](https://opencontainers.org/).
1614

17-
### Prerequisite: Install Docker
15+
#### Docker
1816

19-
Install [Docker](https://www.docker.com), as it is required to build Docker images.
20-
The [Community Edition](https://docs.docker.com/install/) is available for free.
17+
```{important}
18+
Only the [Docker Engine](https://docs.docker.com/engine/) is an open source. [Docker Desktop](https://docs.docker.com/get-started/get-docker/) requires a license.
19+
```
2120

22-
Recent versions of Docker are recommended.
21+
Follow [Docker's official installation steps](https://docs.docker.com/get-started/get-docker/).
2322

24-
### Install `repo2docker` with `pip`
23+
#### Podman
2524

26-
```{warning}
27-
The name of the package on [PyPI](https://pypi.org/) is [`jupyter-repo2docker`](https://pypi.org/project/jupyter-repo2docker/) instead of `repo2docker`.
28-
```
25+
Follow [Podman's official installation steps](https://podman.io/docs/installation).
2926

30-
We recommend installing `repo2docker` with the `pip` tool:
27+
And configure the `DOCKER_HOST` environment variable following [Podman's official procedure](https://podman-desktop.io/docs/migrating-from-docker/using-the-docker_host-environment-variable#procedure).
3128

32-
```
29+
(install)=
30+
31+
## Install `repo2docker`
32+
33+
### Install `repo2docker` with `pip`
34+
35+
It is recommend to install `repo2docker` with the `pip` tool:
36+
37+
```bash
3338
python3 -m pip install jupyter-repo2docker
3439
```
3540

3641
(usage)=
3742

3843
## Build a repository with `repo2docker`
3944

40-
Now that you've installed Docker and `repo2docker`, we can build a repository.
41-
To do so, follow these steps.
45+
Now that you've installed a container engine and `repo2docker`, you can build a repository.
46+
To do so, continue following this guide.
47+
48+
### Start the container engine
49+
50+
Ensure that the container engine is running.
4251

43-
### Start Docker
52+
#### Docker
4453

45-
Follow the [instructions for starting Docker](https://docs.docker.com/engine/daemon/start/) to start a Docker process.
54+
Follow the [offcial instructions for starting Docker](https://docs.docker.com/engine/daemon/start/).
55+
56+
#### Podman
57+
58+
Run
59+
60+
```bash
61+
podman info
62+
```
4663

4764
### Build an image from a URL
4865

@@ -55,12 +72,12 @@ jupyter-repo2docker https://github.com/binder-examples/requirements
5572
You'll see `repo2docker` take the following actions:
5673

5774
1. Inspect the repository for [configuration files](#config-files). It will detect the `requirements.txt` file in the repository.
58-
2. Build a Docker image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
75+
2. Build a container image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
5976
3. Run the image to let you explore the repository interactively.
6077

6178
Click the link provided and you'll be taken to an interactive Jupyter Notebook interface where you can run commands interactively inside the environment.
6279

6380
## Learn more
6481

6582
This is a simple example building an environment image for your repository.
66-
To learn more about the kinds of source repositories, environments, and use-cases that repo2docker supports, see [the `repo2docker` user guide](./use/index.md).
83+
To learn more about the kinds of source repositories, environments, and use-cases that `repo2docker` supports, see [the `repo2docker` user guide](./use/index.md).

0 commit comments

Comments
 (0)