encrypt/gancio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

better documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/_site/install/classic.html → docs/_site/install/debian.html
View File

@@ -5,7 +5,7 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
<title>Classic - Gancio</title>
<title>Debian - Gancio</title>
@@ -25,17 +25,17 @@
<script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script>
<!-- Begin Jekyll SEO tag v2.6.1 -->
<title>Classic | Gancio</title>
<title>Debian | Gancio</title>
<meta name="generator" content="Jekyll v3.8.6" />
<meta property="og:title" content="Classic" />
<meta property="og:title" content="Debian" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="A shared agenda for local communities" />
<meta property="og:description" content="A shared agenda for local communities" />
<link rel="canonical" href="https://gancio.org/install/classic" />
<meta property="og:url" content="https://gancio.org/install/classic" />
<link rel="canonical" href="https://gancio.org/install/debian" />
<meta property="og:url" content="https://gancio.org/install/debian" />
<meta property="og:site_name" content="Gancio" />
<script type="application/ld+json">
{"@type":"WebPage","url":"https://gancio.org/install/classic","headline":"Classic","description":"A shared agenda for local communities","@context":"https://schema.org"}</script>
{"@type":"WebPage","url":"https://gancio.org/install/debian","headline":"Debian","description":"A shared agenda for local communities","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
@@ -105,7 +105,7 @@
<li class="navigation-list-item active">
<a href="https://gancio.org/install/classic" class="navigation-list-link active">Classic</a>
<a href="https://gancio.org/install/debian" class="navigation-list-link active">Debian</a>
</li>
@@ -294,27 +294,32 @@
<li class="breadcrumb-nav-list-item"><a href="https://gancio.org/install">Install</a></li>
<li class="breadcrumb-nav-list-item"><span>Classic</span></li>
<li class="breadcrumb-nav-list-item"><span>Debian</span></li>
</ol>
</nav>
<div id="main-content" class="page-content" role="main">
<h2 id="install">Install</h2>
<h2 id="debian-installation">Debian installation</h2>
<ol>
<li>Install Node.js and postgreSQL
<li>Install Node.js &amp; yarn (<strong>from root</strong>)
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>curl <span class="nt">-sL</span> https://deb.nodesource.com/setup_12.x | bash -
apt-get <span class="nb">install</span> <span class="nt">-y</span> nodejs postgresql
apt-get <span class="nb">install</span> <span class="nt">-y</span> nodejs
curl <span class="nt">-sL</span> https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
<span class="nb">echo</span> <span class="s2">"deb https://dl.yarnpkg.com/debian/ stable main"</span> <span class="o">&gt;</span> /etc/apt/sources.list.d/yarn.list
apt-get update <span class="o">&amp;&amp;</span> apt-get <span class="nb">install </span>yarn
</code></pre></div> </div>
<p><small><a href="https://github.com/nodesource/distributions/blob/master/README.md">source</a></small></p>
</li>
<li>Install Gancio
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>npm <span class="nb">install</span> <span class="nt">--global</span> gancio
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>yarn add gancio <span class="nt">--prod</span>
</code></pre></div> </div>
</li>
<li>Create a database (optional as you can use sqlite, but recommended)
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo</span> <span class="nt">-u</span> postgres psql
<li>Setup with postgreSQL (optional as you can choose sqlite)
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>apt-get <span class="nb">install </span>postgresql
<span class="c"># Create the database</span>
su postgres <span class="nt">-c</span> psql
<span class="nv">postgres</span><span class="o">=</span><span class="c"># create database gancio;</span>
<span class="nv">postgres</span><span class="o">=</span><span class="c"># create user gancio with encrypted password 'gancio';</span>
<span class="nv">postgres</span><span class="o">=</span><span class="c"># grant all privileges on database gancio to gancio;</span>
@@ -339,13 +344,13 @@ gancio start <span class="nt">--config</span> config.json
<p>Point your web browser to <a href="http://localhost:13120">http://localhost:13120</a> or where you selected during setup.</p>
</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>Deploy in production<br />
If you don’t use the <a href="/setup/docker">docker way</a>, in production you should use something like <strong><a href="http://pm2.keymetrics.io/">pm2</a></strong>:</li>
If you don’t use the <a href="/install/docker">docker way</a>, in production you should use something like <strong><a href="http://pm2.keymetrics.io/">pm2</a></strong>:</li>
</ol>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>npm <span class="nb">install</span> <span class="nt">--global</span> pm2
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>yarn global add pm2
pm2 gancio start <span class="nt">--config</span> config.json
</code></pre></div></div>

45
docs/_site/install/docker.html
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>

2
docs/_site/install/nginx.html
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>