Build website

darribas · Oct 20, 2023 · 1e1b714 · 1e1b714
1 parent 7baea97
commit 1e1b714
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/assets/js/search-data.json b/docs/assets/js/search-data.json
@@ -36,7 +36,7 @@
   },"5": {
     "doc": "Docker - Build",
     "title": "Build process",
-    "content": "Make sure to point your terminal of choice to the folder where you have placed the Dockerfile to build: . cd /path/to/folder/with/Dockerfile . Then, run the following command: . docker build -t &lt;image-name&gt; . where &lt;image-name&gt; can be replaced by the name you want to give to the image you will create. Mind this process may take a long time. Particularly for gds, several of the R libraries need to be compiled from source and this takes time and CPU cycles. Once it finishes, you can check it has been built correctly by: . docker image ls . And you should see one image with the image-name you have selected. ",
+    "content": "Make sure to point your terminal of choice to the folder where you have placed the Dockerfile to build: . cd /path/to/folder/with/Dockerfile . Then, run the following command: . docker build \\ --no-cache \\ -t &lt;image-name&gt; \\ --progress=plain \\ . 2&gt;&amp;1 \\ | tee log.txt . where &lt;image-name&gt; can be replaced by the name you want to give to the image you will create. Mind this process may take a long time. Particularly for gds, several of the R libraries need to be compiled from source and this takes time and CPU cycles. Once it finishes, you can check it has been built correctly by: . docker image ls . And you should see one image with the image-name you have selected. ",
     "url": "/gds_env/guides/docker_build/#build-process",
 
     "relUrl": "/guides/docker_build/#build-process"

diff --git a/docs/guides/docker_build/index.html b/docs/guides/docker_build/index.html
@@ -1,4 +1,9 @@
 <!DOCTYPE html><html lang="en-US"><head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=Edge"><link rel="stylesheet" href="/gds_env/assets/css/just-the-docs-default.css"><style type="text/css"> .site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.external):nth-child(3) > .nav-list > .nav-list-item:nth-child(2) > .nav-list-link { display: block; font-weight: 600; text-decoration: none; background-image: linear-gradient(-90deg, #ebedf5 0%, rgba(235, 237, 245, 0.8) 80%, rgba(235, 237, 245, 0) 100%); } .site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:nth-child(3) > .nav-list-expander svg, .site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:nth-child(3) > .nav-list > .nav-list-item:nth-child(2) > .nav-list-expander svg { transform: rotate(-90deg); } .site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:nth-child(3) > .nav-list, .site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:nth-child(3) > .nav-list > .nav-list-item:nth-child(2) > .nav-list { display: block; } .site-nav > .nav-category-list > .nav-list-item > .nav-list-expander svg { transform: rotate(-90deg); } .site-nav > .nav-category-list > .nav-list-item > .nav-list { display: block; }</style><script async src="https://www.googletagmanager.com/gtag/js?id=UA-6032674-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-6032674-1', { 'anonymize_ip': true }); </script> <script src="/gds_env/assets/js/vendor/lunr.min.js"></script> <script src="/gds_env/assets/js/just-the-docs.js"></script><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="icon" href="/gds_env/favicon.ico" type="image/x-icon"><title>Docker - Build | gds_env</title><meta name="generator" content="Jekyll v3.8.5" /><meta property="og:title" content="Docker - Build" /><meta property="og:locale" content="en_US" /><meta name="description" content="A containerised platform for Geographic Data Science" /><meta property="og:description" content="A containerised platform for Geographic Data Science" /><link rel="canonical" href="https://darribas.org/gds_env/guides/docker_build/" /><meta property="og:url" content="https://darribas.org/gds_env/guides/docker_build/" /><meta property="og:site_name" content="gds_env" /> <script type="application/ld+json"> {"@type":"WebPage","headline":"Docker - Build","url":"https://darribas.org/gds_env/guides/docker_build/","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://darribas.org/gds_env/logo.png"}},"description":"A containerised platform for Geographic Data Science","@context":"http://schema.org"}</script><body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"><title>Link</title><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"><title>Menu</title><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"><title>Expand</title><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"><polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"><title id="svg-external-link-title">(external link)</title><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"><title>Document</title><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"><path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"><title>Search</title><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <symbol id="svg-copy" viewBox="0 0 16 16"><title>Copy</title><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"><path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/><path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"><title>Copied</title><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"><path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/><path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg><div class="side-bar"><div class="site-header" role="banner"> <a href="/gds_env/" class="site-title lh-tight"><div class="site-logo" role="img" aria-label="gds_env"></div></a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button></div><nav aria-label="Main" id="site-nav" class="site-nav"><ul class="nav-list"><li class="nav-list-item"><a href="/gds_env/" class="nav-list-link">Home</a><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Stacks category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/gds_env/stacks/" class="nav-list-link">Stacks</a><ul class="nav-list"><li class="nav-list-item"><a href="/gds_env/stacks/gds_py/" class="nav-list-link">gds_py</a><li class="nav-list-item"><a href="/gds_env/stacks/gds/" class="nav-list-link">gds</a><li class="nav-list-item"><a href="/gds_env/stacks/gds_dev/" class="nav-list-link">gds_dev</a></ul><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Guides category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/gds_env/guides/" class="nav-list-link">Guides</a><ul class="nav-list"><li class="nav-list-item"><a href="/gds_env/guides/docker_install/" class="nav-list-link">Docker - Install</a><li class="nav-list-item"><a href="/gds_env/guides/docker_build/" class="nav-list-link">Docker - Build</a><li class="nav-list-item"><a href="/gds_env/guides/virtualbox_install/" class="nav-list-link">Virtualbox - Install</a><li class="nav-list-item"><a href="/gds_env/guides/virtualbox_build/" class="nav-list-link">Virtualbox - Build</a><li class="nav-list-item"><a href="/gds_env/guides/vagrant_build/" class="nav-list-link">Vagrant - Build</a></ul><li class="nav-list-item"><a href="/gds_env/contributing/" class="nav-list-link">Contributing</a><li class="nav-list-item"><a href="/gds_env/faq/" class="nav-list-link">FAQ</a></ul></nav><footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</footer></div><div class="main" id="top"><div id="main-header" class="main-header"><div class="search" role="search"><div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search gds_env" aria-label="Search gds_env" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label></div><div id="search-results" class="search-results"></div></div><nav aria-label="Auxiliary" class="aux-nav"><ul class="aux-nav-list"><li class="aux-nav-list-item"> <a href="//github.com/darribas/gds_env" class="site-button" > gds_env on GitHub </a></ul></nav></div><div class="main-content-wrap"><nav aria-label="Breadcrumb" class="breadcrumb-nav"><ol class="breadcrumb-nav-list"><li class="breadcrumb-nav-list-item"><a href="/gds_env/guides/">Guides</a><li class="breadcrumb-nav-list-item"><span>Docker - Build</span></ol></nav><div id="main-content" class="main-content"><main><h1 id="build-docker-containers"> <a href="#build-docker-containers" class="anchor-heading" aria-labelledby="build-docker-containers"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Build Docker containers</h1><hr /><p><strong>IMPORTANT</strong> This is a guide for <em>building</em> Docker containers, not for downloading or using existing ones. If you are an end-user, you probably prefer to <a href="../docker_install">install containers</a>.</p><hr /><h2 id="requirements"> <a href="#requirements" class="anchor-heading" aria-labelledby="requirements"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Requirements</h2><p>To build one of the <code class="highlighter-rouge">gds_env</code> flavours from source, you need to access the Docker image can be built by running:</p><h2 id="build-process"> <a href="#build-process" class="anchor-heading" aria-labelledby="build-process"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Build process</h2><p>Make sure to point your terminal of choice to the folder where you have placed the <code class="highlighter-rouge">Dockerfile</code> to build:</p><div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">cd</span> /path/to/folder/with/Dockerfile
-</code></pre></div></div><p>Then, run the following command:</p><div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>docker build <span class="nt">-t</span> &lt;image-name&gt; <span class="nb">.</span>
+</code></pre></div></div><p>Then, run the following command:</p><div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>docker build <span class="se">\</span>
+        <span class="nt">--no-cache</span> <span class="se">\</span>
+        <span class="nt">-t</span> &lt;image-name&gt; <span class="se">\</span>
+        <span class="nt">--progress</span><span class="o">=</span>plain <span class="se">\</span>
+        <span class="nb">.</span> 2&gt;&amp;1 <span class="se">\</span>
+        | <span class="nb">tee </span>log.txt
 </code></pre></div></div><p>where <code class="highlighter-rouge">&lt;image-name&gt;</code> can be replaced by the name you want to give to the image you will create.</p><p>Mind this process may take a long time. Particularly for <a href="../../stacks/gds"><code class="highlighter-rouge">gds</code></a>, several of the R libraries need to be compiled from source and this takes time and CPU cycles.</p><p>Once it finishes, you can check it has been built correctly by:</p><div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>docker image <span class="nb">ls</span>
 </code></pre></div></div><p>And you should see one image with the <code class="highlighter-rouge">image-name</code> you have selected.</p></main><hr><footer><p><a href="#top" id="back-to-top">Back to top</a></p><p class="text-small text-grey-dk-100 mb-0">Copyright &copy; Dani Arribas-Bel. Distributed by an <a href="https://github.com/darribas/gds_env/blob/master/LICENSE">BSD 3-Clause license.</a></p><div class="d-flex mt-2"><p class="text-small text-grey-dk-000 mb-0"> <a href="https://github.com/darribas/gds_env/tree/master/guides/docker_build.md" id="edit-this-page">Edit this page on GitHub</a></p></div></footer></div></div><div class="search-overlay"></div></div>