better documentation

This commit is contained in:
lesion
2019-08-06 01:12:05 +02:00
parent 60edcbb970
commit 689b4d0a76
29 changed files with 261 additions and 823 deletions

View File

@@ -105,7 +105,7 @@
<li class="navigation-list-item ">
<a href="https://gancio.org/install/classic" class="navigation-list-link">Classic</a>
<a href="https://gancio.org/install/debian" class="navigation-list-link">Debian</a>
</li>
@@ -302,9 +302,8 @@
<div id="main-content" class="page-content" role="main">
<h2 id="install-with-docker">Install with docker</h2>
<p><strong>You do not need to clone the full repo as we distribute gancio via npm.</strong><br>
<a href="https://git.lattuga.net/cisti/gancio/raw/docker/docker/Dockerfile">Dockerfile</a> and <a href="https://git.lattuga.net/cisti/gancio/raw/docker/docker/docker-compose.yml">docker-compose.yml</a> are the only needed files.</p>
A <a href="https://git.lattuga.net/cisti/gancio/raw/docker/docker/Dockerfile">Dockerfile</a> and a docker-compose.yml are the only files needed.</p>
<ol>
<li>Create a directory where everything related to gancio is stored (db, images, config)
@@ -312,21 +311,43 @@
<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><img class="emoji" title=":information_source:" alt=":information_source:" src="https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height="20" width="20"> you can choose a different directory of course</p>
<p><img class="emoji" title=":information_source:" alt=":information_source:" src="https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height="20" width="20"> <small>you can choose a different directory.</small></p>
</li>
</ol>
<h3 id="using-postgresql">Using postgreSQL</h3>
<ol>
<li>Download docker-compose.yml and Dockerfile
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>wget https://git.lattuga.net/cisti/gancio/raw/master/docker/Dockerfile
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.yml
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.postgresql.yml <span class="nt">-O</span> docker.compose.yml
</code></pre></div> </div>
</li>
<li>Create an empty configuration file (db.sqlite only needed for sqlite
setup)
<li>Create an empty configiguration (<strong>this is needed</strong>)
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>touch config.json
</code></pre></div> </div>
</li>
</ol>
<h3 id="using-sqlite">Using sqlite</h3>
<ol>
<li>Download docker-compose.yml and Dockerfile
<div class="language-bash highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>wget https://git.lattuga.net/cisti/gancio/raw/master/docker/Dockerfile
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.sqlite.yml <span class="nt">-O</span> 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
</code></pre></div> </div>
<p><small>After first setup, you can edit <code class="highlighter-rouge">config.json</code> file and restart the container on your needs.</small></p>
</li>
</ol>
<h3 id="finish">Finish</h3>
<ol>
<li>Build docker image and launch interactive setup in one step
<div class="highlighter-rouge">
<div class="highlight"><pre class="highlight"><code>docker-compose run --rm gancio gancio setup --docker
@@ -338,10 +359,12 @@ setup)
</code></pre></div> </div>
</li>
<li>
<p><a href="/setup/nginx">Setup nginx as a proxy</a></p>
<p><a href="/install/nginx">Setup nginx as a proxy</a></p>
</li>
<li>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">
</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>