deploy: isso-comments/isso@dc11434

isso-comments · Apr 28, 2024 · 1f02c43 · 1f02c43
1 parent 6080084
commit 1f02c43
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 39 deletions.
diff --git a/.doctrees/docs/reference/installation.doctree b/.doctrees/docs/reference/installation.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/_sources/docs/reference/installation.rst.txt b/_sources/docs/reference/installation.rst.txt
@@ -149,12 +149,30 @@ two options for running a Docker container:
 a) Official Docker image
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. attention::
+
+   The Docker image tagging scheme for stable releases was changed from ``:latest``
+   to ``:release`` as of March 2024 (`#970`_, `#1012`_).
+
+.. _#970: https://github.com/isso-comments/isso/pull/970
+.. _#1012: https://github.com/isso-comments/isso/pull/1012
+
+A `Docker image`_ with the latest stable release is provided at
+``ghcr.io/isso-comments/isso:release``, while ``isso:latest`` is rebuilt on
+every push to the ``master`` branch.
+
+The maintainers recommend pinning the image to a `release tag`_, e.g.
+``isso:0.13.0``.
+
 .. code-block:: console
 
-    $ docker pull ghcr.io/isso-comments/isso:latest
+    $ docker pull ghcr.io/isso-comments/isso:release
     $ docker run -d --rm --name isso -p 127.0.0.1:8080:8080 \
         -v /var/lib/isso:/config -v /var/lib/isso:/db \
-        ghcr.io/isso-comments/isso:latest
+        ghcr.io/isso-comments/isso:release
+
+.. _Docker image: https://github.com/isso-comments/isso/pkgs/container/isso
+.. _release tag: https://github.com/isso-comments/isso/pkgs/container/isso
 
 b) Build a Docker image yourself
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/api/_output/assets/main.bundle.js b/docs/api/_output/assets/main.bundle.js
diff --git a/docs/api/_output/index.html b/docs/api/_output/index.html
@@ -5,15 +5,15 @@
   <meta name="description" content="Isso API">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-  <link href="assets/bootstrap.min.css?v=1713902977966" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/main.css?v=1713902977966" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1713902977966" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1713902977966" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1713902977966" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1713902977966" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1714342728122" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/main.css?v=1714342728122" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1714342728122" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1714342728122" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1714342728122" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1714342728122" rel="icon" type="image/png" sizes="16x16">
 </head>
 
 <body class="container-fluid">
@@ -1042,6 +1042,6 @@ <h2>{{__ "Request Body"}}</h2>
   </div>
 </div>
 
-<script src="assets/main.bundle.js?v=1713902977966"></script>
+<script src="assets/main.bundle.js?v=1714342728122"></script>
 </body>
 </html>
diff --git a/docs/api/assets/main.bundle.js b/docs/api/assets/main.bundle.js
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -5,15 +5,15 @@
   <meta name="description" content="Isso API">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-  <link href="assets/bootstrap.min.css?v=1713902977966" rel="stylesheet" media="screen">
-  <link href="assets/prism.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/prism-toolbar.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/prism-diff-highlight.css?v=1713902977966" rel="stylesheet" />
-  <link href="assets/main.css?v=1713902977966" rel="stylesheet" media="screen, print">
-  <link href="assets/favicon.ico?v=1713902977966" rel="icon" type="image/x-icon">
-  <link href="assets/apple-touch-icon.png?v=1713902977966" rel="apple-touch-icon" sizes="180x180">
-  <link href="assets/favicon-32x32.png?v=1713902977966" rel="icon" type="image/png" sizes="32x32">
-  <link href="assets/favicon-16x16.png?v=1713902977966" rel="icon" type="image/png" sizes="16x16">
+  <link href="assets/bootstrap.min.css?v=1714342728122" rel="stylesheet" media="screen">
+  <link href="assets/prism.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/prism-toolbar.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/prism-diff-highlight.css?v=1714342728122" rel="stylesheet" />
+  <link href="assets/main.css?v=1714342728122" rel="stylesheet" media="screen, print">
+  <link href="assets/favicon.ico?v=1714342728122" rel="icon" type="image/x-icon">
+  <link href="assets/apple-touch-icon.png?v=1714342728122" rel="apple-touch-icon" sizes="180x180">
+  <link href="assets/favicon-32x32.png?v=1714342728122" rel="icon" type="image/png" sizes="32x32">
+  <link href="assets/favicon-16x16.png?v=1714342728122" rel="icon" type="image/png" sizes="16x16">
 </head>
 
 <body class="container-fluid">
