github.com/circular-dark/docker@v1.7.0/docs/project/software-required.md (about)

     1  <!--[metadata]>
     2  +++
     3  title = "Get the required software"
     4  description = "Describes the software required to contribute to Docker"
     5  keywords = ["GitHub account, repository, Docker, Git, Go, make,  "]
     6  [menu.main]
     7  parent = "smn_develop"
     8  weight=2
     9  +++
    10  <![end-metadata]-->
    11  
    12  # Get the required software for Linux or OS X
    13  
    14  This page explains how to get the software you need to use a Linux or OS X
    15  machine for Docker development. Before you begin contributing you must have:
    16  
    17  *  a GitHub account
    18  * `git`
    19  * `make` 
    20  * `docker`
    21  
    22  You'll notice that `go`, the language that Docker is written in, is not listed.
    23  That's because you don't need it installed; Docker's development environment
    24  provides it for you. You'll learn more about the development environment later.
    25  
    26  ### Get a GitHub account
    27  
    28  To contribute to the Docker project, you will need a <a
    29  href="https://github.com" target="_blank">GitHub account</a>. A free account is
    30  fine. All the Docker project repositories are public and visible to everyone.
    31  
    32  You should also have some experience using both the GitHub application and `git`
    33  on the command line. 
    34  
    35  ### Install git
    36  
    37  Install `git` on your local system. You can check if `git` is on already on your
    38  system and properly installed with the following command:
    39  
    40      $ git --version 
    41  
    42  
    43  This documentation is written using `git` version 2.2.2. Your version may be
    44  different depending on your OS.
    45  
    46  ### Install make
    47  
    48  Install `make`. You can check if `make` is on your system with the following
    49  command:
    50  
    51      $ make -v 
    52  
    53  This documentation is written using GNU Make 3.81. Your version may be different
    54  depending on your OS.
    55  
    56  ### Install or upgrade Docker 
    57  
    58  If you haven't already, install the Docker software using the 
    59  <a href="/installation" target="_blank">instructions for your operating system</a>.
    60  If you have an existing installation, check your version and make sure you have
    61  the latest Docker. 
    62  
    63  To check if `docker` is already installed on Linux:
    64  
    65      $ docker --version
    66      Docker version 1.5.0, build a8a31ef
    67  
    68  On Mac OS X or Windows, you should have installed Boot2Docker which includes
    69  Docker. You'll need to verify both Boot2Docker and then Docker. This
    70  documentation was written on OS X using the following versions.
    71  
    72      $ boot2docker version
    73      Boot2Docker-cli version: v1.5.0
    74      Git commit: ccd9032
    75  
    76      $ docker --version
    77      Docker version 1.5.0, build a8a31ef
    78  
    79  ## Linux users and sudo
    80  
    81  This guide assumes you have added your user to the `docker` group on your system.
    82  To check, list the group's contents:
    83  
    84      $ getent group docker
    85      docker:x:999:ubuntu
    86  
    87  If the command returns no matches, you have two choices. You can preface this
    88  guide's `docker` commands with `sudo` as you work. Alternatively, you can add
    89  your user to the `docker` group as follows:
    90  
    91      $ sudo usermod -aG docker ubuntu
    92  
    93  You must log out and log back in for this modification to take effect.
    94  
    95  
    96  ## Where to go next
    97  
    98  In the next section, you'll [learn how to set up and configure Git for
    99  contributing to Docker](/project/set-up-git/).