path: root/doc/html/docker/docker-101/index.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  
  <link rel="shortcut icon" href="../../img/favicon.ico">
  <title>Docker 101 - Shaarli Documentation</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="../../css/highlight.css">
  <link href="../../github-markdown.css" rel="stylesheet">
  
  <script>
    // Current page data
    var mkdocs_page_name = "Docker 101";
    var mkdocs_page_input_path = "docker/docker-101.md";
    var mkdocs_page_url = "/docker/docker-101/";
  </script>
  
  <script src="../../js/jquery-2.1.1.min.js"></script>
  <script src="../../js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="../../js/highlight.pack.js"></script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1">
		
    <a class="" href="../..">Home</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Setup</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Download-and-Installation/">Download and Installation</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-requirements/">Server requirements</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-configuration/">Server configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-security/">Server security</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Plugins/">Plugins</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Docker</span>
    <ul class="subnav">
                <li class=" current">
                    
    <a class="current" href="./">Docker 101</a>
    <ul class="subnav">
            
    <li class="toctree-l3"><a href="#basics">Basics</a></li>
    
        <ul>
        
            <li><a class="toctree-l4" href="#search-an-image-on-dockerhub">Search an image on DockerHub</a></li>
        
            <li><a class="toctree-l4" href="#show-available-tags-for-a-repository">Show available tags for a repository</a></li>
        
            <li><a class="toctree-l4" href="#pull-an-image-from-dockerhub">Pull an image from DockerHub</a></li>
        
        </ul>
    

    </ul>
                </li>
                <li class="">
                    
    <a class="" href="../shaarli-images/">Shaarli images</a>
                </li>
                <li class="">
                    
    <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../resources/">Docker resources</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Usage</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Features/">Features</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Bookmarklet/">Bookmarklet</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Firefox-share/">Firefox share</a>
                </li>
                <li class="">
                    
    <a class="" href="../../RSS-feeds/">RSS feeds</a>
                </li>
                <li class="">
                    
    <a class="" href="../../REST-API/">REST API</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">How To</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Various-hacks/">Various hacks</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="../../Troubleshooting/">Troubleshooting</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Development</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Development-guidelines/">Development guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
                </li>
                <li class="">
                    
    <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Directory-structure/">Directory structure</a>
                </li>
                <li class="">
                    
    <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Plugin-System/">Plugin System</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Security/">Security</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Static-analysis/">Static analysis</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Theming/">Theming</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Unit-tests/">Unit tests</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">About</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../FAQ/">FAQ</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
                </li>
    </ul>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../..">Shaarli Documentation</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../..">Docs</a> &raquo;</li>
    
      
          <li>Docker &raquo;</li>
        
      
    <li>Docker 101</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/docker-101.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h2 id="basics">Basics</h2>
<p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant
to your OS / distribution, and start the service.</p>
<h3 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a></h3>
<pre><code class="bash">$ docker search debian

NAME            DESCRIPTION                                     STARS   OFFICIAL   AUTOMATED
ubuntu          Ubuntu is a Debian-based Linux operating s...   2065    [OK]
debian          Debian is a Linux distribution that's comp...   603     [OK]
google/debian                                                   47                 [OK]
</code></pre>

<h3 id="show-available-tags-for-a-repository">Show available tags for a repository</h3>
<pre><code class="bash">$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool

% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
Dload  Upload   Total   Spent    Left  Speed
100  1283    0  1283    0     0    433      0 --:--:--  0:00:02 --:--:--   433
</code></pre>

<p>Sample output:</p>
<pre><code class="json">[
    {
        &quot;layer&quot;: &quot;85a02782&quot;,
        &quot;name&quot;: &quot;stretch&quot;
    },
    {
        &quot;layer&quot;: &quot;59abecbc&quot;,
        &quot;name&quot;: &quot;testing&quot;
    },
    {
        &quot;layer&quot;: &quot;bf0fd686&quot;,
        &quot;name&quot;: &quot;unstable&quot;
    },
    {
        &quot;layer&quot;: &quot;60c52dbe&quot;,
        &quot;name&quot;: &quot;wheezy&quot;
    },
    {
        &quot;layer&quot;: &quot;c5b806fe&quot;,
        &quot;name&quot;: &quot;wheezy-backports&quot;
    }
]

</code></pre>

<h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3>
<pre><code class="bash">$ docker pull repository[:tag]

$ docker pull debian:wheezy
wheezy: Pulling from debian
4c8cbfd2973e: Pull complete
60c52dbe9d91: Pull complete
Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
Status: Downloaded newer image for debian:wheezy
</code></pre>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
	  
        </div>
      </div>

    </section>
    
  </div>

  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
        <span><a href="../../Plugins/" style="color: #fcfcfc;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../shaarli-images/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="../../js/theme.js"></script>

