Files
gancio/docs/_site/install/docker.html
2020-01-30 15:23:43 +01:00

523 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Docker - Gancio</title>
<link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/style.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css">
<link rel="stylesheet" href="https://gancio.org/assets/css/fa.min.css">
<script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script>
<script type="text/javascript" src="https://gancio.org/assets/js/just-the-docs.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://gancio.org/assets/js/jquery-3.3.1.min.js"></script>
<link rel="stylesheet" href="https://gancio.org/assets/css/jquery.fancybox.min.css"/>
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Docker | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Docker" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities with AP support" />
<meta property="og:description" content="A shared agenda for local communities with AP support" />
<link rel="canonical" href="https://gancio.org/install/docker" />
<meta property="og:url" content="https://gancio.org/install/docker" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","headline":"Docker","url":"https://gancio.org/install/docker","description":"A shared agenda for local communities with AP support","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div class="page-wrap">
<div class="side-bar">
<a href="https://gancio.org/" class="site-title fs-6 lh-tight">Gancio</a>
<span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
<div class="navigation main-nav js-main-nav">
<nav role="navigation" aria-label="Main navigation">
<ul class="navigation-list">
<li class="navigation-list-item active">
<a href="https://gancio.org/404.html" class="navigation-list-link"></a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/" class="navigation-list-link">Home</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/usage" class="navigation-list-link">Usage</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/usage/recurrent" class="navigation-list-link">Recurrent events</a>
</li>
</ul>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install" class="navigation-list-link">Install</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/install/debian" class="navigation-list-link">Debian</a>
</li>
<li class="navigation-list-item active">
<a href="https://gancio.org/install/docker" class="navigation-list-link active">Docker</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/install/nginx" class="navigation-list-link">Nginx</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/config" class="navigation-list-link">Configuration</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/dev" class="navigation-list-link">Hacking</a>
<ul class="navigation-list-child-list ">
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/structure" class="navigation-list-link">Project Structure</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/oauth" class="navigation-list-link">OAuth</a>
</li>
<li class="navigation-list-item ">
<a href="https://gancio.org/dev/locales" class="navigation-list-link">Internationalization</a>
</li>
</ul>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/instances" class="navigation-list-link">Instances</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/about" class="navigation-list-link">About</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/contacts" class="navigation-list-link">Contacts</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/federation" class="navigation-list-link">Federation</a>
</li>
<li class="navigation-list-item">
<a href="https://gancio.org/changelog" class="navigation-list-link">Changelog</a>
</li>
</ul>
</nav>
</div>
<footer role="contentinfo" class="site-footer">
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
</footer>
</div>
<div class="main-content-wrap js-main-content" tabindex="0">
<div class="page-header">
<div class="main-content">
<div class="search js-search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search Gancio" aria-label="Search Gancio" autocomplete="off">
<svg width="14" height="14" viewbox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title>
<g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"></path><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"></path></g></svg>
</div>
<div class="js-search-results search-results-wrap"></div>
</div>
<ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
<li class="d-inline-block my-0 mr-2"><a href="https://blog.gancio.org">Blog</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://framagit.org/les/gancio">Source</a></li>
<li class="d-inline-block my-0 mr-2"><a href="https://socialhub.activitypub.rocks/c/software/gancio">Forum</a></li>
<li class="d-inline-block my-0"><a href="https://mastodon.cisti.org/@gancio">Mastodon</a></li>
</ul>
</div>
</div>
<div class="main-content">
<nav class="breadcrumb-nav">
<ol class="breadcrumb-nav-list">
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/install">Install</a></li>
<li class="breadcrumb-nav-list-item"><span>Docker</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<h2 class="no_toc text-delta" id="table-of-contents">Table of contents</h2>
<ol id="markdown-toc">
<li><a href="#initial-setup" id="markdown-toc-initial-setup">Initial setup</a></li>
<li><a href="#use-sqlite" id="markdown-toc-use-sqlite">Use sqlite</a></li>
<li><a href="#use-postgresql" id="markdown-toc-use-postgresql">Use postgreSQL</a></li>
<li><a href="#start-gancio" id="markdown-toc-start-gancio">Start gancio</a></li>
<li><a href="#upgrade" id="markdown-toc-upgrade">Upgrade</a></li>
</ol>
<h2 id="initial-setup">Initial setup</h2>
<p><strong>You do not need to clone the full repo as we distribute gancio via npm.</strong><br>
A Dockerfile and a docker-compose.yml are the only files needed.</p>
<ul>
<li>
<strong>Create a directory where everything related to gancio is stored (db, images, config)</strong>
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code><span class="nb">mkdir</span> /opt/gancio
<span class="nb">cd</span> /opt/gancio
</code></pre></div> </div>
<p><small>note that you can choose a different directory.</small></p>
</li>
</ul>
<h2 id="use-sqlite">Use sqlite</h2>
<div class="code-example bg-grey-lt-100">
<ol>
<li>
<strong>Download docker-compose.yml and Dockerfile</strong>
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>wget https://gancio.org/docker/Dockerfile
wget https://gancio.org/docker/sqlite/docker-compose.yml
</code></pre></div> </div>
</li>
<li>Create an empty db and config (<strong>this is needed</strong>)
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>touch config.json db.sqlite
mkdir user_locale
</code></pre></div> </div>
</li>
<li>Build docker image and launch interactive setup in one step
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>docker-compose build
docker-compose run --rm gancio gancio setup --docker --db=sqlite
</code></pre></div> </div>
</li>
</ol>
</div>
<h2 id="use-postgresql">Use postgreSQL</h2>
<div class="code-example bg-grey-lt-100">
<ol>
<li>
<strong>Download docker-compose.yml and Dockerfile</strong>
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>wget https://gancio.org/docker/Dockerfile
wget https://gancio.org/docker/postgres/docker-compose.yml
</code></pre></div> </div>
</li>
<li>Create an empty configuration (<strong>this is needed</strong>)
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>touch config.json
mkdir user_locale
</code></pre></div> </div>
</li>
<li>Build docker image and launch interactive setup in one step
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>docker-compose build
docker-compose run --rm gancio gancio setup --docker --db=postgres
</code></pre></div> </div>
</li>
</ol>
</div>
<h2 id="start-gancio">Start gancio</h2>
<ol>
<li>Run your container
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>docker-compose up <span class="nt">-d</span>
</code></pre></div> </div>
</li>
<li>Look at logs with
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>docker-compose logs
</code></pre></div> </div>
</li>
<li>
<p><a href="/install/nginx">Setup nginx as a proxy</a></p>
</li>
<li>
<p>Point your web browser to <a href="http://localhost:13120">http://localhost:13120</a> or where you specified during setup and enjoy <img class="emoji" title=":tada:" alt=":tada:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f389.png" height="20" width="20"></p>
</li>
<li>You can edit <code class="highlighter-rouge">config.json</code> file and restart the container on your needs, see <a href="/config">Configuration</a> for more details.</li>
</ol>
<h2 id="upgrade">Upgrade</h2>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">cd</span> /opt/gancio
docker-compose up <span class="nt">-d</span> <span class="nt">--no-deps</span> <span class="nt">--build</span>
</code></pre></div></div>
</div>
</div>
</div>
</div>
</body>
</html>