===============================
matrix-jitsi-bot documentation
===============================

matrix-jitsi-bot watches Jitsi conferences and reports their status to Matrix chat rooms.

.. grid:: 1 1 2 2
    :gutter: 3 3 4 5

    .. grid-item-card::
        :link: using-a-bot/index
        :link-type: doc

        :octicon:`comment-discussion;1.5em;sd-text-info`
        Bot configuration
        ^^^
        Invite the bot into a room and setup notifications for Jitsi conferences.
        +++

        .. button-ref:: using-a-bot/index
            :ref-type: doc
            :color: primary
            :expand:

            Get started with the bot

    .. grid-item-card::
        :link: hosting-a-bot/index
        :link-type: doc

        :octicon:`server;1.5em;sd-text-info`
        Self hosting
        ^^^
        Install matrix-jitsi-bot, create its Matrix account, and run it as a service.
        +++

        .. button-ref:: hosting-a-bot/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Self hosting

    .. grid-item-card::
        :link: development/index
        :link-type: doc

        :octicon:`code;1.5em;sd-text-info`
        Development
        ^^^
        Set up a local development environment and contribute changes.
        +++

        .. button-ref:: development/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Development

    .. grid-item-card::
        :link: maintenance/index
        :link-type: doc

        :octicon:`shield-check;1.5em;sd-text-info`
        Maintenance
        ^^^
        Release process, dependencies, and other maintainer responsibilities.
        +++

        .. button-ref:: maintenance/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Maintenance

    .. grid-item-card::
        :link: reference/index
        :link-type: doc

        :octicon:`bookmark;1.5em;sd-text-info`
        Reference
        ^^^
        The CLI reference and the API reference generated from the source code.
        +++

        .. button-ref:: reference/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Reference

.. toctree::
    :hidden:

    using-a-bot/index
    hosting-a-bot/index
    development/index
    maintenance/index
    reference/index

-   :ref:`genindex`

License
-------
See `LICENSE <https://github.com/niccokunzmann/matrix-jitsi-bot/blob/main/LICENSE>`_.