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
+38-19Lines changed: 38 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,43 +2,62 @@
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
+
9
+
`repo2docker` requires Python 3.6 or above.
8
10
9
-
repo2docker requires Python 3.6 or above on Linux and macOS.
11
+
### Container Engine
10
12
11
-
:::{admonition} Windows support is experimental
13
+
`repo2docker` requires a container engine compatible with the specification published by the [Open Container Initiative](https://opencontainers.org/).
12
14
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
-
:::
15
+
#### Docker
16
+
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
+
```
16
20
17
-
### Prerequisite: Install Docker
21
+
Follow [Docker's official installation steps](https://docs.docker.com/get-started/get-docker/).
18
22
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.
23
+
#### Podman
21
24
22
-
Recent versions of Docker are recommended.
25
+
Follow [Podman's official installation steps](https://podman.io/docs/installation).
26
+
27
+
(install)=
28
+
29
+
## Install `repo2docker`
23
30
24
31
### Install `repo2docker` with `pip`
25
32
26
-
We recommend installing`repo2docker` with the `pip` tool:
33
+
It is recommend to install`repo2docker` with the `pip` tool:
27
34
28
-
```
35
+
```bash
29
36
python3 -m pip install jupyter-repo2docker
30
37
```
31
38
32
39
(usage)=
33
40
34
41
## Build a repository with `repo2docker`
35
42
36
-
Now that you've installed Docker and `repo2docker`, we can build a repository.
37
-
To do so, follow these steps.
43
+
Now that you've installed a container engine and `repo2docker`, you can build a repository.
44
+
To do so, continue following this guide.
45
+
46
+
### Start the container engine
47
+
48
+
Ensure that the container engine is running.
49
+
50
+
#### Docker
38
51
39
-
### Start Docker
52
+
Follow the [offcial instructions for starting Docker](https://docs.docker.com/engine/daemon/start/).
40
53
41
-
Follow the [instructions for starting Docker](https://docs.docker.com/engine/daemon/start/) to start a Docker process.
You'll see `repo2docker` take the following actions:
52
71
53
72
1. Inspect the repository for [configuration files](#config-files). It will detect the `requirements.txt` file in the repository.
54
-
2. Build a Docker image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
73
+
2. Build a container image using the configuration files. In this case, the `requirements.txt` file will correspond to a Python environment.
55
74
3. Run the image to let you explore the repository interactively.
56
75
57
76
Click the link provided and you'll be taken to an interactive Jupyter Notebook interface where you can run commands interactively inside the environment.
58
77
59
78
## Learn more
60
79
61
80
This is a simple example building an environment image for your repository.
62
-
To learn more about the kinds of source repositories, environments, and use-cases that repo2docker supports, see [the `repo2docker` user guide](./use/index.md).
81
+
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