@@ -1042,6 +1042,6 @@ <h2>{{__ "Request Body"}}</h2>
   </div>
 </div>
 
-<script src="assets/main.bundle.js?v=1713902977966"></script>
+<script src="assets/main.bundle.js?v=1714342728122"></script>
 </body>
 </html>
diff --git a/docs/reference/installation/index.html b/docs/reference/installation/index.html
@@ -116,16 +116,16 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 the next section carefully.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
-<li><p><a class="reference internal" href="#interludium-python-is-not-php" id="id6">Interludium: Python is not PHP</a></p></li>
-<li><p><a class="reference internal" href="#install-from-pypi" id="id7">Install from PyPi</a></p></li>
-<li><p><a class="reference internal" href="#prebuilt-packages" id="id8">Prebuilt Packages</a></p></li>
-<li><p><a class="reference internal" href="#using-docker" id="id9">Using Docker</a></p></li>
-<li><p><a class="reference internal" href="#install-from-source" id="id10">Install from Source</a></p></li>
-<li><p><a class="reference internal" href="#init-scripts" id="id11">Init scripts</a></p></li>
+<li><p><a class="reference internal" href="#interludium-python-is-not-php" id="id8">Interludium: Python is not PHP</a></p></li>
+<li><p><a class="reference internal" href="#install-from-pypi" id="id9">Install from PyPi</a></p></li>
+<li><p><a class="reference internal" href="#prebuilt-packages" id="id10">Prebuilt Packages</a></p></li>
+<li><p><a class="reference internal" href="#using-docker" id="id11">Using Docker</a></p></li>
+<li><p><a class="reference internal" href="#install-from-source" id="id12">Install from Source</a></p></li>
+<li><p><a class="reference internal" href="#init-scripts" id="id13">Init scripts</a></p></li>
 </ul>
 </nav>
 <section id="interludium-python-is-not-php">
-<span id="install-interludium"></span><h3><a class="toc-backref" href="#id6" role="doc-backlink">Interludium: Python is not PHP</a><a class="headerlink" href="#interludium-python-is-not-php" title="Link to this heading">¶</a></h3>
+<span id="install-interludium"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink">Interludium: Python is not PHP</a><a class="headerlink" href="#interludium-python-is-not-php" title="Link to this heading">¶</a></h3>
 <p>If you think hosting a web application written in Python is as easy as one
 written in PHP, you are wrong. Unlike for PHP, many Linux distribution use
 Python for internal tools. Your package manager already ships several python
@@ -175,7 +175,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 machines or a shared host (e.g. Uberspace.de).</p>
 </section>
 <section id="install-from-pypi">
-<span id="id1"></span><h3><a class="toc-backref" href="#id7" role="doc-backlink">Install from PyPi</a><a class="headerlink" href="#install-from-pypi" title="Link to this heading">¶</a></h3>
+<span id="id1"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink">Install from PyPi</a><a class="headerlink" href="#install-from-pypi" title="Link to this heading">¶</a></h3>
 <section id="requirements">
 <h4>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h4>
 <ul class="simple">
@@ -217,23 +217,33 @@ <h4>Upgrade<a class="headerlink" href="#upgrade" title="Link to this heading">¶
 </section>
 </section>
 <section id="prebuilt-packages">
-<span id="prebuilt-package"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink">Prebuilt Packages</a><a class="headerlink" href="#prebuilt-packages" title="Link to this heading">¶</a></h3>
+<span id="prebuilt-package"></span><h3><a class="toc-backref" href="#id10" role="doc-backlink">Prebuilt Packages</a><a class="headerlink" href="#prebuilt-packages" title="Link to this heading">¶</a></h3>
 <ul class="simple">
 <li><p>Debian (since Buster): <a class="reference external" href="https://packages.debian.org/search?keywords=isso">https://packages.debian.org/search?keywords=isso</a></p></li>
 <li><p>Arch Linux: <a class="reference external" href="https://aur.archlinux.org/packages/isso/">https://aur.archlinux.org/packages/isso/</a></p></li>
 </ul>
 </section>
 <section id="using-docker">
