Skip to content

Commit

Permalink
Merge pull request #1025 from ix5/docs-misc
Browse files Browse the repository at this point in the history
docs: Misc changes for dropped IRC bridge, dbpath in docker, distro packaging
  • Loading branch information
ix5 authored May 5, 2024
2 parents 33ad1fb + c155e1c commit 4694f21
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 12 deletions.
1 change: 1 addition & 0 deletions contrib/isso-dev.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

[general]

# Change dbpath to /db/comments.db if running in docker!
dbpath = comments.db
host =
http://isso-dev.local/
Expand Down
1 change: 1 addition & 0 deletions contrib/isso.sample.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

[general]

# Change dbpath to /db/comments.db if running in docker!
dbpath = comments.db
host =
http://localhost:80/
Expand Down
7 changes: 3 additions & 4 deletions docs/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ Getting in contact
The main place of interaction for the Isso community is the
`GitHub issue tracker <https://github.com/isso-comments/isso/issues>`_.

A few people - including the lead developers and maintainers - frequent the
``#isso`` channel, which you can join via
`Matrix <https://matrix.to/#/#isso:libera.chat">`_ or via IRC on
`Libera.Chat <https://libera.chat/>`_
A few people - including some of the lead developers and maintainers -
sometimes participate in the ``#isso`` channel, which you can join via IRC on
`Libera.Chat <https://libera.chat/>`_.

You may also ask questions or suggest improvements on
`GitHub Discussions <https://github.com/isso-comments/isso/discussions>`_.
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/contributing/infrastructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ maintainer review before merging.
Packaging
---------

Isso is released "officially" to as an installable Python package on `PyPI`_
Isso is released "officially" as an installable Python package on `PyPI`_
and as a docker image. Other distributors may package releases of Isso natively
for operating systems (e.g. for the Arch User repository or formerly Debian),
but support for these releases should be given by the packager.
Expand All @@ -96,8 +96,9 @@ The `ghcr.io/isso-comments/isso docker image`_ is rebuilt on every push to
inherited from the main ``isso-comments/isso`` GitHub repository (toggle
``Inherit access from source repository`` turned on).

The `ghcr.io/isso-comments/isso-js-testbed`_ image for running ``Jest``-based
unit and integration tests is built and pushed manually by @ix5 so far.
The `ghcr.io/isso-comments/isso-js-testbed`_ image for running ``Jest``- and
``puppet``-based unit and integration tests is rebuilt and pushed every week by
a GitHub Action.

.. _ghcr.io/isso-comments/isso docker image: https://github.com/isso-comments/isso/pkgs/container/isso
.. _ghcr.io/isso-comments/isso-js-testbed: https://github.com/orgs/isso-comments/packages/container/package/isso-js-testbed
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/guides/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ sane defaults.
; database location, check permissions, automatically created if it
; does not exist
dbpath = /var/lib/isso/comments.db
; for docker image: dbpath = /db/comments.db
;
; your website or blog (not the location of Isso!)
host = http://example.tld/
; you can add multiple hosts for local development
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/client-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ data-isso-max-comments-nested
data-isso-reveal-on-click
Number of comments to reveal on clicking the "X Hidden" link.

Default: ``true``
Default: ``5``

.. _data-isso-avatar:

Expand Down
14 changes: 12 additions & 2 deletions docs/docs/reference/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,16 @@ To upgrade Isso, activate your virtual environment again, and run
Prebuilt Packages
-----------------

* Debian (since Buster): https://packages.debian.org/search?keywords=isso
* Arch Linux: The `isso`_ AUR package (maintained by `@HLFH`_) follows the
latest stable release, while the `isso-git`_ package (maintained by
`@AlphaJack`_) always builds the latest commit from ``git``.
* Debian: The package was `dropped in 2021`_ from the Debian repositories.

* Arch Linux: https://aur.archlinux.org/packages/isso/
.. _isso: https://aur.archlinux.org/packages/isso
.. _@HLFH: https://github.com/HLFH
.. _isso-git: https://aur.archlinux.org/packages/isso-git
.. _@AlphaJack: https://github.com/AlphaJack
.. _dropped in 2021: https://tracker.debian.org/pkg/isso

.. _using-docker:

Expand Down Expand Up @@ -167,6 +174,9 @@ The maintainers recommend pinning the image to a `release tag`_, e.g.
.. code-block:: console
$ docker pull ghcr.io/isso-comments/isso:release
$ mkdir -p config/ db/
$ cp contrib/isso.sample.cfg config/isso.cfg
# Set 'dbpath' to '/db/comments.db' and adjust 'host'
$ 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:release
Expand Down
3 changes: 1 addition & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ <h2>Links</h2>
</ul>
<h2>Help</h2>
<p>
Join <code>#isso</code> via <a href="https://matrix.to/#/#isso:libera.chat">Matrix</a>
or via IRC on <a href="https://libera.chat/">Libera.Chat</a>,
Join <code>#isso</code> via IRC on <a href="https://libera.chat/">Libera.Chat</a>,
or ask a question on <a href="https://github.com/isso-comments/isso/discussions">GitHub&nbsp;Discussions</a>.
</p>
<h2>Contribute</h2>
Expand Down

0 comments on commit 4694f21

Please sign in to comment.