You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/start.md
+40-23Lines changed: 40 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,47 +2,64 @@
2
2
3
3
This tutorial guides you through installing `repo2docker` and building your first environment image.
4
4
5
-
(install)=
5
+
## Prerequisite
6
6
7
-
##Install `repo2docker`
7
+
### Python
8
8
9
-
`repo2docker` requires Python 3.6 or above on Linux and macOS.
9
+
`repo2docker` requires Python 3.6 or above.
10
10
11
-
:::{admonition} Windows support is experimental
11
+
### Container Engine
12
12
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/).
16
14
17
-
###Prerequisite: Install Docker
15
+
####Docker
18
16
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
+
```
21
20
22
-
Recent versions of Docker are recommended.
21
+
Follow [Docker's official installation steps](https://docs.docker.com/get-started/get-docker/).
23
22
24
-
###Install `repo2docker` with `pip`
23
+
#### Podman
25
24
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).
29
26
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).
31
28
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
33
38
python3 -m pip install jupyter-repo2docker
34
39
```
35
40
36
41
(usage)=
37
42
38
43
## Build a repository with `repo2docker`
39
44
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.
42
51
43
-
###Start Docker
52
+
####Docker
44
53
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/).
You'll see `repo2docker` take the following actions:
56
73
57
74
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.
59
76
3. Run the image to let you explore the repository interactively.
60
77
61
78
Click the link provided and you'll be taken to an interactive Jupyter Notebook interface where you can run commands interactively inside the environment.
62
79
63
80
## Learn more
64
81
65
82
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