diff --git a/README.md b/README.md index 1e47b0c42514c9d5a31f5ceec947c03dabcdd9ec..26b0e1c7300a3b290bb92ae7d38129bd257dd079 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ # WCMS Docker setup You will need to get Docker (https://www.docker.com/products/docker-desktop) either Docker CE for Windows/Mac or Docker Toolbox for Windows (https://docs.docker.com/toolbox/toolbox_install_windows/) or Mac (https://docs.docker.com/toolbox/toolbox_install_mac/). -If you plan to run VirtualBox and Docker you will need to install the Docker Toolbox, Docker CE requires Hyper-V to be enabled which isn't compatible with VirtualBox. +If you plan to run VirtualBox and Docker you will need to install the Docker Toolbox, Docker CE requires Hyper-V to be enabled which isn't compatible with VirtualBox. We recommend using Docker Desktop. **CAUTION!** This Docker box is meant for local development only. This set up is not hardened and is not secure, so only us it as a local development environment. -If you are using Docker Toolbox, on a Windows machine start Docker Quickstart Terminal. +You will need to create a Docker ID (if you don't already have one) to download the latest Docker Desktop. -From the command line, run: +During setup you will be asked if you want to use Linux or Windows containers, for consistency (between Mac and Windows users) we will choose linux containers. + +**Note** If you have VirtualBox installed you will get a warning: +"Hyper-V and Containers are not enabled. Do you want to enable them for Docker to be able to work properly? Your computer will restart automatically. Note: VirtualBox wil no longer work." + +We want to enable Hyper-V so you can accept this. + +When your computer restarts Docker should also start and will be asking you to log in with your Docker ID. If you don't want to log in, you can choose Privacy settings and the uncheck "send usage statistics..." (You can slo optionally uncheck "start Docker Desktop when you log in" + +**Note** If you had Docker Toolbox installed you should uninstall it and you might need to remove User Environmental Variables. +If this is the case, you need to go to System > System Info > Advanced Settings > Environmental Variables and remove and Docker settings from the User Variables. +Once you've done this you should reboot your machine. + +You should now be ready to clone the repo: -```bash - docker-machine ip -``` -It will return the IP address of the Docker machine, you will need to add the Docker machine IP to your ```host``` file. ```bash git clone https://git.uwaterloo.ca/mnshantz/wcms-docker.git wcms-docker @@ -25,12 +34,14 @@ Go into the directory you cloned Docker into: cd wcms-docker ``` -First we need to build the images,(this takes about 12 minutes or so): +First we need to build the images,(this takes about 12 minutes or so to build): ```bash docker-compose build ``` -Once that's done you can create the containers, running with -d runs them in detached mode: +**Note** The first time you run this, you may be asked to share C: drive and you may need to add a Windows Firewall permission. Click yes/okay for both. + +Once that's done you can create the containers: ```bash docker-compose up -d