From 9e460acb901893c296bf670643fce7b2faa79e82 Mon Sep 17 00:00:00 2001 From: Evgeniy Alekseev Date: Thu, 25 May 2023 16:19:28 +0300 Subject: [PATCH] faq update --- docs/faq.rst | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/docs/faq.rst b/docs/faq.rst index 717625a7..5bf14b21 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -753,6 +753,80 @@ If you did everything fine you should receive the message with the next update. (replace ``${CHAT_ID}`` and ``${API_KEY}`` with the values from configuration). +Maintenance packages +-------------------- + +Generate keyring package +^^^^^^^^^^^^^^^^^^^^^^^^ + +The application provides special plugin which generates keyring package. This plugin heavily depends on ``sign`` group settings, however it is possible to override them. The minimal package can be generated in the following way: + +#. + Edit configuration: + + .. code-block:: ini + + [keyring] + target = keyring_generator + + By default it will use ``sign.key`` as trusted key and all other keys as packagers ones. For all available options refer to :doc:`configuration . + +#. + Create package source files: + + .. code-block:: shell + + sudo -u ahriman ahriman repo-create-keyring + + This command will generate PKGBUILD, revoked and trusted listings and keyring itself and will register the package in database. + +#. + Build new package as usual: + + .. code-block:: shell + + sudo -u ahriman ahriman package-add aur-clone-keyring --source local --now + + where ``aur-clone`` is your repository name. + +This plugin might have some issues, in case of any of them, kindly create `new issue `_. + +Generate mirrorlist package +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The application provides special plugin which generates mirrorlist package also. It is possible to distribute this package as usual later. The package can be generated in the following way: + +#. + Edit configuration: + + .. code-block:: ini + + [mirrorlist] + target = mirrorlist_generator + + [mirrorlist_generator] + servers = https://repo.example.com/$arch + + The ``mirrorlist_generator.servers`` must contain list of available mirrors, the ``$arch`` and ``$repo`` variables are supported. For more options kindly refer to :doc:`configuration . + +#. + Create package source files: + + .. code-block:: shell + + sudo -u ahriman ahriman repo-create-mirrorlist + + This command will generate PKGBUILD and mirrorlist file and will register the package in database. + +#. + Build new package as usual: + + .. code-block:: shell + + sudo -u ahriman ahriman package-add aur-clone-mirrorlist --source local --now + + where ``aur-clone`` is your repository name. + Web service -----------