Skip to content

add additional notes for Windows installations #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 23, 2024
Merged

add additional notes for Windows installations #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions web/docs/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ In our texts we will use `docker-compose`. Depending on your installation you ma
to replace the hyphen (`-`) with a space. But you can always install the original
compose (`docker-compose`) via `pip install docker-compose`.

For many platforms a product called `Docker Desktop` is available, which includes `Docker Compose`:
For many platforms a product called [Docker Desktop](https://docs.docker.com/desktop) is available, which includes the main Docker components:

* Windows [installation](https://docs.Docker.com/desktop/install/windows-install)
* Mac [installation](https://docs.Docker.com/desktop/install/mac-install)
* Linux [installation](https://docs.Docker.com/desktop/install/linux-install)

Some notes:

* On Windows we recommend using the [Windows Subsystem for Linux v2](https://docs.microsoft.com/en-us/windows/wsl) (WSL2) as it also provides a powerful (Bash) command line and has optimal integration with Docker
* On Windows we recommend using the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl) (WSL) as it also provides a powerful (Bash) command line and has optimal integration with Docker. Before installing Docker Desktop, install WSL by opening Microsoft PowerShell (run as administrator) and running `wsl --install`
* **installing WSL requires administrator privileges on your system**
* On Mac, if you are using [Homebrew](https://brew.sh), consider (as the author has) using the [brew Docker formula](https://formulae.brew.sh/formula/Docker)
* On Linux, you can choose the relevant installer for your platform. You can also use Virtualbox with a Ubuntu Image or use a cloud VM
* Docker desktop includes a graphical user interface with some interesting options. You can see logs and information about running containers, open their service in a browser or even open a terminal inside the container
Expand Down
2 changes: 1 addition & 1 deletion web/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The core requirement is to have [Docker](https://docker.com) and [Docker Compose
on the system. Once you have Docker and Docker Compose installed you will be
able to install and run the workshop without any other dependencies.

More information on installing Docker can also be found [here](./docker).
More information on installing Docker can also be found [here](./docker.md).

### Optional requirements

Expand Down
Loading