</body>
</html>
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  
  <link rel="shortcut icon" href="../../img/favicon.ico">
  <title>Docker 101 - Shaarli Documentation</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="../../css/highlight.css">
  <link href="../../github-markdown.css" rel="stylesheet">
  
  <script>
    // Current page data
    var mkdocs_page_name = "Docker 101";
    var mkdocs_page_input_path = "docker/docker-101.md";
    var mkdocs_page_url = "/docker/docker-101/";
  </script>
  
  <script src="../../js/jquery-2.1.1.min.js"></script>
  <script src="../../js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="../../js/highlight.pack.js"></script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1">
		
    <a class="" href="../..">Home</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Setup</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Download-and-Installation/">Download and Installation</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-requirements/">Server requirements</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-configuration/">Server configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Server-security/">Server security</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Plugins/">Plugins</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Docker</span>
    <ul class="subnav">
                <li class=" current">
                    
    <a class="current" href="./">Docker 101</a>
    <ul class="subnav">
            
    <li class="toctree-l3"><a href="#basics">Basics</a></li>
    
        <ul>
        
            <li><a class="toctree-l4" href="#search-an-image-on-dockerhub">Search an image on DockerHub</a></li>
        
            <li><a class="toctree-l4" href="#show-available-tags-for-a-repository">Show available tags for a repository</a></li>
        
            <li><a class="toctree-l4" href="#pull-an-image-from-dockerhub">Pull an image from DockerHub</a></li>
        
        </ul>
    

    </ul>
                </li>
                <li class="">
                    
    <a class="" href="../shaarli-images/">Shaarli images</a>
                </li>
                <li class="">
                    
    <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="../resources/">Docker resources</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Usage</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Features/">Features</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Bookmarklet/">Bookmarklet</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Firefox-share/">Firefox share</a>
                </li>
                <li class="">
                    
    <a class="" href="../../RSS-feeds/">RSS feeds</a>
                </li>
                <li class="">
                    
    <a class="" href="../../REST-API/">REST API</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">How To</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Various-hacks/">Various hacks</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="../../Troubleshooting/">Troubleshooting</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Development</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../Development-guidelines/">Development guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
                </li>
                <li class="">
                    
    <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Directory-structure/">Directory structure</a>
                </li>
                <li class="">
                    
    <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Plugin-System/">Plugin System</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Security/">Security</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Static-analysis/">Static analysis</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Theming/">Theming</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Unit-tests/">Unit tests</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">About</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="../../FAQ/">FAQ</a>
                </li>
                <li class="">
                    
    <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
                </li>
    </ul>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../..">Shaarli Documentation</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../..">Docs</a> &raquo;</li>
    
      
          <li>Docker &raquo;</li>
        
      
    <li>Docker 101</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/docker-101.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h2 id="basics">Basics</h2>
<p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant
to your OS / distribution, and start the service.</p>
<h3 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a></h3>
<pre><code class="bash">$ docker search debian

NAME            DESCRIPTION                                     STARS   OFFICIAL   AUTOMATED
ubuntu          Ubuntu is a Debian-based Linux operating s...   2065    [OK]
debian          Debian is a Linux distribution that's comp...   603     [OK]
google/debian                                                   47                 [OK]
</code></pre>

<h3 id="show-available-tags-for-a-repository">Show available tags for a repository</h3>
<pre><code class="bash">$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool

% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
Dload  Upload   Total   Spent    Left  Speed
100  1283    0  1283    0     0    433      0 --:--:--  0:00:02 --:--:--   433
</code></pre>

<p>Sample output:</p>
<pre><code class="json">[
    {
        &quot;layer&quot;: &quot;85a02782&quot;,
        &quot;name&quot;: &quot;stretch&quot;
    },
    {
        &quot;layer&quot;: &quot;59abecbc&quot;,
        &quot;name&quot;: &quot;testing&quot;
    },
    {
        &quot;layer&quot;: &quot;bf0fd686&quot;,
        &quot;name&quot;: &quot;unstable&quot;
    },
    {
        &quot;layer&quot;: &quot;60c52dbe&quot;,
        &quot;name&quot;: &quot;wheezy&quot;
    },
    {
        &quot;layer&quot;: &quot;c5b806fe&quot;,
        &quot;name&quot;: &quot;wheezy-backports&quot;
    }
]

</code></pre>

<h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3>
<pre><code class="bash">$ docker pull repository[:tag]

$ docker pull debian:wheezy
wheezy: Pulling from debian
4c8cbfd2973e: Pull complete
60c52dbe9d91: Pull complete
Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
Status: Downloaded newer image for debian:wheezy
</code></pre>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
	  
        </div>
      </div>

    </section>
    
  </div>

  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
        <span><a href="../../Plugins/" style="color: #fcfcfc;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../shaarli-images/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="../../js/theme.js"></script>

</body>
</html>