From 450ac77e6a3beb757e5af864f88db2d33cd178da Mon Sep 17 00:00:00 2001 From: Oliver Eyton-Williams Date: Fri, 6 Dec 2019 14:35:13 +0100 Subject: [PATCH] docs: Docker Toolbox for Windows 10 Home (#37873) --- docs/how-to-setup-freecodecamp-locally.md | 1 + docs/how-to-use-docker-on-windows-home.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 docs/how-to-use-docker-on-windows-home.md diff --git a/docs/how-to-setup-freecodecamp-locally.md b/docs/how-to-setup-freecodecamp-locally.md index c61b299158..c2c1e5d3cb 100644 --- a/docs/how-to-setup-freecodecamp-locally.md +++ b/docs/how-to-setup-freecodecamp-locally.md @@ -134,6 +134,7 @@ Software required for both Docker and Local builds: | ------------ | ------- | ----- | | [Docker CE](https://docs.docker.com/install/) | `Stable` | - | | [Docker Compose](https://docs.docker.com/compose/install/) | `Stable` | Must be installed separately if not using macOS or Windows | +| [Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/) | `v19.03.1` | If using Windows 10 Home, use this instead - instructions [here](/docs/how-to-use-docker-on-windows-home.md) **Local Build additional prerequisite:** diff --git a/docs/how-to-use-docker-on-windows-home.md b/docs/how-to-use-docker-on-windows-home.md new file mode 100644 index 0000000000..67510ae76b --- /dev/null +++ b/docs/how-to-use-docker-on-windows-home.md @@ -0,0 +1,20 @@ + +| [Read these guidelines in other languages](/docs/i18n-languages) | +|-| + + +# How to use Docker on Windows Home + +There are a few pitfalls to be avoided when setting up docker on Windows Home. First of all you have to use [Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/) as Administrator. Unfortunately Windows Home does not support Docker for Windows Desktop, so Toolbox must be used instead. It has to be run as Administrator as the installation uses symlinks, which cannot be created otherwise. + +Once you've installed the toolbox, run Docker Quickstart Terminal as Administrator. This will create a `default` virtual machine, if it does not already exist. Once that has happened, close the terminal and open VirtualBox (again as Administrator). You should be able to see the `default` machine. The site is quite resource intensive, so stop the virtual machine and raise the settings as much as you can - memory in particular. It has been confirmed to work with 4GB of ram. + +Once you're happy that Docker is working, clone the freeCodeCamp repository to a directory inside `C:\Users`. These directories are shared giving Docker access to the local directories, which it needs during installation. + +If you see messages like + +```shell +bash: change_volumes_owner.sh: No such file or directory +``` + +when you `npm run docker:init` this is likely the culprit.