diff --git a/opensource/project/software-req-win.md b/opensource/project/software-req-win.md index 4952f62cbc..391e627e75 100644 --- a/opensource/project/software-req-win.md +++ b/opensource/project/software-req-win.md @@ -1,254 +1,69 @@ --- -description: How to set up a server to test Docker Windows client -keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows -title: Get the required software for Windows +description: How to set up a server to test Docker Engine on Windows +keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows +title: Build and test Docker on Windows --- -This page explains how to get the software you need to use a Windows Server -2012 or Windows 8 machine for Docker development. Before you begin contributing -you must have: +This page explains how to get the software you need to build, test and run the Docker source code for Windows and setup the required software and services: -- a GitHub account -- Git for Windows (msysGit) -- TDM-GCC, a compiler suite for Windows -- MinGW (tar and xz) -- Go language +- Windows containers +- GitHub account +- Git -> **Note**: This installation procedure refers to the `C:\` drive. If you system's main drive -is `D:\` you'll need to substitute that in where appropriate in these -instructions. +## 1. Docker Windows containers -## Task 1. Get a GitHub account +To test and run the Windows Docker daemon, you need a system that supports Windows Containers: -To contribute to the Docker project, you will need a GitHub account. A free account is -fine. All the Docker project repositories are public and visible to everyone. + * Windows 10 Anniversary Edition + * Windows Server 2016 running in a VM, on bare metal or in the cloud -You should also have some experience using both the GitHub application and `git` -on the command line. +Check out the [getting started documentation](https://github.com/docker/labs/blob/master/windows/windows-containers/Setup.md) for details. -## Task 2. Install Git for Windows +## 2. GitHub account -Git for Windows includes several tools including msysGit, which is a build -environment. The environment contains the tools you need for development such as -Git and a Git Bash shell. +To contribute to the Docker project, you need a GitHub account. A free account is fine. All the Docker project repositories are public and visible to everyone. -1. Browse to the [Git for Windows](https://msysgit.github.io/) download page. +This guide assumes that you have basic familiarity with Git and Github terminology and usage. Refer to [GitHub For Beginners: Don’t Get Scared, Get Started](http://readwrite.com/2013/09/30/understanding-github-a-journey-for-beginners-part-1/) to get up to speed on Github. -2. Click **Download**. +## 3. Git - Windows prompts you to save the file to your machine. +In PowerShell, run: -3. Run the saved file. + Invoke-Webrequest "https://github.com/git-for-windows/git/releases/download/v2.7.2.windows.1/Git-2.7.2-64-bit.exe" -OutFile git.exe -UseBasicParsing + Start-Process git.exe -ArgumentList '/VERYSILENT /SUPPRESSMSGBOXES /CLOSEAPPLICATIONS /DIR=c:\git\' -Wait + setx /M PATH "$env:Path;c:\git\cmd" - The system displays the **Git Setup** wizard. +You are now ready clone and build the Docker source code. -4. Click the **Next** button to move through the wizard and accept all the defaults. +## 4. Clone Docker -5. Click **Finish** when you are done. +In a new (to pick up the path change) PowerShell prompt, run: -## Task 3. Install TDM-GCC + git clone https://github.com/docker/docker + cd docker -TDM-GCC is a compiler suite for Windows. You'll use this suite to compile the -Docker Go code as you develop. +This clones the main Docker repository. Check out [Docker on GitHub](github.com/docker) to learn about the other software that powers the Docker platform. -1. Browse to - [tdm-gcc download page](http://tdm-gcc.tdragon.net/download). +## 5. Build and run -2. Click on the latest 64-bit version of the package. +Create a builder-container with the Docker source code. You can change the source code on your system and rebuild any time: - Windows prompts you to save the file to your machine + docker build -t nativebuildimage -f .\Dockerfile.windows . -3. Set up the suite by running the downloaded file. +To build Docker, run: - The system opens the **TDM-GCC Setup** wizard. + docker run --name out nativebuildimage sh -c 'cd /c/go/src/github.com/docker/docker; hack/make.sh binary' -4. Click **Create**. +Copy out the resulting Windows Docker daemon binary to dockerd.exe in the current directory: -5. Click the **Next** button to move through the wizard and accept all the defaults. + docker cp out:C:\go\src\github.com\docker\docker\bundles\$(cat VERSION)\binary-daemon\dockerd-$(cat VERSION).exe dockerd.exe -6. Click **Finish** when you are done. +To test it, stop the system Docker daemon and start the one you just built: + Stop-Service Docker + .\dockerd-1.13.0-dev.exe -D -## Task 4. Install MinGW (tar and xz) - -MinGW is a minimalist port of the GNU Compiler Collection (GCC). In this -procedure, you first download and install the MinGW installation manager. Then, -you use the manager to install the `tar` and `xz` tools from the collection. - -1. Browse to MinGW - [SourceForge](http://sourceforge.net/projects/mingw/). - -2. Click **Download**. - - Windows prompts you to save the file to your machine - -3. Run the downloaded file. - - The system opens the **MinGW Installation Manager Setup Tool** - -4. Choose **Install** install the MinGW Installation Manager. - -5. Press **Continue**. - - The system installs and then opens the MinGW Installation Manager. - -6. Press **Continue** after the install completes to open the manager. - -7. Select **All Packages > MSYS Base System** from the left hand menu. - - The system displays the available packages. - -8. Click on the **msys-tar bin** package and choose **Mark for Installation**. - -9. Click on the **msys-xz bin** package and choose **Mark for Installation**. - -10. Select **Installation > Apply Changes**, to install the selected packages. - - The system displays the **Schedule of Pending Actions Dialog**. - - ![windows-mingw](images/windows-mingw.png) - -11. Press **Apply** - - MingGW installs the packages for you. - -12. Close the dialog and the MinGW Installation Manager. - - -## Task 5. Set up your environment variables - -You'll need to add the compiler to your `Path` environment variable. - -1. Open the **Control Panel**. - -2. Choose **System and Security > System**. - -3. Click the **Advanced system settings** link in the sidebar. - - The system opens the **System Properties** dialog. - -3. Select the **Advanced** tab. - -4. Click **Environment Variables**. - - The system opens the **Environment Variables dialog** dialog. - -5. Locate the **System variables** area and scroll to the **Path** - variable. - - ![windows-mingw](images/path_variable.png) - -6. Click **Edit** to edit the variable (you can also double-click it). - - The system opens the **Edit System Variable** dialog. - -7. Make sure the `Path` includes `C:\TDM-GCC64\bin` - - ![include gcc](images/include_gcc.png) - - If you don't see `C:\TDM-GCC64\bin`, add it. - -8. Press **OK** to close this dialog. - -9. Press **OK** twice to close out of the remaining dialogs. - -## Install Go and cross-compile it - -In this section, you install the Go language. Then, you build the source so that it can cross-compile for `linux/amd64` architectures. - -1. Open [Go Language download](http://golang.org/dl/) page in your browser. - -2. Locate and click the latest `.msi` installer. - - The system prompts you to save the file. - -3. Run the installer. - - The system opens the **Go Programming Language Setup** dialog. - -4. Select all the defaults to install. - -5. Press **Finish** to close the installation dialog. - -6. Start a command prompt. - -7. Change to the Go `src` directory. - - cd c:\Go\src - -8. Set the following Go variables - - c:\Go\src> set GOOS=linux - c:\Go\src> set GOARCH=amd64 - -9. Compile the source. - - c:\Go\src> make.bat - - Compiling the source also adds a number of variables to your Windows environment. - -## Task 6. Get the Docker repository - -In this step, you start a Git `bash` terminal and get the Docker source code -from GitHub. - -1. Locate the **Git Bash** program and start it. - - Recall that **Git Bash** came with the Git for Windows installation. **Git - Bash** just as it sounds allows you to run a Bash terminal on Windows. - - ![Git Bash](images/git_bash.png) - -2. Change to the root directory. - - $ cd /c/ - -3. Make a `gopath` directory. - - $ mkdir gopath - -4. Go get the `docker/docker` repository. - - $ go.exe get github.com/docker/docker package github.com/docker/docker - imports github.com/docker/docker - imports github.com/docker/docker: no buildable Go source files in C:\gopath\src\github.com\docker\docker - - In the next steps, you create environment variables for you Go paths. - -5. Open the **Control Panel** on your system. - -6. Choose **System and Security > System**. - -7. Click the **Advanced system settings** link in the sidebar. - - The system opens the **System Properties** dialog. - -8. Select the **Advanced** tab. - -9. Click **Environment Variables**. - - The system opens the **Environment Variables dialog** dialog. - -10. Locate the **System variables** area and scroll to the **Path** - variable. - -11. Click **New**. - - Now you are going to create some new variables. These paths you'll create in the next procedure; but you can set them now. - -12. Enter `GOPATH` for the **Variable Name**. - -13. For the **Variable Value** enter the following: - - C:\gopath;C:\gopath\src\github.com\docker\docker\vendor - - -14. Press **OK** to close this dialog. - - The system adds `GOPATH` to the list of **System Variables**. - -15. Press **OK** twice to close out of the remaining dialogs. +The other make targets work too, to run unit tests try: `docker run --rm docker-builder sh -c 'cd /c/go/src/github.com/docker/docker; hack/make.sh test-unit'`. ## Where to go next