-<span id="id3"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink">Using Docker</a><a class="headerlink" href="#using-docker" title="Link to this heading">¶</a></h3>
+<span id="id3"></span><h3><a class="toc-backref" href="#id11" role="doc-backlink">Using Docker</a><a class="headerlink" href="#using-docker" title="Link to this heading">¶</a></h3>
 <p>Assuming you have your configuration in <code class="docutils literal notranslate"><span class="pre">/var/lib/isso</span></code>, with
 <code class="docutils literal notranslate"><span class="pre">dbpath=/db/comments.db</span></code> and <code class="docutils literal notranslate"><span class="pre">host</span></code> set properly in <code class="docutils literal notranslate"><span class="pre">isso.cfg</span></code>, you have
 two options for running a Docker container:</p>
 <section id="a-official-docker-image">
 <h4>a) Official Docker image<a class="headerlink" href="#a-official-docker-image" title="Link to this heading">¶</a></h4>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>docker<span class="w"> </span>pull<span class="w"> </span>ghcr.io/isso-comments/isso:latest
+<div class="admonition attention">
+<p class="admonition-title">Attention</p>
+<p>The Docker image tagging scheme for stable releases was changed from <code class="docutils literal notranslate"><span class="pre">:latest</span></code>
+to <code class="docutils literal notranslate"><span class="pre">:release</span></code> as of March 2024 (<a class="reference external" href="https://github.com/isso-comments/isso/pull/970">#970</a>, <a class="reference external" href="https://github.com/isso-comments/isso/pull/1012">#1012</a>).</p>
+</div>
+<p>A <a class="reference external" href="https://github.com/isso-comments/isso/pkgs/container/isso">Docker image</a> with the latest stable release is provided at
+<code class="docutils literal notranslate"><span class="pre">ghcr.io/isso-comments/isso:release</span></code>, while <code class="docutils literal notranslate"><span class="pre">isso:latest</span></code> is rebuilt on
+every push to the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch.</p>
+<p>The maintainers recommend pinning the image to a <a class="reference external" href="https://github.com/isso-comments/isso/pkgs/container/isso">release tag</a>, e.g.
+<code class="docutils literal notranslate"><span class="pre">isso:0.13.0</span></code>.</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>docker<span class="w"> </span>pull<span class="w"> </span>ghcr.io/isso-comments/isso:release
 <span class="gp">$ </span>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--rm<span class="w"> </span>--name<span class="w"> </span>isso<span class="w"> </span>-p<span class="w"> </span><span class="m">127</span>.0.0.1:8080:8080<span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>-v<span class="w"> </span>/var/lib/isso:/config<span class="w"> </span>-v<span class="w"> </span>/var/lib/isso:/db<span class="w"> </span><span class="se">\</span>
-<span class="w">    </span>ghcr.io/isso-comments/isso:latest
+<span class="w">    </span>ghcr.io/isso-comments/isso:release
 </pre></div>
 </div>
 </section>
@@ -253,7 +263,7 @@ <h4>b) Build a Docker image yourself<a class="headerlink" href="#b-build-a-docke
 </section>
 </section>
 <section id="install-from-source">
-<span id="id4"></span><h3><a class="toc-backref" href="#id10" role="doc-backlink">Install from Source</a><a class="headerlink" href="#install-from-source" title="Link to this heading">¶</a></h3>
+<span id="id6"></span><h3><a class="toc-backref" href="#id12" role="doc-backlink">Install from Source</a><a class="headerlink" href="#install-from-source" title="Link to this heading">¶</a></h3>
 <p>If you want to hack on Isso or track down issues, there’s an alternate
 way to set up Isso. It requires a lot more dependencies and effort:</p>
 <ul class="simple">
@@ -288,7 +298,7 @@ <h4>b) Build a Docker image yourself<a class="headerlink" href="#b-build-a-docke
 </div>
 </section>
 <section id="init-scripts">
-<span id="id5"></span><h3><a class="toc-backref" href="#id11" role="doc-backlink">Init scripts</a><a class="headerlink" href="#init-scripts" title="Link to this heading">¶</a></h3>
+<span id="id7"></span><h3><a class="toc-backref" href="#id13" role="doc-backlink">Init scripts</a><a class="headerlink" href="#init-scripts" title="Link to this heading">¶</a></h3>
 <p>Init scripts to run Isso as a service (check your distribution’s documentation
 for your init-system; e.g. Debian uses SysVinit, Fedora uses systemd) if you
 don’t use FastCGi or uWSGI:</p>

diff --git a/searchindex.js b/searchindex.js