Skip to content

Commit

Permalink
Deploying to gh-pages from @ fc5d2fe 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ildyria committed Feb 15, 2024
1 parent f782b9c commit 31fd001
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,12 @@ <h1>Docker</h1>
<ul>
<li><code>latest</code>: Latest Lychee release</li>
<li><code>v[NUMBER]</code>: Stable version tag for a Lychee release</li>
<li><code>dev</code>: Current master branch tag (Lychee operates on a stable master, so this should usually be safe)</li>
<li><code>nightly</code> (also <code>dev</code>): Current master branch tag (Lychee operates on a stable master, so this should usually be safe)</li>
<li><code>devtools</code>: Same as <code>nightly</code>, but includes development dependencies (e.g. api docs, debug bar)</li>
<li><code>alpha</code>: Current alpha branch tag (The alpha branch contains bleeding edge changes that are not peer-reviewed)</li>
<li><code>alpha-devtools</code>: Same as <code>alpha</code>, but includes development dependencies (e.g. api docs, debug bar)</li>
<li><code>testing</code>: Tag for testing new branches and pull requests. Designed for internal use by LycheeOrg.</li>
</ul>
<p>Note that only the <code>:dev</code> tag is available for armv6 and armv7 systems. This is due to an issue with the build environment and is hopefully temporary.</p>
<h2 id="setup"><a class="toclink" href="#setup">Setup</a></h2>
<h3 id="quick-start"><a class="toclink" href="#quick-start">Quick Start</a></h3>
<p>To use the built-in SQLite support, no external dependencies are required. At its simplest, <code>docker run -p 80 lycheeorg/lychee:dev</code> will start Lychee listening on a random port on the local host.</p>
Expand Down
30 changes: 30 additions & 0 deletions docs/update.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ <h1>Update</h1>
<ul>
<li><a href="#update-requirements">Update requirements</a></li>
<li><a href="#update-using-git">Update using Git</a></li>
<li><a href="#using-docker-compose">Using Docker compose</a></li>
<li><a href="#update-manually">Update manually</a></li>
<li><a href="#update-via-the-gui">Update via the GUI</a></li>
</ul>
Expand Down Expand Up @@ -140,6 +141,35 @@ <h2 id="update-using-git"><a class="toclink" href="#update-using-git">Update usi
<p>If you have the <code>post-merge</code> hook set up the following is enough:</p>
<pre><code class="language-bash">git pull
</code></pre>
<h2 id="using-docker-compose"><a class="toclink" href="#using-docker-compose">Using Docker compose</a></h2>
<p>There are two cases. Either you are pinned to a release tag, <em>e.g.</em> v5.1.2 or you are using a rolling update tag.</p>
<blockquote>
<p>{tip} When using docker, a version rollback is difficult to apply: it requires to bash into the container to run the required migrate commands on the new version before dropping the tag to the previous value.</p>
</blockquote>
<h4 id="with-rolling-update-tag"><a class="toclink" href="#with-rolling-update-tag">With Rolling update tag</a></h4>
<p>This procedure is for those following one of those tags:</p>
<ul>
<li><code>latest</code> &mdash; the last official release</li>
<li><code>nightly</code> or <code>dev</code> &mdash; the last build from the <code>master</code> branch (peer reviewed)</li>
<li><code>alpha</code> &mdash; the last build from the <code>alpha</code> branch (no peer review)</li>
</ul>
<p>Simply run the following.</p>
<pre><code class="language-bash">docker compose down
docker compose pull
docker compose up -d
</code></pre>
<p>The database migrations will be applied automatically.</p>
<h4 id="with-version-tag"><a class="toclink" href="#with-version-tag">With version tag.</a></h4>
<p>First edit your <code>docker-compose.yml</code> to point to the version you would like to migrate to.</p>
<pre><code class="language-diff">- image: lycheeorg/lychee:v5.1.0
+ image: lycheeorg/lychee:v5.1.2
</code></pre>
<p>Save and run the following.</p>
<pre><code class="language-bash">docker compose down
docker compose pull
docker compose up -d
</code></pre>
<p>The migration will be applied automatically and you should be running the requested tagged version.</p>
<h2 id="update-manually"><a class="toclink" href="#update-manually">Update manually</a></h2>
<p>This update will be the one you have to use if you are following the Release channel.</p>
<ol>
Expand Down

0 comments on commit 31fd001

Please sign in to comment.