type: update for new cors release

This commit includes following changes
* add newly added option to configuration referenec
* remove few legacy options from configuration schemas used for
  validation, which might lead to errors during validation.
  Note, however, that settings will be still read by the service
* add link to aurcache
* hide service-setup command description under spoiler

.bandit-test.yml

@@ -1 +1,6 @@
-skips: ['B101', 'B404']
+skips:
+  - B101
+  - B104
+  - B105
+  - B106
+  - B404

.bandit.yml

@@ -1 +1,3 @@
-skips: ['B404', 'B603']
+skips:
+  - B404
+  - B603

.dockerignore

@@ -0,0 +1,14 @@
+.eggs/
+.git/
+.github/
+.idea/
+.mypy_cache/
+.pytest_cache/
+.tox/
+.venv/
+
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyd
+*.pyo

.github/ISSUE_TEMPLATE/01-bug-report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Summary
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior (commands, environment etc).
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Logs
+
+Add logs to help explain your problem. By default, the application writes logs into `/dev/log` which is usually default systemd journal and can be accessed by `journalctl` command.
+
+You can also attach any additional information which can be helpful, e.g. configuration used by the application (be aware of passwords and other secrets if any); it can be generated by using `ahriman config` command.
+
+It is also sometimes useful to have information about installed packages which can be accessed by `ahriman version` command.

.github/ISSUE_TEMPLATE/02-security-report.md

@@ -0,0 +1,20 @@
+---
+name: Security report
+about: Create a report related to security issues
+title: ''
+labels: security
+assignees: ''
+
+---
+
+## Summary
+
+A clear and concise description of what the issue is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior (commands, environment etc).
+
+### Intended impact
+
+Brief optional description of how this vulnerability can be used and which effects can be achieved. 

.github/ISSUE_TEMPLATE/03-feature-request.md

@@ -13,7 +13,7 @@ Brief description of the feature required
 
 ### Cause of the feature request
 
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
 
 ### Proposed changes and/or features
 

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-## Summary
-
-A clear and concise description of what the bug is.
-
-### Steps to Reproduce
-
-Steps to reproduce the behavior (commands, environment etc)
-
-### Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-### Logs
-
-Add logs to help explain your problem. Logs to stderr can be generated by using `--no-log` command line option.

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,5 +9,4 @@ Put `closes #ISSUE` in case if the pull requests solves one of the opened issues
 ### Checklist
 
 - [ ] Tests to cover new code
-- [ ] `make check` passed
-- [ ] `make tests` passed
+- [ ] `tox` passed

.github/workflows/docker.yml

@@ -0,0 +1,53 @@
+name: Docker image
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+      - '!*rc*'
+
+jobs:
+  docker-image:
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+
+    steps:
+      - uses: docker/setup-qemu-action@v2
+
+      - uses: docker/setup-buildx-action@v2
+
+      - name: Login to docker hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to github container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract docker metadata
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            arcan1s/ahriman
+            ghcr.io/arcan1s/ahriman
+          tags: |
+            type=semver,pattern={{raw}}
+            type=edge
+
+      - name: Build an image and push
+        uses: docker/build-push-action@v4
+        with:
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/regress.yml

@@ -0,0 +1,136 @@
+name: Regress
+
+on: workflow_dispatch
+
+jobs:
+  run-regress-tests:
+
+    runs-on: ubuntu-latest
+
+    services:
+      ahriman:
+        image: arcan1s/ahriman:edge
+        env:
+          AHRIMAN_PORT: 8080
+          AHRIMAN_UNIX_SOCKET: /var/lib/ahriman/ahriman/ahriman-web.sock
+        options: --privileged --entrypoint entrypoint-web
+        ports:
+          - 8080
+        volumes:
+          - repo:/var/lib/ahriman
+
+    container:
+      image: arcan1s/ahriman:edge
+      env:
+        AHRIMAN_DEBUG: y
+        AHRIMAN_OUTPUT: console
+        AHRIMAN_PORT: 8080
+        AHRIMAN_UNIX_SOCKET: /var/lib/ahriman/ahriman/ahriman-web.sock
+      options: --privileged
+      volumes:
+        - repo:/var/lib/ahriman
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: pacman -Sy
+
+      - name: Init repository
+        run: entrypoint help
+
+      - name: Print configuration
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            service-config
+
+      - name: Validate configuration
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            service-config-validate
+
+      - name: Create a user
+        run: |
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            user-add \
+              --packager "github actions <actions@github.com>" \
+              --password ahriman \
+              --role full \
+              ahriman
+
+      - name: Fetch users
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            user-list \
+              --exit-code
+          
+      - name: Add package
+        run: |
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            package-add \
+              --exit-code \
+              --now \
+              --refresh \
+              ahriman
+
+      - name: Update status of the package
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            package-status-update \
+              --status failed \
+              ahriman
+
+      - name: Request status of the package
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            package-status \
+              --exit-code \
+              --info \
+              --status failed \
+              ahriman
+          
+      - name: Update packages
+        run: |
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            repo-update \
+              --exit-code \
+          || true
+
+      - name: Add patch
+        run: |
+          echo '${pkgver%%.*}' | \
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            patch-add \
+              ahriman \
+              pkgrel
+          
+      - name: Retrieve patches
+        run: |
+          ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            patch-list \
+              --exit-code \
+              ahriman
+
+      - name: Rebuild packages
+        run: |
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            repo-rebuild \
+              --depends-on python \
+              --exit-code
+          
+      - name: Remove package
+        run: |
+          sudo -u ahriman ahriman \
+            --log-handler "$AHRIMAN_OUTPUT" \
+            package-remove \
+              ahriman

.github/workflows/release.yml

@@ -1,9 +1,9 @@
-name: release
+name: Release
 
 on:
   push:
     tags:
-      - '*.*.*'
+      - '*'
 
 jobs:
   make-release:
@@ -11,27 +11,36 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - name: extract version
+      - uses: actions/checkout@v3
+
+      - name: Extract version
         id: version
         run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
-      - name: create changelog
+
+      - name: Create changelog
         id: changelog
         uses: jaywcjlove/changelog-generator@main
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           filter: 'Release \d+\.\d+\.\d+'
-      - name: create archive
-        run: make archive
+
+      - name: Install dependencies
+        uses: ConorMacBride/install-package@v1.1.0
+        with:
+          apt: tox
+
+      - name: Create archive
+        run: tox -e archive
         env:
           VERSION: ${{ steps.version.outputs.VERSION }}
-      - name: Release
+
+      - name: Publish release
         uses: softprops/action-gh-release@v1
         with:
           body: |
             ${{ steps.changelog.outputs.compareurl }}
             ${{ steps.changelog.outputs.changelog }}
-          files: ahriman-*-src.tar.xz
+          files: dist/ahriman-*.tar.gz
           fail_on_unmatched_files: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/run-setup.yml

@@ -1,21 +0,0 @@
-name: setup
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  run-setup:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: setup the service in arch linux container
-        run: |
-          docker run \
-          -v  ${{ github.workspace }}:/build -w /build \
-          archlinux:latest \
-          .github/workflows/setup.sh

.github/workflows/run-tests.yml

@@ -1,21 +0,0 @@
-name: tests
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  run-tests:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: run check and tests in arch linux container
-        run: |
-          docker run \
-          -v  ${{ github.workspace }}:/build -w /build \
-          archlinux:latest \
-          .github/workflows/tests.sh

.github/workflows/setup.sh

@@ -3,47 +3,63 @@
 
 set -ex
 
+[[ $1 = "minimal" ]] && MINIMAL_INSTALL=1
+
 # install dependencies
-echo -e '[arcanisrepo]\nServer = http://repo.arcanis.me/$arch\nSigLevel = Never' | tee -a /etc/pacman.conf
+echo -e '[arcanisrepo]\nServer = https://repo.arcanis.me/$arch\nSigLevel = Never' | tee -a /etc/pacman.conf
 # refresh the image
-pacman --noconfirm -Syu
+pacman -Syyu --noconfirm
 # main dependencies
-pacman --noconfirm -Sy base-devel devtools git pyalpm python-aur python-passlib python-srcinfo sudo
+pacman -S --noconfirm devtools git pyalpm python-bcrypt python-inflection python-pyelftools python-requests python-systemd sudo
 # make dependencies
-pacman --noconfirm -Sy python-pip
+pacman -S --noconfirm --asdeps base-devel python-build python-flit python-installer python-tox python-wheel
 # optional dependencies
-# VCS support
-pacman --noconfirm -Sy breezy darcs mercurial subversion
-# web server
-pacman --noconfirm -Sy python-aioauth-client python-aiohttp python-aiohttp-debugtoolbar python-aiohttp-jinja2 python-aiohttp-security python-aiohttp-session python-cryptography python-jinja
-# additional features
-pacman --noconfirm -Sy gnupg python-boto3 rsync
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # web server
+    pacman -S --noconfirm python-aioauth-client python-aiohttp python-aiohttp-apispec-git python-aiohttp-cors python-aiohttp-jinja2 python-aiohttp-security python-aiohttp-session python-cryptography python-jinja
+    # additional features
+    pacman -S --noconfirm gnupg ipython python-boto3 python-cerberus python-matplotlib rsync
+fi
+# FIXME since 1.0.4 devtools requires dbus to be run, which doesn't work now in container
+cp "docker/systemd-nspawn.sh" "/usr/local/bin/systemd-nspawn"
 
 # create fresh tarball
-make VERSION=1.0.0 archlinux  # well, it does not really matter which version we will put here
+tox -e archive
 # run makepkg
-mv ahriman-*-src.tar.xz package/archlinux
+PKGVER=$(python -c "from src.ahriman import __version__; print(__version__)")
+mv "dist/ahriman-$PKGVER.tar.gz" package/archlinux
 chmod +777 package/archlinux  # because fuck you that's why
 cd package/archlinux
-sudo -u nobody makepkg -cf --skipchecksums --noconfirm
-pacman --noconfirm -U ahriman-1.0.0-1-any.pkg.tar.zst
+sudo -u nobody -- makepkg -cf --skipchecksums --noconfirm
+sudo -u nobody -- makepkg --packagelist | grep "ahriman-core-$PKGVER" | pacman -U --noconfirm --nodeps -
+if [[ -z $MINIMAL_INSTALL ]]; then
+    sudo -u nobody -- makepkg --packagelist | grep "ahriman-triggers-$PKGVER" | pacman -U --noconfirm --nodeps -
+    sudo -u nobody -- makepkg --packagelist | grep "ahriman-web-$PKGVER" | pacman -U --noconfirm --nodeps -
+fi
+# create machine-id which is required by build tools
+systemd-machine-id-setup
+
+# remove unused dependencies
+pacman -Qdtq | pacman -Rscn --noconfirm -
 
-# special thing for the container, because /dev/log interface is not available there
-sed -i 's/handlers = syslog_handler/handlers = console_handler/g' /etc/ahriman.ini.d/logging.ini
 # initial setup command as root
-sudo -u ahriman ahriman -a x86_64 init
-ahriman -a x86_64 repo-setup --packager "ahriman bot <ahriman@example.com>" --repository "github" --web-port 8080
+[[ -z $MINIMAL_INSTALL ]] && WEB_ARGS=("--web-port" "8080")
+ahriman -a x86_64 -r "github" service-setup --packager "ahriman bot <ahriman@example.com>" "${WEB_ARGS[@]}"
 # enable services
-systemctl enable ahriman-web@x86_64
-systemctl enable ahriman@x86_64.timer
-# run web service (detached)
-sudo -u ahriman ahriman -a x86_64 web &
-WEBPID=$!
-sleep 15s  # wait for the web service activation
+systemctl enable ahriman@x86_64-github.timer
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # validate configuration
+    ahriman service-config-validate --exit-code
+    # run web service (detached)
+    systemctl enable ahriman-web
+    sudo -u ahriman -- ahriman web &
+    WEB_PID=$!
+fi
 # add the first package
-# the build itself does not really work in the container because it requires procfs
-sudo -u ahriman ahriman package-add yay
+sudo -u ahriman -- ahriman --log-handler console package-add --now ahriman
+# check if package was actually installed
+test -n "$(find "/var/lib/ahriman/repository/github/x86_64" -name "ahriman*pkg*")"
 # run package check
-sudo -u ahriman ahriman repo-update
+sudo -u ahriman -- ahriman repo-update
 # stop web service lol
-kill $WEBPID
+[[ -z $WEB_PID ]] || kill $WEB_PID

.github/workflows/setup.yml

@@ -0,0 +1,42 @@
+name: Setup
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  run-setup-minimal:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      options: --privileged -w /build
+      volumes:
+        - ${{ github.workspace }}:/build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup the minimal service in arch linux container
+        run: .github/workflows/setup.sh minimal
+
+  run-setup:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      volumes:
+        - ${{ github.workspace }}:/build
+      options: --privileged -w /build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup the service in arch linux container
+        run: .github/workflows/setup.sh

.github/workflows/tests.sh

@@ -4,13 +4,7 @@
 set -ex
 
 # install dependencies
-pacman --noconfirm -Syu base-devel python-pip
-
-# install python packages
-pip install -e .[web]
-pip install -e .[check]
-pip install -e .[s3]
-pip install -e .[test]
+pacman --noconfirm -Syyu base-devel python-tox
 
 # run test and check targets
-make check tests
+tox

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: 1 0 * * *
+
+jobs:
+  run-tests:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      options: -w /build
+      volumes:
+        - ${{ github.workspace }}:/build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run check and tests in arch linux container
+        run: .github/workflows/tests.sh

.gitignore

@@ -94,3 +94,8 @@ ENV/
 .venv/
 
 *.tar.xz
+status_cache.json
+
+*.db
+
+docs/html/

.readthedocs.yml

@@ -0,0 +1,26 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.12"
+  apt_packages:
+    - graphviz
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - s3
+        - validator
+        - web
+
+formats:
+  - pdf
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

AUTHORS

@@ -1,2 +1,2 @@
-Current developers:
-Evgenii Alekseev aka arcanis <esalexeev (at) gmail (dot) com>
+Current maintainer:
+Evgenii Alekseev <esalexeev (at) gmail (dot) com>

CONTRIBUTING.md

@@ -0,0 +1,277 @@
+# Contributing to ahriman
+
+Welcome to ahriman! The goal of the project is to provide the best user experience to manage Arch linux repositories. In order to follow this we set some limitations for the issue creations and heavily restricted code contribution.
+
+## Create an issue
+
+Basically just follow the suggested templates:
+
+* Bug report requires at least the way to reproduce the issue and behaviour description (expected and actual ones). In order to resolve the bug, the additional questions may be asked, please consider them as lesser evil.
+* Feature requests basically just require feature description and the purpose why do you want this feature to be implemented. It is required to make sure that the feature you want is going to be implemented in the way you really want it (and to make sure that this feature is not already implemented).
+* Questions and discussions have free templates, and you are free to ask your question in the way you want.
+
+## Code contribution
+
+There are some strict limitation for suggested pull requests:
+
+* `autopep8`, `bandit`, `pylint`, `mypy` must pass.
+* Test coverage must remain 100%.
+
+### Code formatting
+
+In order to resolve all difficult cases the `autopep8` is used. You can perform formatting at any time by running `tox` or running `autopep8` command directly.
+
+### Code style
+
+Again, the most checks can be performed by `tox` command, though some additional guidelines must be applied:
+
+* Every class, every function (including private and protected), every attribute must be documented. The project follows [Google style documentation](https://google.github.io/styleguide/pyguide.html). The only exception is local functions.
+* Correct way to document function (if a section is empty, e.g. no notes or there are no args, it should be omitted) is the following:
+
+    ```python
+    def foo(argument: str, *, flag: bool = False) -> int:
+        """
+        do foo. With very very very long
+        docstring
+  
+        Notes:
+            Very important note about this function
+            Probably multi-line
+  
+        Args:
+            argument(str): an argument. This argument has
+                long description also
+            flag(bool, optional): a flag (Default value = False)
+  
+        Returns:
+            int: result with
+            long description
+  
+        Raises:
+            RuntimeError: a local function error occurs
+  
+        Examples:
+            Very informative example how to use this function, e.g.::
+  
+                >>> foo("argument", flag=False)
+  
+            Note that function documentation is in rST.
+        """
+    ```
+  
+  `Returns` should be replaced with `Yields` for generators.
+
+  Class attributes should be documented in the following way:
+
+    ```python
+    class Clazz(BaseClazz):
+        """
+        brand-new implementation of :class:`BaseClazz`
+  
+        Attributes:
+            CLAZZ_ATTRIBUTE(int): (class attribute) a brand-new class attribute
+            instance_attribute(str): an instance attribute
+                with the long description
+  
+        Examples:
+            Very informative class usage example, e.g.::
+  
+                >>> from module import Clazz
+                >>> clazz = Clazz()
+        """
+  
+        CLAZZ_ATTRIBUTE: ClassVar[int] = 42
+  
+        def __init__(self, *args: Any, **kwargs: Any) -> None:
+            """
+            Args:
+                *args(Any): positional arguments
+                **kwargs(Any): keyword arguments
+            """
+            self.instance_attribute = ""
+    ```
+
+  Note missing comment for the `__init__` method, which is the special case.
+
+* Type annotations are the must, even for local functions. For the function argument `self` (for instance methods) and `cls` (for class methods) should not be annotated.
+* For collection types built-in classes must be used if possible (e.g. `dict` instead of `typing.Dict`, `tuple` instead of `typing.Tuple`). In case if built-in type is not available, but `collections.abc` provides interface, it must be used (e.g. `collections.abc.Awaitable` instead of `typing.Awaitable`, `collections.abc.Iterable` instead of `typing.Iterable`). For union classes, the bar operator (`|`) must be used (e.g. `float | int` instead of `typing.Union[float, int]`), which also includes `typing.Optional` (e.g. `str | None` instead of `Optional[str]`).
+* `classmethod` should (almost) always return `Self`. In case of mypy warning (e.g. if there is a branch in which function doesn't return the instance of `cls`) consider using `staticmethod` instead.
+* Class attributes must be decorated as `ClassVar[...]`.
+* Recommended order of function definitions in class:
+
+    ```python
+    class Clazz:
+  
+        def __init__(self) -> None: ...  # replace with `__post_init__` for dataclasses
+
+        @property
+        def property(self) -> Any: ...
+  
+        @cached_property
+        def property_cached(self) -> Any: ...  # cached property has to be treated as normal one
+
+        @classmethod
+        def class_method(cls) -> Self: ...
+
+        @staticmethod
+        def static_method() -> Any: ...
+
+        def __private_method(self) -> Any: ...
+
+        def _protected_method(self) -> Any: ...
+
+        def usual_method(self) -> Any: ...
+
+        def __hash__(self) -> int: ...  # basically any magic (or look-alike) method
+    ```
+  
+  Methods inside one group should be ordered alphabetically, the only exceptions are `__init__` (`__post_init__` for dataclasses), `__new__` and `__del__` methods which should be defined first. For test methods it is recommended to follow the order in which functions are defined.
+
+  Though, we would like to highlight abstract methods (i.e. ones which raise `NotImplementedError`), we still keep in global order at the moment.
+
+  For the most cases there is custom `pylint` plugin, which performs checks automatically.
+
+* Abstract methods must raise `NotImplementedError` instead of using `abc.abstractmethod`. The reason behind this restriction is the fact that we have class/static abstract methods for those we need to define their attribute first making the code harder to read.
+* For any path interactions `pathlib.Path` must be used.
+* Configuration interactions must go through `ahriman.core.configuration.Configuration` class instance.
+* In case if class load requires some actions, it is recommended to create class method which can be used for class instantiating.
+* The most (expected) exceptions must be handled and printed to log, allowing service to continue work. However, fatal and (in some cases) unexpected exceptions may lead to the application termination.
+* Exceptions without parameters should be raised without parentheses, e.g.:
+
+    ```python
+    raise RuntimeError
+    ```
+
+* For the external command `ahriman.core.util.check_output` function must be used.
+* Every temporary file/directory must be removed at the end of processing, no matter what. The `tempfile` module provides good ways to do it.
+* Import order must be the following:
+
+    ```python
+    # optional imports from future module
+    from __future__ import annotations
+
+    # Module import for those which are installed into environment (no matter standard library or not)...
+    import os
+    # ...one per line...
+    import pyalpm
+    # ...in alphabetical order
+    import sys
+
+    # Blank line between
+    # ``from module import submodule`` import
+    from pathlib import Path
+    # ...again in alphabet order. It is possible to do several imports, but make sure that they are also in alphabetical order.
+    from pyalpm import Handle, Package
+
+    # Blank line again and package imports
+    from ahriman.core.configuration import Configuration
+    ```
+
+* One file should define only one class, exception is class satellites in case if file length remains less than 400 lines.
+* It is possible to create file which contains some functions (e.g. `ahriman.core.util`), but in this case you would need to define `__all__` attribute.
+* The file size mentioned above must be applicable in general. In case of big classes consider splitting them into traits. Note, however, that `pylint` includes comments and docstrings into counter, thus you need to check file size by other tools.
+* No global variable is allowed outside of `ahriman` module. `ahriman.core.context` is also special case.
+* Single quotes are not allowed. The reason behind this restriction is the fact that docstrings must be written by using double quotes only, and we would like to make style consistent.
+* If your class writes anything to log, the `ahriman.core.log.LazyLogging` trait must be used.
+* Web API methods must be documented by using `aiohttp_apispec` library. The schema testing mostly should be implemented in related view class tests. Recommended example for documentation (excluding comments):
+
+    ```python
+    from marshmallow import Schema, fields  
+    
+    from ahriman.web.apispec.decorators import apidocs
+    from ahriman.web.schemas import PackageNameSchema, PaginationSchema
+    from ahriman.web.views.base import BaseView
+
+
+    class RequestSchema(Schema):
+
+        field = fields.String(metadata={"description": "Field description", "example": "foo"})
+
+
+    class ResponseSchema(Schema):
+
+        field = fields.String(required=True, metadata={"description": "Field description"})
+
+
+    class Foo(BaseView):
+
+        POST_PERMISSION = ...
+        ROUTES = ...
+
+        @apidocs(
+            tags=["Tag"],
+            summary="Do foo",
+            description="Extended description of the method which does foo",
+            error_400_enabled=True,  # exception raised by this method
+            error_404_description="Repository is unknown",
+            schema=ResponseSchema,  # leave empty if no responses here
+            match_schema=PackageNameSchema,
+            query_schema=PaginationSchema,
+            body_schema=RequestSchema(many=True),
+        )
+        async def post(self) -> None: ...
+    ```
+
+* It is allowed to change web API to add new fields or remove optional ones. However, in case of model changes, new API version must be introduced.
+* On the other hand, it is allowed to change method signatures, however, it is recommended to add new parameters as optional if possible. Deprecated API can be dropped during major release.
+* Enumerations (`Enum` classes) are allowed and recommended. However, it is recommended to use `StrEnum` class if there are from/to string conversions and `IntEnum` otherwise.
+
+### Other checks
+
+The projects also uses typing checks (provided by `mypy`) and some linter checks provided by `pylint` and `bandit`. Those checks must be passed successfully for any open pull requests.
+
+## Developers how to
+
+### Run automated checks
+
+```shell
+tox
+```
+
+Must be usually done before any pushes.
+
+### Generate documentation templates
+
+```shell
+tox -e docs
+```
+
+Must be usually done if there are changes in modules structure.
+
+### Create release
+
+```shell
+tox -m release -- major.minor.patch
+```
+
+The command above will generate documentation, tags, etc., and will push them to GitHub. Other things will be handled by GitHub workflows automatically.
+
+### Hotfixes policy
+
+Sometimes it is required to publish hotfix with specific commits, but some features have been already committed, which should not be included to the hotfix. In this case, some manual steps are required:
+
+1. Create new branch from the last stable release (`major.minor.patch`):
+
+    ```shell
+    git checkout -b release/major.minor major.minor.patch
+    ```
+   
+2. Cherry-pick desired commit(s):
+
+    ```shell
+    git cherry-pick <commit-sha>
+    ```
+   
+   Alternatively, make changes to the new branch and commit them.
+
+3. Push newly created branch to remote:
+
+    ```shell
+    git push --set-upstream origin release/major.minor
+    ```
+   
+4. Proceed to release as usual:
+
+    ```shell
+    tox -m release -- major.minor.patch+1
+    ```

Makefile

@@ -1,63 +0,0 @@
-.PHONY: architecture archive archive_directory archlinux check clean directory man push tests version
-.DEFAULT_GOAL := archlinux
-
-PROJECT := ahriman
-
-FILES := AUTHORS COPYING README.md docs package src setup.cfg setup.py web.png
-TARGET_FILES := $(addprefix $(PROJECT)/, $(FILES))
-IGNORE_FILES := package/archlinux src/.mypy_cache
-
-$(TARGET_FILES) : $(addprefix $(PROJECT), %) : $(addprefix ., %) directory version
-	@cp -rp $< $@
-
-architecture:
-	cd src && pydeps ahriman -o ../docs/ahriman-architecture.svg --no-show --cluster
-
-archive: archive_directory
-	tar cJf "$(PROJECT)-$(VERSION)-src.tar.xz" "$(PROJECT)"
-	rm -rf "$(PROJECT)"
-
-archive_directory: $(TARGET_FILES)
-	rm -fr $(addprefix $(PROJECT)/, $(IGNORE_FILES))
-	find "$(PROJECT)" -type f -name "*.pyc" -delete
-	find "$(PROJECT)" -depth -type d -name "__pycache__" -execdir rm -rf {} +
-	find "$(PROJECT)" -depth -type d -name "*.egg-info" -execdir rm -rf {} +
-
-archlinux: archive
-	sed -i "s/pkgver=[0-9.]*/pkgver=$(VERSION)/" package/archlinux/PKGBUILD
-
-check: clean mypy
-	autopep8 --exit-code --max-line-length 120 -aa -i -j 0 -r "src/$(PROJECT)" "tests/$(PROJECT)"
-	pylint --rcfile=.pylintrc "src/$(PROJECT)"
-	bandit -c .bandit.yml -r "src/$(PROJECT)"
-	bandit -c .bandit-test.yml -r "tests/$(PROJECT)"
-
-clean:
-	find . -type f -name "$(PROJECT)-*-src.tar.xz" -delete
-	rm -rf "$(PROJECT)"
-
-directory: clean
-	mkdir "$(PROJECT)"
-
-man:
-	cd src &&  PYTHONPATH=. argparse-manpage --module ahriman.application.ahriman --function _parser --author "ahriman team" --project-name ahriman --author-email "" --url https://github.com/arcan1s/ahriman --output ../docs/ahriman.1
-
-mypy:
-	cd src && mypy --implicit-reexport --strict -p "$(PROJECT)" --install-types --non-interactive || true
-	cd src && mypy --implicit-reexport --strict -p "$(PROJECT)"
-
-push: architecture man archlinux
-	git add package/archlinux/PKGBUILD src/ahriman/version.py docs/ahriman-architecture.svg docs/ahriman.1
-	git commit -m "Release $(VERSION)"
-	git tag "$(VERSION)"
-	git push
-	git push --tags
-
-tests: clean
-	python setup.py test
-
-version:
-ifndef VERSION
-	$(error VERSION is required, but not set)
-endif
-	sed -i '/__version__ = "[0-9.]*/s/[^"][^)]*/__version__ = "$(VERSION)"/' src/ahriman/version.py

README.md

@@ -1,30 +1,44 @@
-# ArcH Linux ReposItory MANager
+# ArcH linux ReposItory MANager
 
-[![tests status](https://github.com/arcan1s/ahriman/actions/workflows/run-tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/run-tests.yml)
-[![setup status](https://github.com/arcan1s/ahriman/actions/workflows/run-setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/run-setup.yml)
+[![tests status](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml)
+[![setup status](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/arcan1s/ahriman?label=Docker%20image&sort=semver)](https://hub.docker.com/r/arcan1s/ahriman)
 [![CodeFactor](https://www.codefactor.io/repository/github/arcan1s/ahriman/badge)](https://www.codefactor.io/repository/github/arcan1s/ahriman)
+[![Documentation Status](https://readthedocs.org/projects/ahriman/badge/?version=latest)](https://ahriman.readthedocs.io)
 
 Wrapper for managing custom repository inspired by [repo-scripts](https://github.com/arcan1s/repo-scripts).
 
 ## Features
 
-* Install-configure-forget manager for own repository.
-* Multi-architecture support.
-* VCS packages support.
-* Sign support with gpg (repository, package, per package settings).
-* Synchronization to remote services (rsync, s3 and github) and report generation (html).
+* Install-configure-forget manager for the very own repository.
+* Multi architecture and repository support.
 * Dependency manager.
+* VCS packages support.
+* Official repository support.
 * Ability to patch AUR packages and even create package from local PKGBUILDs.
+* Various rebuild options with ability to automatically bump package version.
+* Sign support with gpg (repository, package), multiple packagers support.
+* Triggers for repository updates, e.g. synchronization to remote services (rsync, S3 and GitHub) and report generation (email, html, telegram).
 * Repository status interface with optional authorization and control options:
 
     ![web interface](web.png)
 
 ## Installation and run
 
-For installation details please refer to the [documentation](docs/setup.md). For command help, `--help` subcommand must be used. Subcommands have own help message as well. The package also provides a [man page](docs/ahriman.1).
+For installation details kindly refer to the [documentation](https://ahriman.readthedocs.io/en/stable/setup.html). For application commands it is possible to get information by using `--help`/`help` command or by using man page ([web version](https://ahriman.readthedocs.io/en/stable/command-line.html)).
 
 ## Configuration
 
-Every available option is described in the [documentation](docs/configuration.md).
+Every available option is described in the [documentation](https://ahriman.readthedocs.io/en/stable/configuration.html).
 
-## [FAQ](docs/faq.md)
+The application provides reasonable defaults which allow to use it out-of-box; however additional steps (like configuring build toolchain and sudoers) are recommended and can be easily achieved by following install instructions.
+
+## [FAQ](https://ahriman.readthedocs.io/en/stable/faq/index.html)
+
+## Live demos
+
+* [Build status page](https://ahriman-demo.arcanis.me). You can log in as `demo` user by using `demo` password. However, you will not be able to run tasks. [HTTP API documentation](https://ahriman-demo.arcanis.me/api-docs) is also available.
+* [Repository index](https://repo.arcanis.me/arcanisrepo/x86_64/).
+* [Telegram feed](https://t.me/arcanisrepo).
+
+Do you have any success story? You can [share it](https://github.com/arcan1s/ahriman/issues/new?template=04-discussion.md)!

SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+
+The project follows bleeding edge philosophy, thus only the latest version is supported with the exception for release candidates (i.e. tags which are marked with `rc` suffix).
+
+## Reporting a Vulnerability
+
+In the most cases you can report (suspected) security vulnerabilities directly on github by using ["Security report" template](https://github.com/arcan1s/ahriman/issues/new?assignees=&labels=security&template=02-security-report.md&title=). However, if your report could lead to data leak or break the system we kindly ask you to contact [current maintainer](AUTHORS) directly by email.

docker/Dockerfile

@@ -0,0 +1,140 @@
+# build image
+FROM archlinux:base AS build
+
+# install environment
+## create build user
+RUN useradd -m -d "/home/build" -s "/usr/bin/nologin" build
+
+## extract container creation date and set mirror for this timestamp, set PKGEXT and refresh database next
+RUN echo "Server = https://archive.archlinux.org/repos/$(stat -c "%y" "/var/lib/pacman" | cut -d " " -f 1 | sed "s,-,/,g")/\$repo/os/\$arch" > "/etc/pacman.d/mirrorlist" && \
+    pacman -Sy
+## setup package cache
+RUN runuser -u build -- mkdir "/tmp/pkg" && \
+    echo "PKGDEST=/tmp/pkg" >> "/etc/makepkg.conf" && \
+    echo "[options]" >> "/etc/pacman.conf" && \
+    echo "CacheDir = /tmp/pkg/" >> "/etc/pacman.conf"
+
+## install anc configure sudo
+RUN pacman -S --noconfirm --asdeps sudo && \
+    echo "build ALL=(ALL) NOPASSWD: ALL" > "/etc/sudoers.d/build"
+## copy install script
+COPY "docker/install-aur-package.sh" "/usr/local/bin/install-aur-package"
+## install package dependencies
+RUN pacman -S --noconfirm --asdeps \
+        devtools \
+        git \
+        pyalpm \
+        python-bcrypt  \
+        python-inflection \
+        python-pyelftools \
+        python-requests \
+        && \
+    pacman -S --noconfirm --asdeps \
+        base-devel \
+        python-build \
+        python-flit \
+        python-installer \
+        python-tox \
+        python-wheel \
+        && \
+    pacman -S --noconfirm --asdeps \
+        git \
+        python-aiohttp \
+        python-boto3 \
+        python-cerberus \
+        python-cryptography \
+        python-jinja \
+        python-systemd \
+        rsync \
+        && \
+    runuser -u build -- install-aur-package \
+        python-aioauth-client \
+        python-sphinx-typlog-theme \
+        python-webargs \
+        python-aiohttp-apispec-git \
+        python-aiohttp-cors \
+        python-aiohttp-jinja2 \
+        python-aiohttp-session \
+        python-aiohttp-security \
+        python-requests-unixsocket2
+
+# install ahriman
+## copy tree
+COPY --chown=build . "/home/build/ahriman"
+## create package archive and install it
+RUN cd "/home/build/ahriman" && \
+    tox -e archive && \
+    cp ./dist/*.tar.gz "package/archlinux" && \
+    cd "package/archlinux" && \
+    runuser -u build -- makepkg --noconfirm --skipchecksums && \
+    cd / && rm -r "/home/build/ahriman"
+
+
+# main image
+FROM archlinux:base AS ahriman
+
+# image configuration
+ENV AHRIMAN_ARCHITECTURE="x86_64"
+ENV AHRIMAN_DEBUG=""
+ENV AHRIMAN_FORCE_ROOT=""
+ENV AHRIMAN_HOST="0.0.0.0"
+ENV AHRIMAN_MULTILIB="yes"
+ENV AHRIMAN_OUTPUT=""
+ENV AHRIMAN_PACKAGER="ahriman bot <ahriman@example.com>"
+ENV AHRIMAN_PACMAN_MIRROR=""
+ENV AHRIMAN_PORT=""
+ENV AHRIMAN_POSTSETUP_COMMAND=""
+ENV AHRIMAN_PRESETUP_COMMAND=""
+ENV AHRIMAN_REPOSITORY="aur"
+ENV AHRIMAN_REPOSITORY_SERVER=""
+ENV AHRIMAN_REPOSITORY_ROOT="/var/lib/ahriman/ahriman"
+ENV AHRIMAN_UNIX_SOCKET=""
+ENV AHRIMAN_USER="ahriman"
+ENV AHRIMAN_VALIDATE_CONFIGURATION="yes"
+
+# install environment
+## update pacman.conf with multilib
+RUN echo "[multilib]" >> "/etc/pacman.conf" && \
+    echo "Include = /etc/pacman.d/mirrorlist" >> "/etc/pacman.conf"
+## copy built packages from build image and setup repository
+COPY --from=build "/tmp/pkg" "/var/cache/pacman/pkg"
+RUN repo-add "/var/cache/pacman/pkg/core.db.tar.zst" "/var/cache/pacman/pkg/"*.pkg.tar.zst && \
+    repo-add "/var/cache/pacman/pkg/extra.db.tar.zst" && \
+    repo-add "/var/cache/pacman/pkg/multilib.db.tar.zst"
+## set local directory to use as repository and refresh database
+RUN cp "/etc/pacman.d/mirrorlist" "/etc/pacman.d/mirrorlist.orig" && \
+    echo "Server = file:///var/cache/pacman/pkg" > "/etc/pacman.d/mirrorlist" && \
+    cp "/etc/pacman.conf" "/etc/pacman.conf.orig" && \
+    sed -i "s/SigLevel *=.*/SigLevel = Optional/g" "/etc/pacman.conf" && \
+    pacman -Sy
+## install package and its optional dependencies
+RUN pacman -S --noconfirm ahriman
+RUN pacman -S --noconfirm --asdeps \
+        python-aioauth-client \
+        python-aiohttp-apispec-git \
+        python-aiohttp-security \
+        python-aiohttp-session \
+        python-boto3 \
+        python-cerberus \
+        python-cryptography \
+        python-systemd \
+        python-requests-unixsocket2 \
+        rsync \
+        sudo
+
+## clear cache and restore system
+RUN find "/var/cache/pacman/pkg" "/var/lib/pacman/sync" -type "f,l" -delete && \
+    cp "/etc/pacman.d/mirrorlist.orig" "/etc/pacman.d/mirrorlist" && \
+    cp "/etc/pacman.conf.orig" "/etc/pacman.conf"
+
+VOLUME ["/var/lib/ahriman"]
+
+# minimal runtime ahriman setup
+## FIXME since 1.0.4 devtools requires dbus to be run, which doesn't work now in container
+COPY "docker/systemd-nspawn.sh" "/usr/local/bin/systemd-nspawn"
+## entrypoint setup
+COPY "docker/entrypoint.sh" "/usr/local/bin/entrypoint"
+COPY "docker/entrypoint-web.sh" "/usr/local/bin/entrypoint-web"
+ENTRYPOINT ["entrypoint"]
+# default command
+CMD ["repo-update", "--refresh"]

docker/entrypoint-web.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+# Special workaround for running web service in github actions, must not be usually used in real environment,
+# consider running web command explicitly instead
+
+exec entrypoint web "$@"

docker/entrypoint.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+
+set -e
+[ -n "$AHRIMAN_DEBUG" ] && set -x
+
+# configuration tune
+cat <<EOF > "/etc/ahriman.ini.d/01-docker.ini"
+[repository]
+root = $AHRIMAN_REPOSITORY_ROOT
+
+[web]
+host = $AHRIMAN_HOST
+
+EOF
+
+AHRIMAN_DEFAULT_ARGS=("--architecture" "$AHRIMAN_ARCHITECTURE")
+AHRIMAN_DEFAULT_ARGS+=("--repository" "$AHRIMAN_REPOSITORY")
+if [ -n "$AHRIMAN_OUTPUT" ]; then
+    AHRIMAN_DEFAULT_ARGS+=("--log-handler" "$AHRIMAN_OUTPUT")
+fi
+
+# create repository root inside the [[mounted]] directory and set correct ownership
+[ -d "$AHRIMAN_REPOSITORY_ROOT" ] || mkdir "$AHRIMAN_REPOSITORY_ROOT"
+chown "$AHRIMAN_USER":"$AHRIMAN_USER" "$AHRIMAN_REPOSITORY_ROOT"
+
+# create .gnupg directory which is required for keys
+AHRIMAN_GNUPG_HOME="$(getent passwd "$AHRIMAN_USER" | cut -d : -f 6)/.gnupg"
+[ -d "$AHRIMAN_GNUPG_HOME" ] || mkdir -m700 "$AHRIMAN_GNUPG_HOME"
+chown "$AHRIMAN_USER":"$AHRIMAN_USER" "$AHRIMAN_GNUPG_HOME"
+
+# run built-in setup command
+AHRIMAN_SETUP_ARGS=("--build-as-user" "$AHRIMAN_USER")
+AHRIMAN_SETUP_ARGS+=("--packager" "$AHRIMAN_PACKAGER")
+if [ -z "$AHRIMAN_MULTILIB" ]; then
+    AHRIMAN_SETUP_ARGS+=("--no-multilib")
+fi
+if [ -n "$AHRIMAN_PACMAN_MIRROR" ]; then
+    AHRIMAN_SETUP_ARGS+=("--mirror" "$AHRIMAN_PACMAN_MIRROR")
+fi
+if [ -n "$AHRIMAN_REPOSITORY_SERVER" ]; then
+    AHRIMAN_SETUP_ARGS+=("--server" "$AHRIMAN_REPOSITORY_SERVER")
+fi
+if [ -n "$AHRIMAN_PORT" ]; then
+    AHRIMAN_SETUP_ARGS+=("--web-port" "$AHRIMAN_PORT")
+fi
+if [ -n "$AHRIMAN_UNIX_SOCKET" ]; then
+    AHRIMAN_SETUP_ARGS+=("--web-unix-socket" "$AHRIMAN_UNIX_SOCKET")
+fi
+
+[ -n "$AHRIMAN_PRESETUP_COMMAND" ] && eval "$AHRIMAN_PRESETUP_COMMAND"
+ahriman "${AHRIMAN_DEFAULT_ARGS[@]}" service-setup "${AHRIMAN_SETUP_ARGS[@]}"
+[ -n "$AHRIMAN_POSTSETUP_COMMAND" ] && eval "$AHRIMAN_POSTSETUP_COMMAND"
+
+# validate configuration if set
+[ -n "$AHRIMAN_VALIDATE_CONFIGURATION" ] && ahriman "${AHRIMAN_DEFAULT_ARGS[@]}" service-config-validate --exit-code
+
+# create machine-id which is required by build tools
+systemd-machine-id-setup &> /dev/null
+
+# special workaround to emulate /bin/bash entrypoint if first argument starts with /
+[[ "$1" =~ ^/.* ]] && exec "$@"
+
+# if AHRIMAN_FORCE_ROOT is set or command is unsafe we can run without sudo
+# otherwise we prepend executable by sudo command
+if [ -n "$AHRIMAN_FORCE_ROOT" ]; then
+    AHRIMAN_EXECUTABLE=("ahriman")
+elif ahriman help-commands-unsafe -- "$@" &> /dev/null; then
+    AHRIMAN_EXECUTABLE=("sudo" "-E" "-u" "$AHRIMAN_USER" "--" "ahriman")
+else
+    AHRIMAN_EXECUTABLE=("ahriman")
+fi
+exec "${AHRIMAN_EXECUTABLE[@]}" "${AHRIMAN_DEFAULT_ARGS[@]}" "$@"

docker/install-aur-package.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+for PACKAGE in "$@"; do
+    BUILD_DIR="$(mktemp -d)"
+    # clone the remote source
+    git clone https://aur.archlinux.org/"$PACKAGE".git "$BUILD_DIR"
+    cd "$BUILD_DIR"
+    # checkout to the image date
+    git checkout "$(git rev-list -1 --before="$(stat -c "%y" "/var/lib/pacman" | cut -d " " -f 1)" master)"
+    # build and install the package
+    makepkg --nocheck --noconfirm --install --rmdeps --syncdeps
+    cd /
+    rm -r "$BUILD_DIR"
+done

docker/systemd-nspawn.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# Since https://gitlab.archlinux.org/archlinux/devtools/-/commit/5f4fd52e3836ddddb25a0f9e15d0acfed06f693d
+# it is impossible to start devtools inside docker container, because it requires slice registering
+# which is impossible because there is no init in container
+
+is_slice() {
+    [[ $1 =~ ^--slice* ]]
+}
+
+allowed=()
+for arg in "$@"; do
+    is_slice "$arg" && allowed+=("--keep-unit") || allowed+=("$arg")
+done
+
+exec /usr/bin/systemd-nspawn "${allowed[@]}"

docs/_static/logo.svg

@@ -0,0 +1,721 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="800"
+   height="800"
+   version="1.1"
+   id="svg106"
+   sodipodi:docname="logo.svg"
+   inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview106"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:zoom="1.8720703"
+     inkscape:cx="511.73292"
+     inkscape:cy="499.71414"
+     inkscape:window-width="3840"
+     inkscape:window-height="2160"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg106" />
+  <path
+     fill="#132b6d"
+     d="m 387.66175,2.9352426 c 109.978,-0.5206001 203.504,31.4880054 285.824,108.1504174 159.376,148.42203 165.076,403.05807 17.164,561.4021 -72.884,78.02402 -172.364,120.98802 -278.558,124.58202 -105.508,0.092 -196.612,-29.306 -277.44,-100.25401 C -17.844855,562.95974 -40.874855,327.5097 78.894545,164.89367 155.84375,60.416853 261.60375,10.958044 387.66175,2.9352426 Z"
+     id="path1"
+     style="stroke-width:2" />
+  <defs
+     id="defs2">
+    <linearGradient
+       id="gradient_0"
+       gradientUnits="userSpaceOnUse"
+       x1="361.42581"
+       y1="223.77209"
+       x2="195.62669"
+       y2="358.78311"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#C29024"
+         id="stop1" />
+      <stop
+         offset="1"
+         stop-color="#DCBB57"
+         id="stop2" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_0)"
+     d="M 351.39175,758.48578 C 168.77575,730.12777 41.748945,587.64375 38.358945,403.44571 34.725145,206.00568 197.09775,42.52665 394.25175,39.316449 c 199.908,-3.255 364.866,156.319231 367.572,354.681261 1.264,13.294 -0.766,28.52001 -2.266,41.84201 -22.772,202.34804 -192.312,343.02406 -397.788,324.19806 -2.656,-0.244 -8.104,-0.266 -10.378,-1.552 z"
+     id="path2"
+     style="fill:url(#gradient_0);stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 322.01375,466.26772 c -11.018,-19.004 -31.84,-33.106 -51.826,-41.634 -1.678,-0.714 -7.54,-2.124 -8.182,-3.564 l 0.732,-0.666 c 4,0.842 8.334,3.966 12.02,5.806 6.386,3.184 15.572,2.11 22.174,5.236 4.75,2.248 4.01,8.946 6.388,12.528 4.924,7.418 31.496,22.526 25.196,30.44801 -1.88,2.366 3.59,25.088 -6.502,27.406 9.19,-11.64 6.228,-23.022 0,-35.56001 z"
+     id="path3"
+     style="stroke-width:2" />
+  <path
+     fill="#f1ead8"
+     d="m 607.74175,596.82375 c 1.336,0.334 2.464,0.632 3.666,1.342 -20.054,9.052 -64.106,28.032 -86.62,22.686 4.1,-6.492 9.65,-12.676 16.658,-16.064 19.842,0.438 47.962,-0.334 66.296,-7.964 z"
+     id="path4"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 501.15175,566.49574 c 6.586,7.622 13.706,16.72001 22.154,22.30601 4.128,2.764 8.214,4.434 12.892,6.05 9.566,1.388 23.592,3.746 32.986,1.972 14.562,-1.188 28.228,-3.904 42.224,-8.022 l -1.062,3.132 c -0.626,1.91 -1.408,3.284 -2.604,4.89 -18.334,7.63 -46.454,8.402 -66.296,7.964 -7.008,3.388 -12.558,9.572 -16.658,16.064 -9.11,-5.624 -25.204,-20.256 -33.116,-27.858 -0.438,-2.818 -1.834,-5.878 -2.786,-8.594 3.066,-7.94801 11.252,-13.00801 12.266,-17.90401 z"
+     id="path5"
+     style="stroke-width:2" />
+  <path
+     fill="#f1ead8"
+     d="m 279.36575,419.47772 c 17.368,-2.17 52.85,13.874 66.39,23.914 16.654,12.346 42.944,41.42201 46.084,62.86401 l -0.632,0.818 c -7.4,-0.814 -14.928,-3.078 -22.004,0 -15.638,-34.97 -32.316,-54.81001 -66.512,-75.00601 -7.612,-4.496 -15.806,-7.926 -23.326,-12.59 z"
+     id="path6"
+     style="stroke-width:2" />
+  <path
+     fill="#f2e8a9"
+     d="m 358.50775,559.66374 c 12.018,13.204 20.532,31.28401 42.394,32.76001 26.828,1.808 75.452,-16.66001 100.25,-25.92801 -1.014,4.896 -9.2,9.956 -12.266,17.90401 0.952,2.716 2.348,5.776 2.786,8.594 -23.926,3.644 -42.772,14.97 -73.036,18.024 -31.48,3.176 -57.178,-20.208 -60.128,-51.35401 z"
+     id="path7"
+     style="stroke-width:2" />
+  <defs
+     id="defs8">
+    <linearGradient
+       id="gradient_1"
+       gradientUnits="userSpaceOnUse"
+       x1="251.38866"
+       y1="364.7413"
+       x2="250.98038"
+       y2="386.04666"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#8B5E10"
+         id="stop7" />
+      <stop
+         offset="1"
+         stop-color="#CF9A22"
+         id="stop8" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_1)"
+     d="m 310.19775,643.62576 c 2.576,-42.33201 43.824,-23.71801 68.946,-13.31801 29.856,12.36001 44.646,14.27401 76.866,17.40001 6.062,0.588 19.738,0.234 24.164,5.272 -4.906,4.506 -30.934,9.33 -37.886,8.6 -14.06,-1.944 -28.422,0.378 -42.516,0.02 -15.588,-0.394 -24.788,-3.174 -41.264,-0.02 -10.692,-0.35 -39.162,-6.928 -48.31,-12.01 l -0.164,-0.692 c -4.454,-4.498 -8.004,-10.198 -11.632,-15.38 h 1.106 c 3.348,3.464 6.672,7.448 10.69,10.128 z"
+     id="path8"
+     style="fill:url(#gradient_1);stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 533.18975,212.81168 3.008,1.8 c 104.752,81.45401 120.284,223.88804 39.258,327.17806 -4.874,6.214 -10.864,11.518 -15.55,17.874 -13.234,7.248 -22.01,22.26601 -36.562,27.66201 -3.272,-0.346 -14.796,-14.16001 -18.132,-17.28801 9.246,-9.45 22.016,-16.352 32.638,-26.984 75.99,-76.05602 84.014,-197.54404 14.068,-280.22005 -6.722,-7.946 -14.4,-14.688 -21.786,-21.97401 2.61,-8.98 1.014,-18.91 3.058,-28.048 z"
+     id="path9"
+     style="stroke-width:2" />
+  <defs
+     id="defs10">
+    <linearGradient
+       id="gradient_2"
+       gradientUnits="userSpaceOnUse"
+       x1="383.45288"
+       y1="318.2124"
+       x2="295.73892"
+       y2="203.79875"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#BF9029"
+         id="stop9" />
+      <stop
+         offset="1"
+         stop-color="#F5D354"
+         id="stop10" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_2)"
+     d="m 434.37375,137.51566 c 2.598,-0.164 5.328,-0.374 7.914,0 44.516,7.77801 92.47,33.43601 126.896,61.38602 7.438,7.668 16.4,14.876 22.864,23.372 2.62,2.794 5.176,5.692 8.21,8.044 5.566,3.826 22.78,23.15001 28.692,29.00401 l 0.008,0.522 c 0.052,5.284 2.926,14.418 2.624,16.914 1.07,8.98 6.816,17.276 9.974,25.644 32.534,86.22402 17.178,181.23004 -38.442,254.80205 -9.59,12.686 -20.71,25.49601 -33.178,35.41401 -3.856,3.068 -7.42,3.966 -0.752,4.206 -9.394,1.774 -23.42,-0.584 -32.986,-1.972 -4.678,-1.616 -8.764,-3.286 -12.892,-6.05 12.516,-9.682 25.068,-17.99401 36.6,-29.13801 4.686,-6.356 10.676,-11.66 15.55,-17.874 81.026,-103.29002 65.494,-245.72405 -39.258,-327.17806 l -3.008,-1.8 c -2.044,9.138 -0.448,19.068 -3.058,28.048 -20.19,-16.736 -57.964,-41.348 -84.916,-44.78 -4.862,6.39 -8.658,12.616 -14.43,18.532 -7.806,8.378 -15.312,17.27 -22.424,26.248 v -3.898 c -1.506,1.596 -4.512,4.54 -4.34,6.828 l 0.516,0.474 c -0.566,1.138 -1.052,2.3 -1.93,3.238 l -1.24,0.028 0.2,1.06001 c -4.05,-8.60801 1.232,-15.75801 3.436,-23.75601 26.818,-41.54401 24.194,-53.60601 -19.526,-73.22601 16.782,-3.452 30.824,-15.02601 48.896,-14.09201 z"
+     id="path10"
+     style="fill:url(#gradient_2);stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 592.04775,222.27368 c 2.62,2.794 5.176,5.692 8.21,8.044 8.066,13.52 19.78,29.05401 28.692,42.98401 -6.366,-3.072 -23.312,-30.26801 -30.038,-38.90201 -2.778,-3.566 -7.95,-7.296 -6.864,-12.126 z"
+     id="path11"
+     style="stroke-width:2" />
+  <path
+     fill="#051053"
+     d="m 600.25775,230.31768 c 5.566,3.826 22.78,23.15001 28.692,29.00401 l 0.008,0.522 c 0.052,5.284 2.926,14.418 2.624,16.914 -0.81,-1.204 -1.734,-2.318 -2.632,-3.456 -8.912,-13.93 -20.626,-29.46401 -28.692,-42.98401 z"
+     id="path12"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 536.19775,214.61168 c -9.436,-16.308 -80.554,-44.98201 -95.5,-43.60601 -2.88,-2.338 -5.638,-6.154 -7.546,-9.334 13.846,-0.878 61.092,18.238 74.408,25.094 7.224,3.72 43.202,27.84801 43.214,27.84601 3.21,2.37 5.956,5.258 9.132,7.662 4.042,5.416 9.626,9.648 14.302,14.496 93.102,96.54202 79.466,249.74005 -15.778,339.83206 -3.328,3.14801 -18.614,17.85401 -22.232,18.25001 -4.678,-1.616 -8.764,-3.286 -12.892,-6.05 12.516,-9.682 25.068,-17.99401 36.6,-29.13801 4.686,-6.356 10.676,-11.66 15.55,-17.874 81.026,-103.29002 65.494,-245.72405 -39.258,-327.17806 z"
+     id="path13"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 434.37375,137.51566 c 2.598,-0.164 5.328,-0.374 7.914,0 44.516,7.77801 92.47,33.43601 126.896,61.38602 2.568,7.928 14.072,10.708 15.774,18.372 l -0.474,0.94 -2.092,0.246 c -0.048,0.186 -10.608,12.996 -11.95,12.526 -3.166,-1.106 -7.656,-9.138 -10.536,-8.712 -3.176,-2.404 -5.922,-5.292 -9.132,-7.662 -0.012,0.002 -35.99,-24.12601 -43.214,-27.84601 -13.316,-6.856 -60.562,-25.972 -74.408,-25.094 1.908,3.18 4.666,6.996 7.546,9.334 14.946,-1.376 86.064,27.29801 95.5,43.60601 l -3.008,-1.8 c -2.044,9.138 -0.448,19.068 -3.058,28.048 -20.19,-16.736 -57.964,-41.348 -84.916,-44.78 -4.862,6.39 -8.658,12.616 -14.43,18.532 -7.806,8.378 -15.312,17.27 -22.424,26.248 v -3.898 c -1.506,1.596 -4.512,4.54 -4.34,6.828 l 0.516,0.474 c -0.566,1.138 -1.052,2.3 -1.93,3.238 l -1.24,0.028 0.2,1.06001 c -4.05,-8.60801 1.232,-15.75801 3.436,-23.75601 26.818,-41.54401 24.194,-53.60601 -19.526,-73.22601 16.782,-3.452 30.824,-15.02601 48.896,-14.09201 z"
+     id="path14"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 412.09175,152.87167 c 12.74,-3.468 25.54,-4.784 38.71,-3.946 -6.848,2.32 -14.484,5.572 -20.016,10.326 8.062,3.682 21.354,5.528 30.612,8.39 19.908,6.152 75.712,30.48001 89.376,46.97001 -0.012,0.002 -35.99,-24.12601 -43.214,-27.84601 -13.316,-6.856 -60.562,-25.972 -74.408,-25.094 1.908,3.18 4.666,6.996 7.546,9.334 14.946,-1.376 86.064,27.29801 95.5,43.60601 l -3.008,-1.8 c -17.866,-18.572 -65.548,-36.19801 -90.902,-40.93001 3.608,7.782 6.348,15.752 2.928,24.19801 -4.862,6.39 -8.658,12.616 -14.43,18.532 -7.806,8.378 -15.312,17.27 -22.424,26.248 v -3.898 c 22.078,-32.98 57.308,-46.31801 3.73,-84.09001 z"
+     id="path15"
+     style="stroke-width:2" />
+  <path
+     fill="#f1ead8"
+     d="m 442.28775,171.88167 c 25.354,4.732 73.036,22.35801 90.902,40.93001 -2.044,9.138 -0.448,19.068 -3.058,28.048 -20.19,-16.736 -57.964,-41.348 -84.916,-44.78 3.42,-8.44601 0.68,-16.41601 -2.928,-24.19801 z"
+     id="path16"
+     style="stroke-width:2" />
+  <defs
+     id="defs17">
+    <linearGradient
+       id="gradient_3"
+       gradientUnits="userSpaceOnUse"
+       x1="259.85068"
+       y1="248.27858"
+       x2="350.85385"
+       y2="408.95212"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#061757"
+         id="stop16" />
+      <stop
+         offset="1"
+         stop-color="#1C4897"
+         id="stop17" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_3)"
+     d="m 628.94975,259.32169 c 35.888,36.25 71.52,72.79001 107.964,108.48002 6.736,6.598 18.816,21.616 24.91,26.196 1.264,13.294 -0.766,28.52001 -2.266,41.84201 -22.772,202.34804 -192.312,343.02406 -397.788,324.19806 -2.656,-0.244 -8.104,-0.266 -10.378,-1.552 -4.572,-6.652 -23.912,-22.76601 -31.626,-30.48801 l -117.162,-117.50802 c -11.006,-10.966 -46.288,-42.43401 -53.304,-54.48401 -4.57,-5.32 -10.27,-9.648 -14.854,-15.058 4.872,0.144 18.938,7.52 23.586,10.336 6.858,1.708 20.052,4.126 26.25,6.798 0.434,-1.258 0.146,-2.694 0,-3.998 0.138,-1.692 0.09,-3.306 0,-5 3.348,0.634 6.652,2.408 10.05,2.2 13.202,5.656 24.534,12.708 34.05,23.62 3.788,3.09 7.482,6.23801 11.126,9.49601 4.716,4.008 9.52,7.936 13.794,12.424 1.884,0.704 5.45,2.046 6.762,3.614 1.584,0.97 3.154,2.014 4.78,2.904 7.256,3.166 14.768,8.762 21.092,13.49 1.516,2.334 3.288,4.486 5.016,6.664 l 7.45,10.00201 c 3.628,5.182 7.178,10.882 11.632,15.38 l 0.164,0.692 c 9.148,5.082 37.618,11.66 48.31,12.01 16.476,-3.154 25.676,-0.374 41.264,0.02 14.094,0.358 28.456,-1.964 42.516,-0.02 6.952,0.73 32.98,-4.094 37.886,-8.6 7.398,7.31 18.44,8.658 28.374,7.392 40.55,-5.168 97.53,-34.27201 123.034,-67.37801 -2.714,-0.424 9.054,-10.22 9.25,-12.97 -7.204,1.354 -10.72,9.924 -18.264,10.996 -3.768,2.22 -7.816,4.312 -11.16,7.146 -1.202,-0.71 -2.33,-1.008 -3.666,-1.342 1.196,-1.606 1.978,-2.98 2.604,-4.89 l 1.062,-3.132 c -13.996,4.118 -27.662,6.834 -42.224,8.022 -6.668,-0.24 -3.104,-1.138 0.752,-4.206 12.468,-9.918 23.588,-22.72801 33.178,-35.41401 55.62,-73.57201 70.976,-168.57803 38.442,-254.80205 -3.158,-8.368 -8.904,-16.664 -9.974,-25.644 0.302,-2.496 -2.572,-11.63 -2.624,-16.914 z"
+     id="path17"
+     style="fill:url(#gradient_3);stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 637.21175,576.96974 c 4.14,-2.36 8.288,-4.69 12.494,-6.932 -5.274,7.16 -11.4,17.29401 -18.124,22.95601 -2.714,-0.424 9.054,-10.22 9.25,-12.97 -7.204,1.354 -10.72,9.924 -18.264,10.996 3.782,-3.136 14.3,-8.644 15.882,-12.846 z"
+     id="path18"
+     style="stroke-width:2" />
+  <path
+     fill="#f2e8a9"
+     d="m 637.21175,576.96974 1.238,1.20401 c -1.582,4.202 -12.1,9.71 -15.882,12.846 -3.768,2.22 -7.816,4.312 -11.16,7.146 -1.202,-0.71 -2.33,-1.008 -3.666,-1.342 1.196,-1.606 1.978,-2.98 2.604,-4.89 l 1.062,-3.132 c 9.172,-3.09 17.482,-6.914 25.804,-11.83201 z"
+     id="path19"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 358.50775,661.57976 c 16.476,-3.154 25.676,-0.374 41.264,0.02 14.094,0.358 28.456,-1.964 42.516,-0.02 -25.31,6.146 -58.224,4.784 -83.78,0 z"
+     id="path20"
+     style="stroke-width:2" />
+  <defs
+     id="defs21">
+    <linearGradient
+       id="gradient_4"
+       gradientUnits="userSpaceOnUse"
+       x1="178.9133"
+       y1="342.13019"
+       x2="155.9601"
+       y2="362.37878"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#CC991E"
+         id="stop20" />
+      <stop
+         offset="1"
+         stop-color="#F2B831"
+         id="stop21" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_4)"
+     d="m 134.44575,540.94774 c 4.872,0.144 18.938,7.52 23.586,10.336 6.858,1.708 20.052,4.126 26.25,6.798 0.434,-1.258 0.146,-2.694 0,-3.998 0.138,-1.692 0.09,-3.306 0,-5 3.348,0.634 6.652,2.408 10.05,2.2 13.202,5.656 24.534,12.708 34.05,23.62 3.788,3.09 7.482,6.23801 11.126,9.49601 4.716,4.008 9.52,7.936 13.794,12.424 1.884,0.704 5.45,2.046 6.762,3.614 1.584,0.97 3.154,2.014 4.78,2.904 7.256,3.166 14.768,8.762 21.092,13.49 1.516,2.334 3.288,4.486 5.016,6.664 l 7.45,10.00201 c 3.628,5.182 7.178,10.882 11.632,15.38 l 0.164,0.692 c -22.282,-4.896 -55.696,-23.88201 -74.236,-37.44601 -6.744,-4.934 -12.552,-11.388 -19.652,-15.766 -6.676,-4.12 -15.06,-5.966 -22.186,-9.388 -16.632,-7.988 -30.922,-18.98801 -44.824,-30.96401 -4.57,-5.32 -10.27,-9.648 -14.854,-15.058 z"
+     id="path21"
+     style="fill:url(#gradient_4);stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 158.03175,551.28374 c 6.858,1.708 20.052,4.126 26.25,6.798 1.448,0.596 2.168,1.102 2.948,2.48 l -0.558,0.666 c -3.77,-0.136 -27.166,-8.046 -28.64,-9.944 z"
+     id="path22"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 242.85175,607.32775 c 7.25,0.168 31.11,8.666 40.444,11.75 -14.638,0.038 -27.2,-6.238 -40.444,-11.75 z"
+     id="path23"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 232.69375,596.82375 c 6.662,0.62 22.044,5.462 27.37,3.614 1.584,0.97 3.154,2.014 4.78,2.904 -4.194,1.55 -18.89,-0.318 -26.814,1.446 z"
+     id="path24"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 209.78375,574.90374 c -2.394,-0.948 -7.676,-3.032 -7.456,-6.196 5.142,-1.48 19.682,5.378 26.054,6.196 3.788,3.09 7.482,6.23801 11.126,9.49601 l -0.16,0.142 c -3.374,0.606 -25.568,-7.70801 -29.564,-9.63801 z"
+     id="path25"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 209.78375,574.90374 c 3.996,1.93 26.19,10.24401 29.564,9.63801 l 0.16,-0.142 c 4.716,4.008 9.52,7.936 13.794,12.424 1.884,0.704 5.45,2.046 6.762,3.614 -5.326,1.848 -20.708,-2.994 -27.37,-3.614 -10.77,-1.75 -16.314,-4.876 -19.558,-16.004 -1.528,-1.78 -2.85,-3.59801 -3.352,-5.91601 z"
+     id="path26"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 209.78375,574.90374 c 3.996,1.93 26.19,10.24401 29.564,9.63801 l 0.16,-0.142 c 4.716,4.008 9.52,7.936 13.794,12.424 v 0 c -11.244,-0.884 -22.286,-6.858 -31.866,-12.424 -2.804,-0.374 -5.434,-2.774 -8.3,-3.58 -1.528,-1.78 -2.85,-3.59801 -3.352,-5.91601 z"
+     id="path27"
+     style="stroke-width:2" />
+  <path
+     fill="#ad7214"
+     d="m 221.43575,584.39975 c 6.578,-0.56 30.096,8.298 31.866,12.424 -11.244,-0.884 -22.286,-6.858 -31.866,-12.424 z"
+     id="path28"
+     style="stroke-width:2" />
+  <path
+     fill="#132b6d"
+     d="m 266.41175,531.65974 c -4.998,-0.03 -11.098,-9.27801 -14.01,-12.81601 -78.2,-95.08401 -44.296,-239.09604 68.622,-289.88605 14.626,-6.58 87.39,-28.004 83.98,-12.018 0.29,5.32 -5.89,12.826 -5.742,19.654 l 0.8,-0.356 0.256,-0.984 c 0.838,-3.116 3.132,-7.658 4.686,-10.42 v 0 c -2.204,7.998 -7.486,15.148 -3.436,23.75601 l -0.2,-1.06001 1.24,-0.028 c 0.878,-0.938 1.364,-2.1 1.93,-3.238 l -0.516,-0.474 c -0.172,-2.288 2.834,-5.232 4.34,-6.828 v 3.898 c 7.112,-8.978 14.618,-17.87 22.424,-26.248 l 0.5,0.152 c 8.212,2.444 16.47,3.944 24.602,6.854 58.574,20.972 106.85,72.05001 120.456,133.45202 1.73,7.81001 2.632,15.79601 4.472,23.57201 0.174,4.016 1.316,11.12 -0.142,14.692 l -1.322,0.664 1.154,0.176 c 1.286,3.432 0.364,9.786 0.31,13.526 0.428,4.816 0.606,10.62001 0,15.40801 -1.662,4.574 -2.66,9.378 -3.582,14.148 -0.862,5.382 -1.694,10.842 -3.742,15.924 -1.502,3.656 -3.308,7.462 -4.308,11.294 -0.442,4.27201 -3.664,10.89601 -6.116,14.42401 -2.28,4.28 -4.82,10.524 -8.172,14.028 -2.766,4.198 -5.424,8.452 -8.062,12.73 l -10.636,13.256 c -0.812,1.354 -10.158,11.70601 -11.41,12.74801 -4.732,2.976 -7.86,5.02 -11.552,9.288 -4.794,2.344 -9.02,6.04 -13.816,8.136 -4.916,2.576 -9.95,5.226 -14.068,8.998 -5.336,1.804 -10.23,3.636 -15.1,6.486 -3,0.812 -11.478,3.87 -14.124,3.644 -5.37,1.882 -11.066,2.43 -16.396,4.486 l -14.888,2.206 c -3.228,-0.058 -14.524,1.172 -16.482,0 -2.668,0.884 -14.2,-1.2 -17.154,-2.206 -4.388,-1.97 -13.234,-3.4 -15.17,-4.486 -15.284,-4 -26.706,-61.61201 4.84,-58.55001 5.12,0.178 10.212,1.104 15.266,1.896 -0.322,-4.59 -1.47,-8.966 -2.758,-13.362 -31.792,-69.38401 -101.182,-95.30202 -174.692,-84.31001 28.904,2.816 52.742,14.29 77.006,28.634 14.684,13.388 42.828,39.46001 22.146,59.30801 -4.42,-5.66 -9.796,-10.928 -13.456,-17.124 l -1.134,0.23 0.924,-0.544 0.246,0.612 -1.168,-0.966 c -0.378,1.04 0.1,2.79 0.238,3.908 -0.494,8.656 -0.63,17.812 -1.922,26.378 -0.986,1.08 -1.914,2.264 -3.172,3.032 -4.348,3.636 -8.422,7.43801 -12.466,11.40401 -1.992,-3.07 -5.034,-6.59401 -6.57,-9.84601 -2.598,-1.562 -2.622,-4.334 -3.65,-6.816 l -0.892,0.308 c -0.248,2.022 1.28,3.668 1.268,5.77 l -0.744,0.738 c 2.36,3.862 7.746,10.52601 7.948,15.01601 -5.642,-0.656 -11.25,-1.548 -16.884,-2.268 z"
+     id="path29"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 271.23775,505.65573 4.11,2.688 c 0.612,3.864 2.48,7.024 4.018,10.568 -2.598,-1.562 -2.622,-4.334 -3.65,-6.816 l -0.892,0.308 c -0.248,2.022 1.28,3.668 1.268,5.77 l -0.744,0.738 c -1.114,-4.514 -3.114,-8.68 -4.11,-13.256 z"
+     id="path30"
+     style="stroke-width:2" />
+  <path
+     fill="#051053"
+     d="m 397.67375,507.07373 c 2.356,4.01 4.79,7.942 7.33,11.838 -3.3,-1.106 -7.652,-4.4 -10.786,-4.59 l 1.848,-0.566 c 1.032,-1.614 0.804,-4.254 1.44,-6.188 z"
+     id="path31"
+     style="stroke-width:2" />
+  <path
+     fill="#0f0e1a"
+     d="m 393.38575,498.19573 c 3.194,2.542 2.828,5.462 4.288,8.878 l -0.168,0.494 c -0.636,1.934 -0.408,4.574 -1.44,6.188 l -1.848,0.566 c -4.74,-0.682 -9.642,-1.346 -13.34,-4.66 5.12,0.178 10.212,1.104 15.266,1.896 -0.322,-4.59 -1.47,-8.966 -2.758,-13.362 z"
+     id="path32"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 405.00375,216.93968 c 0.29,5.32 -5.89,12.826 -5.742,19.654 l 0.8,-0.356 0.256,-0.984 c 0.838,-3.116 3.132,-7.658 4.686,-10.42 v 0 c -2.204,7.998 -7.486,15.148 -3.436,23.75601 l -0.2,-1.06001 1.24,-0.028 c 0.878,-0.938 1.364,-2.1 1.93,-3.238 l -0.516,-0.474 c -0.172,-2.288 2.834,-5.232 4.34,-6.828 v 3.898 c -5.74,7.47601 -10.278,15.97801 -14.976,24.13401 2.614,-16.47 4.536,-32.74201 11.618,-48.05401 z"
+     id="path33"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 376.03775,568.21174 c 3.14,-7.134 6.892,-14.264 9.44,-21.616 2.51,8.576 3.87,17.374 5.73,26.102 -4.388,-1.97 -13.234,-3.4 -15.17,-4.486 z"
+     id="path34"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 275.34775,508.34373 c 7.554,3.424 15.174,6.414 23.054,9.01 -4.348,3.636 -8.422,7.43801 -12.466,11.40401 -1.992,-3.07 -5.034,-6.59401 -6.57,-9.84601 -1.538,-3.544 -3.406,-6.704 -4.018,-10.568 z"
+     id="path35"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 580.81575,378.64171 c 0.174,4.016 1.316,11.12 -0.142,14.692 l -1.322,0.664 c -8.51,-1.606 -16.614,-3.178 -25.25,-4.102 8.398,-6.016 16.886,-8.52 26.714,-11.254 z"
+     id="path36"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 554.10175,411.69971 c 8.586,-2.24 17.924,-2.716 26.714,-4 0.428,4.816 0.606,10.62001 0,15.40801 -8.872,-2.66 -19.79,-5.044 -26.714,-11.40801 z"
+     id="path37"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 413.80575,549.08374 c 5.198,7.878 7.314,17.22 11.038,25.82 -3.228,-0.058 -14.524,1.172 -16.482,0 1.018,-8.646 2.216,-17.686 5.444,-25.82 z"
+     id="path38"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 526.91575,484.43773 c 9.316,1.67 19.154,5.096 27.98,8.488 -2.766,4.198 -5.424,8.452 -8.062,12.73 -7.26,-6.506 -15.232,-12.516 -19.918,-21.218 z"
+     id="path39"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 549.10575,437.25572 c 9.318,-0.64 18.79,-0.084 28.128,0 -0.862,5.382 -1.694,10.842 -3.742,15.924 -8.43,-5.086 -16.78,-9.56 -24.386,-15.924 z"
+     id="path40"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 439.73175,543.29174 1.36,1.452 c 6.326,6.73 9.89,15.802 15.036,23.468 -5.37,1.882 -11.066,2.43 -16.396,4.486 z"
+     id="path41"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 539.67175,462.21972 c 9.972,-0.004 19.626,1.052 29.512,2.254 -0.442,4.27201 -3.664,10.89601 -6.116,14.42401 -8.166,-3.222 -17.172,-10.556 -23.396,-16.67801 z"
+     id="path42"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 488.88575,521.69573 c 7.732,3.84201 19.168,12.47201 24.35,19.25201 -4.794,2.344 -9.02,6.04 -13.816,8.136 -4.688,-8.85 -7.936,-17.748 -10.534,-27.38801 z"
+     id="path43"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 509.94175,505.65573 c 5.494,1.07 8.69,2.82 13.364,5.902 5.104,1.702 8.644,4.112 12.892,7.354 -0.812,1.354 -10.158,11.70601 -11.41,12.74801 -2.844,-4.58 -6.188,-9.33401 -8.274,-14.30601 -2.536,-3.532 -4.474,-7.872 -6.572,-11.698 z"
+     id="path44"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 465.35375,533.92774 c 7.502,6.24 15.294,15.644 19.998,24.154 -5.336,1.804 -10.23,3.636 -15.1,6.486 -3.214,-9.588 -4.238,-20.568 -4.898,-30.64 z"
+     id="path45"
+     style="stroke-width:2" />
+  <path
+     fill="#2356ae"
+     d="M 351.39175,758.48578 C 168.77575,730.12777 41.748945,587.64375 38.358945,403.44571 34.725145,206.00568 197.09775,42.52665 394.25175,39.316449 c 199.908,-3.255 364.866,156.319231 367.572,354.681261 -6.094,-4.58 -18.174,-19.598 -24.91,-26.196 -36.444,-35.69001 -72.076,-72.23002 -107.964,-108.48002 -5.912,-5.854 -23.126,-25.17801 -28.692,-29.00401 -3.034,-2.352 -5.59,-5.25 -8.21,-8.044 -6.464,-8.496 -15.426,-15.704 -22.864,-23.372 -34.426,-27.95001 -82.38,-53.60801 -126.896,-61.38602 -2.586,-0.374 -5.316,-0.164 -7.914,0 -18.072,-0.934 -32.114,10.64001 -48.896,14.09201 43.72,19.62 46.344,31.682 19.526,73.22601 v 0 c -1.554,2.762 -3.848,7.304 -4.686,10.42 l -0.256,0.984 -0.8,0.356 c -0.148,-6.828 6.032,-14.334 5.742,-19.654 3.41,-15.986 -69.354,5.438 -83.98,12.018 -112.918,50.79001 -146.822,194.80204 -68.622,289.88605 2.912,3.538 9.012,12.78601 14.01,12.81601 5.634,0.72 11.242,1.612 16.884,2.268 -0.202,-4.49 -5.588,-11.15401 -7.948,-15.01601 l 0.744,-0.738 c 0.012,-2.102 -1.516,-3.748 -1.268,-5.77 l 0.892,-0.308 c 1.028,2.482 1.052,5.254 3.65,6.816 1.536,3.252 4.578,6.77601 6.57,9.84601 4.044,-3.966 8.118,-7.76801 12.466,-11.40401 1.258,-0.768 2.186,-1.952 3.172,-3.032 1.292,-8.566 1.428,-17.722 1.922,-26.378 -0.138,-1.118 -0.616,-2.868 -0.238,-3.908 l 1.168,0.966 -0.246,-0.612 -0.924,0.544 1.134,-0.23 c 3.66,6.196 9.036,11.464 13.456,17.124 20.682,-19.848 -7.462,-45.92001 -22.146,-59.30801 8.322,2.714 22.978,21.546 26.672,29.42201 2.368,5.048 2.81,14.832 4.236,17.488 3.938,-9.238 -6.242,-21.60201 -4.594,-23.16201 6.228,12.53801 9.19,23.92001 0,35.56001 -11.034,9.136 -29.284,21.156 -36.122,33.99601 -15.95,29.946 -3.004,58.48801 7.948,85.92401 1.766,3.338 5.028,8.098 5.668,11.75001 h -1.106 l -7.45,-10.00201 c -1.728,-2.178 -3.5,-4.33 -5.016,-6.664 -6.324,-4.728 -13.836,-10.324 -21.092,-13.49 -1.626,-0.89 -3.196,-1.934 -4.78,-2.904 -1.312,-1.568 -4.878,-2.91 -6.762,-3.614 -4.274,-4.488 -9.078,-8.416 -13.794,-12.424 -3.644,-3.258 -7.338,-6.40601 -11.126,-9.49601 -9.516,-10.912 -20.848,-17.964 -34.05,-23.62 -3.398,0.208 -6.702,-1.566 -10.05,-2.2 0.09,1.694 0.138,3.308 0,5 0.146,1.304 0.434,2.74 0,3.998 -6.198,-2.672 -19.392,-5.09 -26.25,-6.798 -4.648,-2.816 -18.714,-10.192 -23.586,-10.336 4.584,5.41 10.284,9.738 14.854,15.058 7.016,12.05 42.298,43.51801 53.304,54.48401 l 117.162,117.50802 c 7.714,7.722 27.054,23.83601 31.626,30.48801 z"
+     id="path46"
+     style="stroke-width:2" />
+  <path
+     fill="#132b6d"
+     d="m 179.65375,204.78568 0.312,-1.174 0.54,0.326 c 1.66,8.908 0.01,23.462 3.776,31.23 -0.946,2.464 -0.94,5.09 -2.088,7.614 -0.896,-7.214 -1.61,-14.446 -2.54,-21.656 -0.13,-5.46 -0.212,-10.878 0,-16.34 z"
+     id="path47"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 125.81775,276.75769 c 2.17,11.74 9.116,22.444 12.934,33.79201 l -0.57,0.518 c -1.16,-3.654 -7.662,-20.46601 -9.84,-22.36001 l -0.976,0.068 c -1.38,1.692 -2.846,2.256 -4.866,3.024 -2.616,6.924 -1.898,24.47801 -3.168,33.15201 -0.472,-15.43 -0.356,-34.15801 6.486,-48.19401 z"
+     id="path48"
+     style="stroke-width:2" />
+  <path
+     fill="#132b6d"
+     d="m 274.23575,141.76967 c -2.074,7.182 -3.328,13.142 -2.998,20.634 -4.176,2.324 -7.592,4.762 -11.174,7.91 v -2.354 c 1.878,-6.262 2.766,-12.768 4.78,-19.034 3.524,-1.72 6.27,-4.824 9.392,-7.156 z"
+     id="path49"
+     style="stroke-width:2" />
+  <path
+     fill="#132b6d"
+     d="m 371.74975,108.36966 c -3.86,7.4 -7.354,14.524 -9.404,22.688 v 0 c -3.648,0.82 -7.228,1.122 -10.954,1.38 4.392,-6.38 5.642,-13.5 10.954,-19.87 l 1.312,1.376 c 2.71,-0.242 5.8,-4.024 8.092,-5.574 z"
+     id="path50"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 268.33575,131.05766 c -1.042,5.972 -2.31,11.92001 -3.492,17.86801 -2.014,6.266 -2.902,12.772 -4.78,19.034 -1.326,-4.864 3.318,-9.734 1.244,-14.208 -22.57,-10.084 -17.62,14.712 -26.708,18.13 6.172,-15.816 20.434,-30.548 33.736,-40.82401 z"
+     id="path51"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 179.65375,196.07968 c -0.244,2.936 -0.14,5.77 0,8.706 -0.212,5.462 -0.13,10.88 0,16.34 -2.87,1.676 -3.574,6.084 -4.174,9.192 -1.636,3.874 -3.642,7.834 -4.67,11.914 l -0.244,0.106 0.41,-0.728 -0.192,-0.106 c 2.75,-11.394 5.076,-8.03 -4.17,-11.186 -1.178,2.228 -4.1,9.672 -5.944,10.542 4.934,-15.602 12.448,-29.868 18.984,-44.78 z"
+     id="path52"
+     style="stroke-width:2" />
+  <path
+     fill="#132b6d"
+     d="m 456.12775,109.52166 c 3.564,1.658 10.414,-0.138 14.124,-1.152 -9.878,8.046 -21.92,17.846 -27.964,29.146 -2.586,-0.374 -5.316,-0.164 -7.914,0 l -6.334,-3.096 c 7.916,-6.85 14.976,-14.806 22.762,-21.852 1.752,-1.066 3.52,-2.074 5.326,-3.046 z"
+     id="path53"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 100.50375,364.60771 c 8.122,7.8 22.772,25.956 30.762,31.252 0.936,5.038 2.374,10.71 2.462,15.774 -12.286,-9.396 -17.796,-19.394 -28.126,-27.642 0.096,1.026 0.082,1.858 -0.212,2.84 -2.522,-7.432 -3.886,-14.462 -4.886,-22.224 z"
+     id="path54"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 96.515745,442.51972 c 8.566005,4.34 36.750005,23.486 42.236005,30.46001 l 0.276,0.808 c 6.398,2.844 8.096,8.69 8.058,15.766 l -0.588,-0.544 c -1.434,-1.32 -10.678,-7.62 -12.052,-7.594 -5.946,-3.566 -23.722,-21.69601 -29.056,-20.70801 -3.03,-6.03 -5.978005,-12.092 -8.874005,-18.188 z"
+     id="path55"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 121.77975,525.87374 c 19.42,6.36 38.498,14.12 57.874,20.722 l 0.548,0.758 1.826,-0.056 c 1.258,1.488 1.388,4.868 2.254,6.786 0.146,1.304 0.434,2.74 0,3.998 -6.198,-2.672 -19.392,-5.09 -26.25,-6.798 -4.648,-2.816 -18.714,-10.192 -23.586,-10.336 -4.45,-4.812 -8.812,-9.764 -12.666,-15.074 z"
+     id="path56"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 271.23775,162.40367 c 7.99,-6.254 18.884,-10.416 28.25,-14.234 16.76,-6.832 13.44,-7.376 25.658,-19.48401 10.768,-10.672 29.362,-23.208 44.058,-28.062 -2.508,3.886 -5.042,7.672 -6.858,11.944 -5.312,6.37 -6.562,13.49 -10.954,19.87 -0.974,1.678 -1.832,2.932 -3.262,4.254 l -0.532,-0.056 c 0.956,-3.102 4.54,-2.84 3.518,-6.662 l -2.128,-2.174 c -8.514,3.742 -77.504,34.61201 -77.75,34.60401 z"
+     id="path57"
+     style="stroke-width:2" />
+  <defs
+     id="defs58">
+    <linearGradient
+       id="gradient_5"
+       gradientUnits="userSpaceOnUse"
+       x1="145.13785"
+       y1="328.17804"
+       x2="117.22018"
+       y2="280.89636"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#D79A18"
+         id="stop57" />
+      <stop
+         offset="1"
+         stop-color="#F6C842"
+         id="stop58" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_5)"
+     d="m 105.38975,460.70772 c 5.334,-0.988 23.11,17.14201 29.056,20.70801 4.286,3.456 9.396,6.13 13.392,9.86 0.278,-2.39 0.424,-4.632 1.462,-6.838 l 0.504,-0.106 c 0.058,-0.954 -0.086,-7.128 0.79,-5.038 1.712,4.084 3.956,1.936 4.492,8.664 l 0.486,-0.014 c 2.38,7.206 8.172,8.99 13.068,13.884 l -0.348,0.398 c 2.612,0.138 4.874,0.24 7.188,1.558 0.816,0.698 1.66,1.344 2.532,1.97 l 0.462,1.048 c -1.04,0.308 -0.606,0.28 -1.274,0.272 3.704,0.932 3.808,4.058 4.994,7.248 v 0 c 2.772,3.696 5.17,7.268 6.946,11.55201 -1.732,-0.248 -24.262,-10.67601 -16.892,-1.472 2.482,3.098 5.226,7.084 8.34,9.526 2.636,1.906 4.292,5.756 7.29,7.02 h 1.262 l -1.262,2.344 c 0.818,1.872 1.938,2.472 3.716,3.304 l -0.66,0.048 c -2.968,0.184 -9.982,-2.572 -6.652,2.44 0.09,1.694 0.138,3.308 0,5 -0.866,-1.918 -0.996,-5.298 -2.254,-6.786 l -1.826,0.056 -0.548,-0.758 c -0.52,-3.778 -6.05,-8.072 -8.808,-10.5 -24.584,-13.75401 -54.27,-50.32801 -65.456,-75.38802 z"
+     id="path58"
+     style="fill:url(#gradient_5);stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 170.84575,536.09574 c 0.178,0.002 16.806,6.982 17.032,7.196 0.818,1.872 1.938,2.472 3.716,3.304 l -0.66,0.048 c -2.968,0.184 -9.982,-2.572 -6.652,2.44 0.09,1.694 0.138,3.308 0,5 -0.866,-1.918 -0.996,-5.298 -2.254,-6.786 l -1.826,0.056 -0.548,-0.758 c -0.52,-3.778 -6.05,-8.072 -8.808,-10.5 z"
+     id="path59"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 182.19375,514.32173 c -5.22,-0.312 -16.074,-7.81 -20,-10.892 -0.398,-0.312 -4.628,-3.938 -2.568,-3.994 4.124,-0.114 11.04,6.52 14.26,8.908 0.87,-0.988 2.086,-1.036 3.314,-1.27 3.704,0.932 3.808,4.058 4.994,7.248 z"
+     id="path60"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 177.19975,507.07373 c 3.704,0.932 3.808,4.058 4.994,7.248 -2.664,-2.118 -5.5,-4.052 -8.308,-5.978 0.87,-0.988 2.086,-1.036 3.314,-1.27 z"
+     id="path61"
+     style="stroke-width:2" />
+  <defs
+     id="defs62">
+    <linearGradient
+       id="gradient_6"
+       gradientUnits="userSpaceOnUse"
+       x1="238.76126"
+       y1="143.77654"
+       x2="270.52316"
+       y2="95.432106"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#FAD84F"
+         id="stop61" />
+      <stop
+         offset="1"
+         stop-color="#FFF5A9"
+         id="stop62" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_6)"
+     d="m 362.34575,131.05766 c 26.81,-3.184 19.722,-1.768 42.234,-13.04 19.684,-9.856 41.194,-16.094 63.324,-15.652 -4.056,2.182 -8.086,4.39 -11.776,7.156 -1.806,0.972 -3.574,1.98 -5.326,3.046 -7.786,7.046 -14.846,15.002 -22.762,21.852 l 6.334,3.096 c -18.072,-0.934 -32.114,10.64001 -48.896,14.09201 -3.1,0.442 -6.45,0.35 -9.44,1.264 -3.958,1.83 -9.35,-0.016 -13.526,1.328 l -0.166,0.49 c 4.412,1.276 9.87,1.98 13.692,4.562 -11.014,0.822 -21.384,-2.856 -32.396,-2.412 -0.74,-0.772 -5.22,0.294 -7.562,-0.282 l 0.286,-0.044 c -8.446,-2.598 -0.096,-4.918 2.406,-7.588 6.796,-3.554 22.95,-8.952 23.574,-17.86801 z"
+     id="path62"
+     style="fill:url(#gradient_6);stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 341.76375,151.60767 c 11.034,-5.176 26.9,-6.422 39.114,-7.498 -2.7,3.496 -6.968,3.658 -4.84,8.762 -3.958,1.83 -9.35,-0.016 -13.526,1.328 l -0.166,0.49 c -4.888,-1.222 -8.504,-1.066 -13.358,0 -2.746,0.4 -8.482,-0.994 -10.622,-2.552 l 0.184,-0.502 -0.088,0.422 0.506,-0.548 z"
+     id="path63"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 424.84375,132.43766 c 9.142,-6.23 14.826,-16.674 25.958,-19.87 -7.786,7.046 -14.846,15.002 -22.762,21.852 l 6.334,3.096 c -18.072,-0.934 -32.114,10.64001 -48.896,14.09201 -3.1,0.442 -6.45,0.35 -9.44,1.264 -2.128,-5.104 2.14,-5.266 4.84,-8.762 8.736,-2.842 14.512,-8.95201 24.126,-9.69001 2.98,-2.124 16.504,-3.504 19.84,-1.982 z"
+     id="path64"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 405.00375,134.41966 c 2.98,-2.124 16.504,-3.504 19.84,-1.982 -3.412,3.298 -15.364,2.648 -19.84,1.982 z"
+     id="path65"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 348.98775,127.79966 2.128,2.174 c 1.022,3.822 -2.562,3.56 -3.518,6.662 l 0.532,0.056 c 1.43,-1.322 2.288,-2.576 3.262,-4.254 3.726,-0.258 7.306,-0.56 10.954,-1.38 -0.624,8.91601 -16.778,14.31401 -23.574,17.86801 -7.41,2.68 -9.978,8.094 -16.164,11.038 -3.652,1.74 -27.878,3.596 -21.164,11.206 l -1.672,0.284 6.764,0.428 c -13.404,2.41 -17.64,4.718 -29.284,7.922 6.38,1.602 10.798,-2.57 18.448,0.768 h 2.702 l -0.042,1.276 c -7.05,4.88 -18.516,5.498 -27.53,13.56001 -1.344,1.2 -2.83,2.678 -4.418,3.494 -4.23,1.326 -8.724,2.754 -13.11,3.378 -1.89,1.25 -12.68,4.234 -15.272,4.588 v 0 -2.082 l -2.28,-3.718 c -4.61,0.068 -7.042,12.34 -7.368,15.872 -8.018,0.742 -11.65,9.846 -16.818,14.858 -3.88,-1.22 -4.476,2.806 -6.472,5.164 -1.86,1.146 -4.982,3.384 -5.056,5.82 1.124,1.468 1.626,2.97 2.234,4.704 v 0 c -0.316,5.61801 1.456,4.99401 6.442,4.89801 -1.14,1.822 -2.366,3.564 -3.62,5.31 -1.95,2.246 -3.464,4.796 -5.056,7.3 -3.182,5.058 -6.5,9.462 -10.092,14.184 l -0.804,0.272 c -2.854,3.482 -4.438,8.244 -6.946,12.09 0.062,-2.884 0.094,-5.748 0,-8.632 -0.152,-5.29 -0.606,-10.77 0,-16.034 -4.278,6.658 -7.876,14.308 -9.904,21.966 l -0.172,-0.658 c -0.69,-2.716 -0.326,-5.508 -1.658,-8.056 -2.812,3.078 -0.546,7.956 -1.82,11.414 -2.326,1.824 -3.704,3.838 -4.96,6.498 0.362,13.11001 -0.04,26.34401 -0.64,39.44401 -2.058,-8.594 -3.944,-31.802 -5.008,-35.10001 -1.466,3.81001 -4.786,9.06401 -5.378,12.93801 -1.004,6.558 0.336,12.898 -1.634,19.682 l -0.152,-2.372 c -1.242,0.97 -0.692,3.5 -1.568,4.852 -0.888,5.956 -6.352,24.62201 -2.024,29.02001 l 1.026,-0.056 c 0.982,-1.328 1.022,-2.274 0.998,-3.888 2.54,11.112 6.984,15.086 6.272,27.338 -4.292,-5.588 -5.538,-12.7 -9.37,-18.494 -3.122,10.1 -3.688,19.896 -1.048,30.034 0.382,1.46 5.496,9.346 2.684,9.412 -1.922,-1.014 -3.814,-2.066 -5.696,-3.148 v 6.18601 l 5.696,5.592 -0.786,0.856 c 0.296,2.89 2.728,6.41 -0.85,8.024 -1.37,-0.752 -2.74,-1.49 -4.06,-2.326 1.508,3.706 4.194,6.776 5.696,10.326 -5.51,8.998 8.018,9.652 6.644,16.822 -2.168,-1.12 -4.022,-2.238 -6.51,-2.394 l -0.58,0.476 c 1.212,3.574 5.104,5.87 8.18,7.788 l 0.106,0.944 c 2.112,1.702 5.154,3.652 6.672,5.856 l -0.092,0.576 c -1.6,-0.072 -10.62,-4.306 -6.686,-0.158 3.098,4.66401 7.5,8.32001 11.042,12.63001 1.028,1.378 2.036,2.636 2.66,4.248 l -0.342,0.572 c -2.3,-0.9 -3.438,-2.91 -5.976,-3.28 2.058,3.032 5.576,4.756 7.89,7.506 -6.846,-3.492 -13.43,-7.156 -19.826,-11.44 1.408,2.746 2.824,5.372 4.552,7.934 -0.206,1.33 -0.332,2.17 0,3.506 l -0.486,0.014 c -0.536,-6.728 -2.78,-4.58 -4.492,-8.664 -0.876,-2.09 -0.732,4.084 -0.79,5.038 l -0.504,0.106 c -1.038,2.206 -1.184,4.448 -1.462,6.838 -3.996,-3.73 -9.106,-6.404 -13.392,-9.86 1.374,-0.026 10.618,6.274 12.052,7.594 l 0.588,0.544 c 0.038,-7.076 -1.66,-12.922 -8.058,-15.766 l -0.276,-0.808 c 1.184,0.176 3.7,2.69 4.754,3.524 -1.57,-16.19201 -6.668,-17.95401 -15.372,-31.30601 -8.38,-12.854 -23.376,-43.43601 -22.744,-58.36601 0.294,-0.982 0.308,-1.814 0.212,-2.84 10.33,8.248 15.84,18.246 28.126,27.642 -0.088,-5.064 -1.526,-10.736 -2.462,-15.774 0.614,-23.334 -11.684,-42.03401 -11.934,-70.90801 1.27,-8.674 0.552,-26.22801 3.168,-33.15201 2.02,-0.768 3.486,-1.332 4.866,-3.024 l 0.976,-0.068 c 2.178,1.894 8.68,18.70601 9.84,22.36001 l 0.57,-0.518 c 1.386,0.9 2.382,2.54 3.39,3.858 1.862,-13.02001 6.618,-19.94201 9.452,-31.46801 3.608,-14.66 3.426,-26.278 9.076,-42.08001 1.844,-0.87 4.766,-8.314 5.944,-10.542 9.246,3.156 6.92,-0.208 4.17,11.186 l 0.192,0.106 -0.41,0.728 0.244,-0.106 c 1.028,-4.08 3.034,-8.04 4.67,-11.914 0.6,-3.108 1.304,-7.516 4.174,-9.192 0.93,7.21 1.644,14.442 2.54,21.656 1.148,-2.524 1.142,-5.15 2.088,-7.614 8.798,-9.326 16.32,-19.906 24.89,-29.486 4.756,-5.318 10.938,-9.912 15.132,-15.63401 4.15,-5.656 5.632,-12.712 10.296,-18.166 9.088,-3.418 4.138,-28.214 26.708,-18.13 2.074,4.474 -2.57,9.344 -1.244,14.208 v 2.354 c 3.582,-3.148 6.998,-5.586 11.174,-7.91 v 0 c 0.246,0.008 69.236,-30.86201 77.75,-34.60401 z"
+     id="path66"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 182.19375,266.87369 c 0.564,-0.782 2.61,-7.412 3.094,-3.452 0.322,2.642 1.102,21.51 -3.094,19.486 -0.152,-5.29 -0.606,-10.77 0,-16.034 z"
+     id="path67"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 125.81775,310.5497 c 2.45,2.318 5.498,11.792 7.544,15.398 2.698,4.748 6.998,5.738 5.39,11.534 l -0.768,0.906 -0.92,-0.342 c -4.658,-6.078 -8.65,-19.842 -11.246,-27.496 z"
+     id="path68"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 238.02975,204.78568 c 5.564,-5.62 15.092,-21.80401 23.426,-22.17401 -1.03,1.272 -5.95,6.208 -5.208,7.716 -1.792,1.966 -4.054,3.62801 -5.628,5.75201 -3.67,1.584 -4.516,5.316 -6.108,8.706 2.69,-0.91 5.97,-2.338 8.79,-2.506 -1.89,1.25 -12.68,4.234 -15.272,4.588 v 0 z"
+     id="path69"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 295.69975,180.57167 h 2.702 c -8.5,7.116 -21.784,5.136 -31.99,7.612 -3.338,1.062 -6.97,1.058 -10.164,2.144 -0.742,-1.508 4.178,-6.444 5.208,-7.716 1.96,-1.942 7.53,-0.964 9.782,0 8.094,-2.064 16.232,-1.644 24.462,-2.04 z"
+     id="path70"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 261.45575,182.61167 c 1.96,-1.942 7.53,-0.964 9.782,0 -9.012,0.558 -6.586,5.252 -4.826,5.572 -3.338,1.062 -6.97,1.058 -10.164,2.144 -0.742,-1.508 4.178,-6.444 5.208,-7.716 z"
+     id="path71"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 200.03575,242.78168 c 1.124,1.468 1.626,2.97 2.234,4.704 v 0 c -0.316,5.61801 1.456,4.99401 6.442,4.89801 -1.14,1.822 -2.366,3.564 -3.62,5.31 -1.95,2.246 -3.464,4.796 -5.056,7.3 -3.182,5.058 -6.5,9.462 -10.092,14.184 l -0.804,0.272 c 0.992,-2.136 -0.112,-2.814 -0.734,-4.852 -1.902,-6.224 8.246,-26.224 11.63,-31.81601 z"
+     id="path72"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 202.26975,247.48568 v 0 c -0.316,5.61801 1.456,4.99401 6.442,4.89801 -1.14,1.822 -2.366,3.564 -3.62,5.31 -1.95,2.246 -3.464,4.796 -5.056,7.3 -0.992,-6.32 1.244,-11.428 2.234,-17.50801 z"
+     id="path73"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 298.40175,180.57167 -0.042,1.276 c -7.05,4.88 -18.516,5.498 -27.53,13.56001 -1.344,1.2 -2.83,2.678 -4.418,3.494 -4.23,1.326 -8.724,2.754 -13.11,3.378 -2.82,0.168 -6.1,1.596 -8.79,2.506 1.592,-3.39 2.438,-7.122 6.108,-8.706 1.574,-2.124 3.836,-3.78601 5.628,-5.75201 3.194,-1.086 6.826,-1.082 10.164,-2.144 10.206,-2.476 23.49,-0.496 31.99,-7.612 z"
+     id="path74"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 271.23775,193.48968 c -1.194,1.158 -4.558,3.824 -4.826,5.412 -4.23,1.326 -8.724,2.754 -13.11,3.378 -2.82,0.168 -6.1,1.596 -8.79,2.506 1.592,-3.39 2.438,-7.122 6.108,-8.706 6.902,-0.504 13.82,-1.276 20.618,-2.59 z"
+     id="path75"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 149.29975,466.26772 c -9.304,-9.342 -10.01,-43.218 -10.518,-57.68401 -0.538,-15.364 -1.234,-63.88401 4.522,-71.25001 l 0.256,0.428 -0.55,-0.498 c 0.858,0.034 1.536,1.384 3.084,1.57 -0.638,1.076 -2.192,1.04 -2.766,2.208 -3.374,6.87 -7.36,60.42401 -3.304,71.67401 l 1.144,0.50401 0.542,-0.48001 c -0.028,-1.786 0.016,-3.3 0.432,-5.04 v 6.18601 l 5.696,5.592 -0.786,0.856 c 0.296,2.89 2.728,6.41 -0.85,8.024 -1.37,-0.752 -2.74,-1.49 -4.06,-2.326 1.508,3.706 4.194,6.776 5.696,10.326 -5.51,8.998 8.018,9.652 6.644,16.822 -2.168,-1.12 -4.022,-2.238 -6.51,-2.394 l -0.58,0.476 c 1.212,3.574 5.104,5.87 8.18,7.788 l 0.106,0.944 c 2.112,1.702 5.154,3.652 6.672,5.856 l -0.092,0.576 c -1.6,-0.072 -10.62,-4.306 -6.686,-0.158 3.098,4.66401 7.5,8.32001 11.042,12.63001 1.028,1.378 2.036,2.636 2.66,4.248 l -0.342,0.572 c -2.3,-0.9 -3.438,-2.91 -5.976,-3.28 2.058,3.032 5.576,4.756 7.89,7.506 -6.846,-3.492 -13.43,-7.156 -19.826,-11.44 1.408,2.746 2.824,5.372 4.552,7.934 -0.206,1.33 -0.332,2.17 0,3.506 l -0.486,0.014 c -0.536,-6.728 -2.78,-4.58 -4.492,-8.664 -0.876,-2.09 -0.732,4.084 -0.79,5.038 l -0.504,0.106 c 0.334,-4.398 -0.07,-7.204 1.72,-11.458 -1.008,-2.202 -1.76,-4.234 -1.72,-6.71201 z"
+     id="path76"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 149.29975,466.26772 c 2.55,1.562 4.34,4.17401 5.39,6.94401 l -0.242,0.898 c -1.33,0.158 -2.298,-0.53 -3.428,-1.13 -1.008,-2.202 -1.76,-4.234 -1.72,-6.71201 z"
+     id="path77"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 234.59975,171.88167 c 9.088,-3.418 4.138,-28.214 26.708,-18.13 2.074,4.474 -2.57,9.344 -1.244,14.208 v 2.354 c -1.148,1.816 -5.864,3.458 -7.922,4.874 -14.14,9.736 -15.23,14.912 -24.894,26.40001 -6.982,8.3 -15.26,15.5 -22.134,23.932 -11.878,14.576 -27.774,39.38201 -41.434,51.23801 0.79,-11.36 12.096,-43.94801 11.8,-46.44001 0.6,-3.108 1.304,-7.516 4.174,-9.192 0.93,7.21 1.644,14.442 2.54,21.656 1.148,-2.524 1.142,-5.15 2.088,-7.614 8.798,-9.326 16.32,-19.906 24.89,-29.486 4.756,-5.318 10.938,-9.912 15.132,-15.63401 4.15,-5.656 5.632,-12.712 10.296,-18.166 z"
+     id="path78"
+     style="stroke-width:2" />
+  <path
+     fill="#bf8a24"
+     d="m 306.53575,171.88167 -6.764,-0.428 1.672,-0.284 c -6.714,-7.61 17.512,-9.466 21.164,-11.206 6.186,-2.944 8.754,-8.358 16.164,-11.038 -2.502,2.67 -10.852,4.99 -2.406,7.588 l -0.286,0.044 c 2.342,0.576 6.822,-0.49 7.562,0.282 11.012,-0.444 21.382,3.234 32.396,2.412 -3.822,-2.582 -9.28,-3.286 -13.692,-4.562 l 0.166,-0.49 c 4.176,-1.344 9.568,0.502 13.526,-1.328 2.99,-0.914 6.34,-0.822 9.44,-1.264 43.72,19.62 46.344,31.682 19.526,73.22601 v 0 c -1.554,2.762 -3.848,7.304 -4.686,10.42 l -0.256,0.984 -0.8,0.356 c -0.148,-6.828 6.032,-14.334 5.742,-19.654 3.41,-15.986 -69.354,5.438 -83.98,12.018 -112.918,50.79001 -146.822,194.80204 -68.622,289.88605 2.912,3.538 9.012,12.78601 14.01,12.81601 5.634,0.72 11.242,1.612 16.884,2.268 -0.202,-4.49 -5.588,-11.15401 -7.948,-15.01601 l 0.744,-0.738 c 0.012,-2.102 -1.516,-3.748 -1.268,-5.77 l 0.892,-0.308 c 1.028,2.482 1.052,5.254 3.65,6.816 1.536,3.252 4.578,6.77601 6.57,9.84601 4.044,-3.966 8.118,-7.76801 12.466,-11.40401 1.258,-0.768 2.186,-1.952 3.172,-3.032 1.292,-8.566 1.428,-17.722 1.922,-26.378 -0.138,-1.118 -0.616,-2.868 -0.238,-3.908 l 1.168,0.966 -0.246,-0.612 -0.924,0.544 1.134,-0.23 c 3.66,6.196 9.036,11.464 13.456,17.124 20.682,-19.848 -7.462,-45.92001 -22.146,-59.30801 8.322,2.714 22.978,21.546 26.672,29.42201 2.368,5.048 2.81,14.832 4.236,17.488 3.938,-9.238 -6.242,-21.60201 -4.594,-23.16201 6.228,12.53801 9.19,23.92001 0,35.56001 -11.034,9.136 -29.284,21.156 -36.122,33.99601 -15.95,29.946 -3.004,58.48801 7.948,85.92401 1.766,3.338 5.028,8.098 5.668,11.75001 h -1.106 l -7.45,-10.00201 c -1.728,-2.178 -3.5,-4.33 -5.016,-6.664 -6.324,-4.728 -13.836,-10.324 -21.092,-13.49 -1.626,-0.89 -3.196,-1.934 -4.78,-2.904 -1.312,-1.568 -4.878,-2.91 -6.762,-3.614 -4.274,-4.488 -9.078,-8.416 -13.794,-12.424 -3.644,-3.258 -7.338,-6.40601 -11.126,-9.49601 -9.516,-10.912 -20.848,-17.964 -34.05,-23.62 -3.398,0.208 -6.702,-1.566 -10.05,-2.2 -3.33,-5.012 3.684,-2.256 6.652,-2.44 l 0.66,-0.048 c -1.778,-0.832 -2.898,-1.432 -3.716,-3.304 l 1.262,-2.344 h -1.262 c -2.998,-1.264 -4.654,-5.114 -7.29,-7.02 -3.114,-2.442 -5.858,-6.428 -8.34,-9.526 -7.37,-9.20401 15.16,1.224 16.892,1.472 -1.776,-4.28401 -4.174,-7.85601 -6.946,-11.55201 v 0 c -1.186,-3.19 -1.29,-6.316 -4.994,-7.248 0.668,0.008 0.234,0.036 1.274,-0.272 l -0.462,-1.048 c -0.872,-0.626 -1.716,-1.272 -2.532,-1.97 -2.314,-1.318 -4.576,-1.42 -7.188,-1.558 l 0.348,-0.398 c -4.896,-4.894 -10.688,-6.678 -13.068,-13.884 -0.332,-1.336 -0.206,-2.176 0,-3.506 -1.728,-2.562 -3.144,-5.188 -4.552,-7.934 6.396,4.284 12.98,7.948 19.826,11.44 -2.314,-2.75 -5.832,-4.474 -7.89,-7.506 2.538,0.37 3.676,2.38 5.976,3.28 l 0.342,-0.572 c -0.624,-1.612 -1.632,-2.87 -2.66,-4.248 -3.542,-4.31 -7.944,-7.966 -11.042,-12.63001 -3.934,-4.148 5.086,0.086 6.686,0.158 l 0.092,-0.576 c -1.518,-2.204 -4.56,-4.154 -6.672,-5.856 l -0.106,-0.944 c -3.076,-1.918 -6.968,-4.214 -8.18,-7.788 l 0.58,-0.476 c 2.488,0.156 4.342,1.274 6.51,2.394 1.374,-7.17 -12.154,-7.824 -6.644,-16.822 -1.502,-3.55 -4.188,-6.62 -5.696,-10.326 1.32,0.836 2.69,1.574 4.06,2.326 3.578,-1.614 1.146,-5.134 0.85,-8.024 l 0.786,-0.856 -5.696,-5.592 v -6.18601 c 1.882,1.082 3.774,2.134 5.696,3.148 2.812,-0.066 -2.302,-7.952 -2.684,-9.412 -2.64,-10.138 -2.074,-19.934 1.048,-30.034 3.832,5.794 5.078,12.906 9.37,18.494 0.712,-12.252 -3.732,-16.226 -6.272,-27.338 0.024,1.614 -0.016,2.56 -0.998,3.888 l -1.026,0.056 c -4.328,-4.398 1.136,-23.06401 2.024,-29.02001 0.876,-1.352 0.326,-3.882 1.568,-4.852 l 0.152,2.372 c 1.97,-6.784 0.63,-13.124 1.634,-19.682 0.592,-3.874 3.912,-9.128 5.378,-12.93801 1.064,3.29801 2.95,26.50601 5.008,35.10001 0.6,-13.1 1.002,-26.334 0.64,-39.44401 1.256,-2.66 2.634,-4.674 4.96,-6.498 1.274,-3.458 -0.992,-8.336 1.82,-11.414 1.332,2.548 0.968,5.34 1.658,8.056 l 0.172,0.658 c 2.028,-7.658 5.626,-15.308 9.904,-21.966 -0.606,5.264 -0.152,10.744 0,16.034 0.094,2.884 0.062,5.748 0,8.632 2.508,-3.846 4.092,-8.608 6.946,-12.09 l 0.804,-0.272 c 3.592,-4.722 6.91,-9.126 10.092,-14.184 1.592,-2.504 3.106,-5.054 5.056,-7.3 1.254,-1.746 2.48,-3.488 3.62,-5.31 -4.986,0.096 -6.758,0.72 -6.442,-4.89801 v 0 c -0.608,-1.734 -1.11,-3.236 -2.234,-4.704 0.074,-2.436 3.196,-4.674 5.056,-5.82 1.996,-2.358 2.592,-6.384 6.472,-5.164 5.168,-5.012 8.8,-14.116 16.818,-14.858 0.326,-3.532 2.758,-15.804 7.368,-15.872 l 2.28,3.718 v 2.082 0 c 2.592,-0.354 13.382,-3.338 15.272,-4.588 4.386,-0.624 8.88,-2.052 13.11,-3.378 1.588,-0.816 3.074,-2.294 4.418,-3.494 9.014,-8.06201 20.48,-8.68001 27.53,-13.56001 l 0.042,-1.276 h -2.702 c -7.65,-3.338 -12.068,0.834 -18.448,-0.768 11.644,-3.204 15.88,-5.512 29.284,-7.922 z"
+     id="path79"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 154.48175,356.6817 c 1.552,0.2 3.084,0.076 4.642,0 -0.404,2.63801 -0.692,5.29001 -1.092,7.92601 -1.188,-2.608 -2.544,-5.248 -3.55,-7.92601 z"
+     id="path80"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 159.12375,442.51972 c 0.384,2.614 0.992,5.194 1.546,7.778 -3.03,-2.766 -6.444,-5.21 -9.65,-7.778 l 0.538,0.054 c 2.192,0.234 4.934,1.556 6.996,1.18 z"
+     id="path81"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 175.47975,498.19573 c 0.814,1.764 4.086,6.738 0,5.588 -2.314,-1.318 -4.576,-1.42 -7.188,-1.558 l 0.348,-0.398 c 2.21,-2.024 4.874,-1.53 6.84,-3.632 z"
+     id="path82"
+     style="stroke-width:2" />
+  <path
+     fill="#ad7214"
+     d="m 155.57175,466.26772 c 9.084,-1.716 12.038,4.78201 11.562,12.49601 l -0.52,0.134 c -3.542,-4.31 -7.944,-7.966 -11.042,-12.63001 z"
+     id="path83"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 155.57175,459.04972 c -3.076,-1.918 -6.968,-4.214 -8.18,-7.788 l 0.58,-0.476 c 2.488,0.156 4.342,1.274 6.51,2.394 2.566,1.4 4.326,3.672 6.188,5.87 1.02,1.764 1.71,3.5 2.37,5.424 -2.364,-1.688 -4.912,-4.152 -7.468,-5.424 z"
+     id="path84"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 180.58775,533.92774 c -3.114,-2.442 -5.858,-6.428 -8.34,-9.526 -7.37,-9.20401 15.16,1.224 16.892,1.472 6.636,13.13 -9.994,0.33 -16.85,-2.24 3.11,3.16 6.322,6.268 8.298,10.294 z"
+     id="path85"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 266.41175,531.65974 c 5.634,0.72 11.242,1.612 16.884,2.268 -0.584,3.624 -3.86,8.832 -5.208,12.668 -3.562,-5.308 -7.8,-9.892 -11.676,-14.936 z"
+     id="path86"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 142.14175,426.03172 c 1.32,0.836 2.69,1.574 4.06,2.326 4.29,3.432 12.174,7.82 12.862,13.616 l 0.06,0.546 -0.57,1.234 c -2.062,0.376 -4.804,-0.946 -6.996,-1.18 l -0.538,-0.054 c -1,-2.096 -2.014,-4.15 -3.182,-6.162 -1.502,-3.55 -4.188,-6.62 -5.696,-10.326 z"
+     id="path87"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 142.14175,407.69971 c 1.882,1.082 3.774,2.134 5.696,3.148 3.018,1.372 5.362,4.13001 7.734,6.39601 0.206,2.976 0.198,5.812 0,8.788 -2.638,-2.122 -5.196,-4.312 -7.734,-6.554 l -5.696,-5.592 z"
+     id="path88"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 155.57175,484.43773 c 2.938,2.218 18.9,12.614 19.908,13.758 -1.966,2.102 -4.63,1.608 -6.84,3.632 -4.896,-4.894 -10.688,-6.678 -13.068,-13.884 -0.332,-1.336 -0.206,-2.176 0,-3.506 z"
+     id="path89"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 303.49575,487.94373 c -0.138,-1.118 -0.616,-2.868 -0.238,-3.908 l 1.168,0.966 -0.246,-0.612 -0.924,0.544 1.134,-0.23 c 3.66,6.196 9.036,11.464 13.456,17.124 -2.234,2.422 -5.066,4.484 -7.648,6.516 -1.722,-5.352 -6.16,-14.438 -4.026,-19.786 l -0.84,-0.608 c -0.8,1.028 -0.922,2.05 -1.224,3.294 z"
+     id="path90"
+     style="stroke-width:2" />
+  <path
+     fill="#f1be39"
+     d="m 343.64175,156.83967 c 11.012,-0.444 21.382,3.234 32.396,2.412 v 0 c 2.758,1.782 6.394,1.874 9.44,3.152 -10.682,1.228 -39.754,-2.68 -41.606,-1.904 0.806,1.616 2.88,2.336 4.224,3.502 l -1.41,0.542 0.34,0.15 -1.298,-0.124 c -4.908,-6.008 -9.214,-5.39 -10.248,-6.48 2.774,-0.232 5.512,-0.324 8.162,-1.25 z"
+     id="path91"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 376.03775,152.87167 c 2.99,-0.914 6.34,-0.822 9.44,-1.264 43.72,19.62 46.344,31.682 19.526,73.22601 v 0 c 5.832,-22.874 34.842,-43.05801 -2.732,-64.07601 -11.18,-6.254 -18.164,-10.16 -31.452,-6.352 l -0.424,1.2 -0.404,-0.834 c 3.842,4.244 26.77,7.59 30.22,14.342 -1.308,0.37 -18.904,-9.996 -23.724,-10.5 l -0.45,0.638 v 0 c -3.822,-2.582 -9.28,-3.286 -13.692,-4.562 l 0.166,-0.49 c 4.176,-1.344 9.568,0.502 13.526,-1.328 z"
+     id="path92"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 168.63975,291.53969 c 1.274,-3.458 -0.992,-8.336 1.82,-11.414 1.332,2.548 0.968,5.34 1.658,8.056 l 0.172,0.658 c 2.774,10.994 2.712,19.95201 -1.444,30.43201 -1.604,-9.654 -3.796,-17.92201 -2.206,-27.73201 z"
+     id="path93"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 149.29975,337.4817 c 0.876,-1.352 0.326,-3.882 1.568,-4.852 l 0.152,2.372 c 1.894,5.472 9.814,16.574 8.104,21.68 -1.558,0.076 -3.09,0.2 -4.642,0 -1.126,-2.77 -2.134,-5.716 -3.462,-8.39 -1.878,5.094 -2.658,8.81 -1.72,14.26601 0.024,1.614 -0.016,2.56 -0.998,3.888 l -1.026,0.056 c -4.328,-4.398 1.136,-23.06401 2.024,-29.02001 z"
+     id="path94"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 306.53575,171.88167 -6.764,-0.428 1.672,-0.284 c -6.714,-7.61 17.512,-9.466 21.164,-11.206 6.186,-2.944 8.754,-8.358 16.164,-11.038 -2.502,2.67 -10.852,4.99 -2.406,7.588 l -0.286,0.044 c 2.342,0.576 6.822,-0.49 7.562,0.282 -2.65,0.926 -5.388,1.018 -8.162,1.25 1.034,1.09 5.34,0.472 10.248,6.48 -3.348,-0.918 -27.976,0.078 -32.714,1.348 4.33,2.232 9.916,1.048 14.594,3.258 l 0.012,0.634 c -3.474,2.758 -16.412,2.3 -21.084,2.072 z"
+     id="path95"
+     style="stroke-width:2" />
+  <path
+     fill="#ad7214"
+     d="m 187.87775,540.94774 c 14.452,-1.578 18.17,9.438 25.354,17.744 17.95,20.75601 34.99,32.52001 57.314,46.64401 2.982,1.888 11.55,9.15 14.164,9.758 -0.954,-3.75 -7.964,-27.508 -9.222,-29.136 -2.72,-3.514 -11.288,-7.96801 -15.268,-11.09401 -12.18,-9.558 -46.938,-41.988 -52.316,-57.27201 l 0.808,-0.238 c 9.448,21.46801 48.068,54.83801 66.636,67.04602 1.412,2.178 10.994,29.386 10.588,32.432 -6.324,-4.728 -13.836,-10.324 -21.092,-13.49 -1.626,-0.89 -3.196,-1.934 -4.78,-2.904 -1.312,-1.568 -4.878,-2.91 -6.762,-3.614 -4.274,-4.488 -9.078,-8.416 -13.794,-12.424 -3.644,-3.258 -7.338,-6.40601 -11.126,-9.49601 -9.516,-10.912 -20.848,-17.964 -34.05,-23.62 -3.398,0.208 -6.702,-1.566 -10.05,-2.2 -3.33,-5.012 3.684,-2.256 6.652,-2.44 l 0.66,-0.048 c -1.778,-0.832 -2.898,-1.432 -3.716,-3.304 l 1.262,-2.344 z"
+     id="path96"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 189.13975,540.94774 c 5.534,2.624 11.97,2.904 15.952,8.136 -3.688,-0.196 -7.236,-1.452 -10.76,-2.488 h -2.738 c -1.778,-0.832 -2.898,-1.432 -3.716,-3.304 z"
+     id="path97"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 184.28175,549.08374 c -3.33,-5.012 3.684,-2.256 6.652,-2.44 l 0.66,-0.048 h 2.738 c 3.524,1.036 7.072,2.292 10.76,2.488 1.886,2.01 3.24,4.586 4.692,6.922 -3.318,-1.236 -12.546,-5.238 -15.452,-4.722 v 0 c -3.398,0.208 -6.702,-1.566 -10.05,-2.2 z"
+     id="path98"
+     style="stroke-width:2" />
+  <path
+     fill="#e7aa1f"
+     d="m 184.28175,549.08374 c -3.33,-5.012 3.684,-2.256 6.652,-2.44 l 0.66,-0.048 h 2.738 c -4.344,0.788 -4.744,0.478 -1.17,2.97 l -0.606,-0.004 c -4.844,0.006 -0.282,1.608 1.776,1.722 v 0 c -3.398,0.208 -6.702,-1.566 -10.05,-2.2 z"
+     id="path99"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 228.38175,216.93968 c 0.326,-3.532 2.758,-15.804 7.368,-15.872 l 2.28,3.718 v 2.082 0 c -6.518,12.316 13.27,-2.088 15.158,-2.352 -0.618,2.432 -27.42,25.384 -31.64,31.524 -3.73,5.426 -11.42,18.06801 -16.456,21.65401 1.254,-1.746 2.48,-3.488 3.62,-5.31 -4.986,0.096 -6.758,0.72 -6.442,-4.89801 v 0 c -0.608,-1.734 -1.11,-3.236 -2.234,-4.704 0.074,-2.436 3.196,-4.674 5.056,-5.82 1.996,-2.358 2.592,-6.384 6.472,-5.164 5.168,-5.012 8.8,-14.116 16.818,-14.858 z"
+     id="path100"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 232.69375,222.27368 v 0 c -2.516,5.136 -7.8,8.384 -11.258,12.894 0.908,-3.178 1.606,-7.628 3.46,-10.334 2.71,0.164 5.344,-1.512 7.798,-2.56 z"
+     id="path101"
+     style="stroke-width:2" />
+  <path
+     fill="#e4c267"
+     d="m 205.09175,236.96168 c 1.996,-2.358 2.592,-6.384 6.472,-5.164 -1.882,3.976 -3.154,7.958 -2.26,12.41 l 0.746,0.966 c 1.808,0.074 2.558,-0.808 4.2,-1.294 -0.568,2.526 -3.898,6.34801 -5.538,8.50401 -4.986,0.096 -6.758,0.72 -6.442,-4.89801 v 0 c -0.608,-1.734 -1.11,-3.236 -2.234,-4.704 0.074,-2.436 3.196,-4.674 5.056,-5.82 z"
+     id="path102"
+     style="stroke-width:2" />
+  <path
+     fill="#d6991c"
+     d="m 200.03575,242.78168 c 0.074,-2.436 3.196,-4.674 5.056,-5.82 -1.032,3.436 -2.298,6.974 -2.822,10.524 v 0 c -0.608,-1.734 -1.11,-3.236 -2.234,-4.704 z"
+     id="path103"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 228.38175,216.93968 c 0.326,-3.532 2.758,-15.804 7.368,-15.872 l 2.28,3.718 v 2.082 c -1.486,1.796 -3.142,3.526 -3.43,5.944 4.566,-0.902 8.72,-2.206 13.04,-3.914 -4.882,4.584 -9.786,9.102 -14.946,13.376 v 0 c -2.454,1.048 -5.088,2.724 -7.798,2.56 0.764,-2.614 2.36,-5.384 3.486,-7.894 z"
+     id="path104"
+     style="stroke-width:2" />
+  <path
+     fill="#fade6b"
+     d="m 358.50775,173.44367 c 18.416,-4.38 53.464,-10.342 55.298,16.884 -24.86,0.57 -35.762,0.938 -60.484,4.82201 l -0.202,-0.514 c 1.278,-0.93 3.428,-0.886 4.184,-1.712 6.046,-6.58801 1.738,-6.33201 2.402,-12.86401 0.52,-5.102 6.456,-5.5 -0.302,-6.478 z"
+     id="path105"
+     style="stroke-width:2" />
+  <defs
+     id="defs106">
+    <linearGradient
+       id="gradient_7"
+       gradientUnits="userSpaceOnUse"
+       x1="141.16791"
+       y1="268.56354"
+       x2="265.50784"
+       y2="226.48077"
+       gradientTransform="matrix(2,0,0,2.0000004,-111.74825,-110.67438)">
+      <stop
+         offset="0"
+         stop-color="#E1AF37"
+         id="stop105" />
+      <stop
+         offset="1"
+         stop-color="#FCDE74"
+         id="stop106" />
+    </linearGradient>
+  </defs>
+  <path
+     fill="url(#gradient_7)"
+     d="m 208.71175,517.35373 c -86.018,-118.12402 -12.156,-301.82605 129.714,-339.49006 6.44,-1.71 13.438,-3.836 20.082,-4.42 l 0.896,0.138 c 6.758,0.978 0.822,1.376 0.302,6.478 -0.664,6.532 3.644,6.276 -2.402,12.86401 -0.756,0.826 -2.906,0.782 -4.184,1.712 l 0.202,0.514 c -12.89,3.57 -25.456,7.312 -37.754,12.642 -137.6,59.63401 -168.028,233.46204 -63.62,337.58006 7.44,7.418 16.184,13.6 23.4,21.124 0.094,5.944 0.338,11.96801 0,17.90401 -18.568,-12.20801 -57.188,-45.57801 -66.636,-67.04602 z"
+     id="path106"
+     style="fill:url(#gradient_7);stroke-width:2" />
+</svg>

docs/advanced-usage/handlers.rst

@@ -0,0 +1,51 @@
+Writing own handler
+===================
+
+It is possible to extend the application by adding own custom commands. To do so it is required to implement class, which derives from ``ahriman.application.handlers.handler.Handler`` and put it to the ``ahriman.application.handlers`` package. The class later will be loaded automatically and included to each command run.
+
+Let's imagine, that the new class implements ``help-web``, which prints server information to the stdout. To do so, we need to implement base ``ahriman.application.handlers.handler.Handler.run`` method which is entry point for all subcommands:
+
+.. code-block:: python
+
+   from ahriman.application.application import Application
+   from ahriman.application.handlers.handler import Handler
+
+
+   class HelpWeb(Handler):
+
+      @classmethod
+      def run(cls, args: argparse.Namespace, repository_id: RepositoryId, configuration: Configuration, *,
+              report: bool) -> None:
+        # load application instance
+        # report is set to True to make sure that web client is loaded
+        application = Application(repository_id, configuration, report=True)
+        # extract web client
+        client = application.repository.reporter
+
+        # send request to the server
+        response = client.make_request("GET", f"{client.address}/api/v1/info")
+        result = response.json()
+        print(result)
+
+The main functionality of the class is already described, but command is still not available yet. To do so, it is required to set ``arguments`` property, which is the list of the functions, each of them which takes argument parser object, creates new subcommand and returns the modified parser, e.g.:
+
+.. code-block:: python
+
+   import argparse
+
+   from ahriman.application.handlers.handler import SubParserAction
+
+   ...
+
+       @staticmethod
+       def set_parser(root: SubParserAction) -> argparse.ArgumentParser:
+           parser = root.add_parser("help-web", help="get web server status",
+                                    description="request server info and print it to stdout")
+
+       arguments = set_parser
+
+In addition, ``ahriman.application.handlers.handler.Handler.ALLOW_MULTI_ARCHITECTURE_RUN`` can be set to ``False`` in order to disable multiprocess run (e.g. in case if there are conflicting operations, like writing to stdout).
+
+Save the file above as ``/usr/lib/python3.12/site-packages/ahriman/application/handlers/help_web.py`` (replace ``python3.12`` with actual python version) and you are set.
+
+For more examples and details, please check builtin handlers and classes documentations.

docs/advanced-usage/index.rst

@@ -0,0 +1,51 @@
+Advanced usage
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   handlers
+   views
+
+Depending on the goal the package can be used in different ways. Nevertheless, in the most cases you will need some basic classes
+
+.. code-block:: python
+
+   from pathlib import Path
+
+   from ahriman.core.configuration import Configuration
+   from ahriman.core.database import SQLite
+   from ahriman.models.repository_id import RepositoryId
+
+   repository_id = RepositoryId("x86_64", "aur")
+   configuration = Configuration.from_path(Path("/etc/ahriman.ini"), repository_id)
+   database = SQLite.load(configuration)
+
+At this point there are ``configuration`` and ``database`` instances which can be used later at any time anywhere, e.g.
+
+.. code-block:: python
+
+   # instance of ``RepositoryPaths`` class
+   paths = configuration.repository_paths
+
+Almost all actions are wrapped by ``ahriman.core.repository.Repository`` class
+
+.. code-block:: python
+
+   from ahriman.core.repository import Repository
+   from ahriman.models.pacman_synchronization import PacmanSynchronization
+
+   repository = Repository(repository_id, configuration, database,
+                           report=True, refresh_pacman_database=PacmanSynchronization.Disabled)
+
+And the ``repository`` instance can be used to perform repository maintenance
+
+.. code-block:: python
+
+   build_result = repository.process_build(known_packages)
+   built_packages = repository.packages_built()
+   update_result = repository.process_update(built_packages)
+
+   repository.triggers.on_result(update_result, repository.packages())
+
+For the more info please refer to the classes documentation.

docs/advanced-usage/views.rst

@@ -0,0 +1,41 @@
+Writing own API endpoint
+========================
+
+The web service loads views dynamically, thus it is possible to add custom API endpoint or even web page. The view must be derived from ``ahriman.web.views.base.BaseView`` and should implement desired HTTP methods. The API specification will be also loaded automatically if available, but optional. The implementation must be saved into the ``ahriman.web.views`` package
+
+Let's consider example of API endpoint which always returns 204 with no response:
+
+.. code-block:: python
+
+   from aiohttp.web import Response, HTTPNoContent
+
+   from ahriman.web.views.base import BaseView
+
+   class PingView(BaseView):
+
+       async def get(self) -> Response:
+           # do nothing, just raise 204 response
+           # check public methods of the BaseView class for all available controls
+           raise HTTPNoContent
+
+The ``get()`` method can be decorated by ``aiohttp_apispec`` methods, but we will leave it for a self-study, please, consider to check examples of usages in the main package.
+
+In order to view to be added to the route list correctly, few more properties are required to be set. First of all, it is required to specify ``ROUTES`` (list of strings), which contains list of all available routes, e.g.:
+
+.. code-block:: python
+
+   ...
+
+       ROUTES = ["/api/v1/ping"]
+
+In addition, it is also recommended to specify permission level for using this endpoint. Since this endpoint neither does anything nor returns sensitive information, it can be set to ``UserAccess.Unauthorized``:
+
+.. code-block:: python
+
+   ...
+
+       GET_PERMISSION = UserAccess.Unauthorized
+
+That's all. Just save the file as ``/usr/lib/python3.12/site-packages/ahriman/web/views/ping.py`` (replace ``python3.12`` with actual python version) and restart web server.
+
+For more examples and details, please check builtin handlers and classes documentations.

docs/ahriman.1

@@ -1,812 +0,0 @@
-.TH ahriman "1" Manual
-.SH NAME
-ahriman
-.SH SYNOPSIS
-.B ahriman
-[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--no-report] [-q] [--unsafe] [-v] {aur-search,search,key-import,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,repo-check,check,repo-clean,clean,repo-config,config,repo-init,init,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-setup,setup,repo-sign,sign,repo-status-update,repo-sync,sync,repo-update,update,user-add,user-remove,web} ...
-.SH DESCRIPTION
-ArcH Linux ReposItory MANager
-.SH OPTIONS
-
-.TP
-\fB\-a\fR \fI\,ARCHITECTURE\/\fR, \fB\-\-architecture\fR \fI\,ARCHITECTURE\/\fR
-target architectures (can be used multiple times)
-
-.TP
-\fB\-c\fR \fI\,CONFIGURATION\/\fR, \fB\-\-configuration\fR \fI\,CONFIGURATION\/\fR
-configuration path
-
-.TP
-\fB\-\-force\fR
-force run, remove file lock
-
-.TP
-\fB\-l\fR \fI\,LOCK\/\fR, \fB\-\-lock\fR \fI\,LOCK\/\fR
-lock file
-
-.TP
-\fB\-\-no\-report\fR
-force disable reporting to web service
-
-.TP
-\fB\-q\fR, \fB\-\-quiet\fR
-force disable any logging
-
-.TP
-\fB\-\-unsafe\fR
-allow to run ahriman as non\-ahriman user. Some actions might be unavailable
-
-.TP
-\fB\-v\fR, \fB\-\-version\fR
-show program's version number and exit
-
-.SS
-\fBSub-commands\fR
-.TP
-\fBahriman\fR \fI\,aur-search\/\fR
-search for package
-.TP
-\fBahriman\fR \fI\,key-import\/\fR
-import PGP key
-.TP
-\fBahriman\fR \fI\,package-add\/\fR
-add package
-.TP
-\fBahriman\fR \fI\,package-remove\/\fR
-remove package
-.TP
-\fBahriman\fR \fI\,package-status\/\fR
-get package status
-.TP
-\fBahriman\fR \fI\,package-status-remove\/\fR
-remove package status
-.TP
-\fBahriman\fR \fI\,package-status-update\/\fR
-update package status
-.TP
-\fBahriman\fR \fI\,patch-add\/\fR
-add patch set
-.TP
-\fBahriman\fR \fI\,patch-list\/\fR
-list patch sets
-.TP
-\fBahriman\fR \fI\,patch-remove\/\fR
-remove patch set
-.TP
-\fBahriman\fR \fI\,repo-check\/\fR
-check for updates
-.TP
-\fBahriman\fR \fI\,repo-clean\/\fR
-clean local caches
-.TP
-\fBahriman\fR \fI\,repo-config\/\fR
-dump configuration
-.TP
-\fBahriman\fR \fI\,repo-init\/\fR
-create repository tree
-.TP
-\fBahriman\fR \fI\,repo-rebuild\/\fR
-rebuild repository
-.TP
-\fBahriman\fR \fI\,repo-remove-unknown\/\fR
-remove unknown packages
-.TP
-\fBahriman\fR \fI\,repo-report\/\fR
-generate report
-.TP
-\fBahriman\fR \fI\,repo-setup\/\fR
-initial service configuration
-.TP
-\fBahriman\fR \fI\,repo-sign\/\fR
-sign packages
-.TP
-\fBahriman\fR \fI\,repo-status-update\/\fR
-update repository status
-.TP
-\fBahriman\fR \fI\,repo-sync\/\fR
-sync repository
-.TP
-\fBahriman\fR \fI\,repo-update\/\fR
-update packages
-.TP
-\fBahriman\fR \fI\,user-add\/\fR
-create or update user
-.TP
-\fBahriman\fR \fI\,user-remove\/\fR
-remove user
-.TP
-\fBahriman\fR \fI\,web\/\fR
-web server
-.SH OPTIONS 'ahriman aur-search'
-usage: ahriman aur-search [-h] [-i]
-                          [--sort-by {category_id,description,first_submitted,id,last_modified,license,maintainer,name,num_votes,out_of_date,package_base,package_base_id,url,url_path,version}]
-                          search [search ...]
-
-search for package in AUR using API
-
-.TP
-\fBsearch\fR
-search terms, can be specified multiple times, result will match all terms
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.TP
-\fB\-\-sort\-by\fR {category_id,description,first_submitted,id,last_modified,license,maintainer,name,num_votes,out_of_date,package_base,package_base_id,url,url_path,version}
-sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted
-by name
-
-.SH OPTIONS 'ahriman search'
-usage: ahriman aur-search [-h] [-i]
-                          [--sort-by {category_id,description,first_submitted,id,last_modified,license,maintainer,name,num_votes,out_of_date,package_base,package_base_id,url,url_path,version}]
-                          search [search ...]
-
-search for package in AUR using API
-
-.TP
-\fBsearch\fR
-search terms, can be specified multiple times, result will match all terms
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.TP
-\fB\-\-sort\-by\fR {category_id,description,first_submitted,id,last_modified,license,maintainer,name,num_votes,out_of_date,package_base,package_base_id,url,url_path,version}
-sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted
-by name
-
-.SH OPTIONS 'ahriman key-import'
-usage: ahriman key-import [-h] [--key-server KEY_SERVER] key
-
-import PGP key from public sources to the repository user
-
-.TP
-\fBkey\fR
-PGP key to import from public server
-
-.TP
-\fB\-\-key\-server\fR \fI\,KEY_SERVER\/\fR
-key server for key import
-
-.SH OPTIONS 'ahriman package-add'
-usage: ahriman package-add [-h] [-n]
-                           [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}]
-                           [--without-dependencies]
-                           package [package ...]
-
-add existing or new package to the build queue
-
-.TP
-\fBpackage\fR
-package source (base name, path to local files, remote URL)
-
-.TP
-\fB\-n\fR, \fB\-\-now\fR
-run update function after
-
-.TP
-\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}
-explicitly specify the package source for this command
-
-.TP
-\fB\-\-without\-dependencies\fR
-do not add dependencies
-
-.SH OPTIONS 'ahriman add'
-usage: ahriman package-add [-h] [-n]
-                           [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}]
-                           [--without-dependencies]
-                           package [package ...]
-
-add existing or new package to the build queue
-
-.TP
-\fBpackage\fR
-package source (base name, path to local files, remote URL)
-
-.TP
-\fB\-n\fR, \fB\-\-now\fR
-run update function after
-
-.TP
-\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}
-explicitly specify the package source for this command
-
-.TP
-\fB\-\-without\-dependencies\fR
-do not add dependencies
-
-.SH OPTIONS 'ahriman package-update'
-usage: ahriman package-add [-h] [-n]
-                           [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}]
-                           [--without-dependencies]
-                           package [package ...]
-
-add existing or new package to the build queue
-
-.TP
-\fBpackage\fR
-package source (base name, path to local files, remote URL)
-
-.TP
-\fB\-n\fR, \fB\-\-now\fR
-run update function after
-
-.TP
-\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote}
-explicitly specify the package source for this command
-
-.TP
-\fB\-\-without\-dependencies\fR
-do not add dependencies
-
-.SH OPTIONS 'ahriman package-remove'
-usage: ahriman package-remove [-h] package [package ...]
-
-remove package from the repository
-
-.TP
-\fBpackage\fR
-package name or base
-
-
-.SH OPTIONS 'ahriman remove'
-usage: ahriman package-remove [-h] package [package ...]
-
-remove package from the repository
-
-.TP
-\fBpackage\fR
-package name or base
-
-
-.SH OPTIONS 'ahriman package-status'
-usage: ahriman package-status [-h] [--ahriman] [-i]
-                              [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
-                              [package ...]
-
-request status of the package
-
-.TP
-\fBpackage\fR
-filter status by package base
-
-.TP
-\fB\-\-ahriman\fR
-get service status itself
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.TP
-\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
-filter packages by status
-
-.SH OPTIONS 'ahriman status'
-usage: ahriman package-status [-h] [--ahriman] [-i]
-                              [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
-                              [package ...]
-
-request status of the package
-
-.TP
-\fBpackage\fR
-filter status by package base
-
-.TP
-\fB\-\-ahriman\fR
-get service status itself
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.TP
-\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
-filter packages by status
-
-.SH OPTIONS 'ahriman package-status-remove'
-usage: ahriman package-status-remove [-h] package [package ...]
-
-remove the package from the status page
-
-.TP
-\fBpackage\fR
-remove specified packages
-
-
-.SH OPTIONS 'ahriman package-status-update'
-usage: ahriman package-status-update [-h]
-                                     [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
-                                     [package ...]
-
-update package status on the status page
-
-.TP
-\fBpackage\fR
-set status for specified packages. If no packages supplied, service status will be updated
-
-.TP
-\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
-new status
-
-.SH OPTIONS 'ahriman status-update'
-usage: ahriman package-status-update [-h]
-                                     [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
-                                     [package ...]
-
-update package status on the status page
-
-.TP
-\fBpackage\fR
-set status for specified packages. If no packages supplied, service status will be updated
-
-.TP
-\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
-new status
-
-.SH OPTIONS 'ahriman patch-add'
-usage: ahriman patch-add [-h] [-t TRACK] package
-
-create or update source patches
-
-.TP
-\fBpackage\fR
-path to directory with changed files for patch addition/update
-
-.TP
-\fB\-t\fR \fI\,TRACK\/\fR, \fB\-\-track\fR \fI\,TRACK\/\fR
-files which has to be tracked
-
-.SH OPTIONS 'ahriman patch-list'
-usage: ahriman patch-list [-h] package
-
-list available patches for the package
-
-.TP
-\fBpackage\fR
-package base
-
-
-.SH OPTIONS 'ahriman patch-remove'
-usage: ahriman patch-remove [-h] package
-
-remove patches for the package
-
-.TP
-\fBpackage\fR
-package base
-
-
-.SH OPTIONS 'ahriman repo-check'
-usage: ahriman repo-check [-h] [--no-vcs] [package ...]
-
-check for packages updates. Same as update \-\-dry\-run \-\-no\-manual
-
-.TP
-\fBpackage\fR
-filter check by package base
-
-.TP
-\fB\-\-no\-vcs\fR
-do not check VCS packages
-
-.SH OPTIONS 'ahriman check'
-usage: ahriman repo-check [-h] [--no-vcs] [package ...]
-
-check for packages updates. Same as update \-\-dry\-run \-\-no\-manual
-
-.TP
-\fBpackage\fR
-filter check by package base
-
-.TP
-\fB\-\-no\-vcs\fR
-do not check VCS packages
-
-.SH OPTIONS 'ahriman repo-clean'
-usage: ahriman repo-clean [-h] [--build] [--cache] [--chroot] [--manual] [--packages] [--patches]
-
-remove local caches
-
-
-.TP
-\fB\-\-build\fR
-clear directory with package sources
-
-.TP
-\fB\-\-cache\fR
-clear directory with package caches
-
-.TP
-\fB\-\-chroot\fR
-clear build chroot
-
-.TP
-\fB\-\-manual\fR
-clear directory with manually added packages
-
-.TP
-\fB\-\-packages\fR
-clear directory with built packages
-
-.TP
-\fB\-\-patches\fR
-clear directory with patches
-
-.SH OPTIONS 'ahriman clean'
-usage: ahriman repo-clean [-h] [--build] [--cache] [--chroot] [--manual] [--packages] [--patches]
-
-remove local caches
-
-
-.TP
-\fB\-\-build\fR
-clear directory with package sources
-
-.TP
-\fB\-\-cache\fR
-clear directory with package caches
-
-.TP
-\fB\-\-chroot\fR
-clear build chroot
-
-.TP
-\fB\-\-manual\fR
-clear directory with manually added packages
-
-.TP
-\fB\-\-packages\fR
-clear directory with built packages
-
-.TP
-\fB\-\-patches\fR
-clear directory with patches
-
-.SH OPTIONS 'ahriman repo-config'
-usage: ahriman repo-config [-h]
-
-dump configuration for the specified architecture
-
-
-
-.SH OPTIONS 'ahriman config'
-usage: ahriman repo-config [-h]
-
-dump configuration for the specified architecture
-
-
-
-.SH OPTIONS 'ahriman repo-init'
-usage: ahriman repo-init [-h]
-
-create empty repository tree. Optional command for auto architecture support
-
-
-
-.SH OPTIONS 'ahriman init'
-usage: ahriman repo-init [-h]
-
-create empty repository tree. Optional command for auto architecture support
-
-
-
-.SH OPTIONS 'ahriman repo-rebuild'
-usage: ahriman repo-rebuild [-h] [--depends-on DEPENDS_ON]
-
-force rebuild whole repository
-
-
-.TP
-\fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR
-only rebuild packages that depend on specified package
-
-.SH OPTIONS 'ahriman rebuild'
-usage: ahriman repo-rebuild [-h] [--depends-on DEPENDS_ON]
-
-force rebuild whole repository
-
-
-.TP
-\fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR
-only rebuild packages that depend on specified package
-
-.SH OPTIONS 'ahriman repo-remove-unknown'
-usage: ahriman repo-remove-unknown [-h] [--dry-run] [-i]
-
-remove packages which are missing in AUR and do not have local PKGBUILDs
-
-
-.TP
-\fB\-\-dry\-run\fR
-just perform check for packages without removal
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.SH OPTIONS 'ahriman remove-unknown'
-usage: ahriman repo-remove-unknown [-h] [--dry-run] [-i]
-
-remove packages which are missing in AUR and do not have local PKGBUILDs
-
-
-.TP
-\fB\-\-dry\-run\fR
-just perform check for packages without removal
-
-.TP
-\fB\-i\fR, \fB\-\-info\fR
-show additional package information
-
-.SH OPTIONS 'ahriman repo-report'
-usage: ahriman repo-report [-h] [target ...]
-
-generate repository report according to current settings
-
-.TP
-\fBtarget\fR
-target to generate report
-
-
-.SH OPTIONS 'ahriman report'
-usage: ahriman repo-report [-h] [target ...]
-
-generate repository report according to current settings
-
-.TP
-\fBtarget\fR
-target to generate report
-
-
-.SH OPTIONS 'ahriman repo-setup'
-usage: ahriman repo-setup [-h] [--build-command BUILD_COMMAND] [--from-configuration FROM_CONFIGURATION] [--no-multilib]
-                          --packager PACKAGER --repository REPOSITORY [--sign-key SIGN_KEY]
-                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
-
-create initial service configuration, requires root
-
-
-.TP
-\fB\-\-build\-command\fR \fI\,BUILD_COMMAND\/\fR
-build command prefix
-
-.TP
-\fB\-\-from\-configuration\fR \fI\,FROM_CONFIGURATION\/\fR
-path to default devtools pacman configuration
-
-.TP
-\fB\-\-no\-multilib\fR
-do not add multilib repository
-
-.TP
-\fB\-\-packager\fR \fI\,PACKAGER\/\fR
-packager name and email
-
-.TP
-\fB\-\-repository\fR \fI\,REPOSITORY\/\fR
-repository name
-
-.TP
-\fB\-\-sign\-key\fR \fI\,SIGN_KEY\/\fR
-sign key id
-
-.TP
-\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
-sign options
-
-.TP
-\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
-port of the web service
-
-.SH OPTIONS 'ahriman setup'
-usage: ahriman repo-setup [-h] [--build-command BUILD_COMMAND] [--from-configuration FROM_CONFIGURATION] [--no-multilib]
-                          --packager PACKAGER --repository REPOSITORY [--sign-key SIGN_KEY]
-                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
-
-create initial service configuration, requires root
-
-
-.TP
-\fB\-\-build\-command\fR \fI\,BUILD_COMMAND\/\fR
-build command prefix
-
-.TP
-\fB\-\-from\-configuration\fR \fI\,FROM_CONFIGURATION\/\fR
-path to default devtools pacman configuration
-
-.TP
-\fB\-\-no\-multilib\fR
-do not add multilib repository
-
-.TP
-\fB\-\-packager\fR \fI\,PACKAGER\/\fR
-packager name and email
-
-.TP
-\fB\-\-repository\fR \fI\,REPOSITORY\/\fR
-repository name
-
-.TP
-\fB\-\-sign\-key\fR \fI\,SIGN_KEY\/\fR
-sign key id
-
-.TP
-\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
-sign options
-
-.TP
-\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
-port of the web service
-
-.SH OPTIONS 'ahriman repo-sign'
-usage: ahriman repo-sign [-h] [package ...]
-
-(re\-)sign packages and repository database according to current settings
-
-.TP
-\fBpackage\fR
-sign only specified packages
-
-
-.SH OPTIONS 'ahriman sign'
-usage: ahriman repo-sign [-h] [package ...]
-
-(re\-)sign packages and repository database according to current settings
-
-.TP
-\fBpackage\fR
-sign only specified packages
-
-
-.SH OPTIONS 'ahriman repo-status-update'
-usage: ahriman repo-status-update [-h]
-                                  [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
-
-update repository status on the status page
-
-
-.TP
-\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
-new status
-
-.SH OPTIONS 'ahriman repo-sync'
-usage: ahriman repo-sync [-h] [target ...]
-
-sync repository files to remote server according to current settings
-
-.TP
-\fBtarget\fR
-target to sync
-
-
-.SH OPTIONS 'ahriman sync'
-usage: ahriman repo-sync [-h] [target ...]
-
-sync repository files to remote server according to current settings
-
-.TP
-\fBtarget\fR
-target to sync
-
-
-.SH OPTIONS 'ahriman repo-update'
-usage: ahriman repo-update [-h] [--dry-run] [--no-aur] [--no-manual] [--no-vcs] [package ...]
-
-check for packages updates and run build process if requested
-
-.TP
-\fBpackage\fR
-filter check by package base
-
-.TP
-\fB\-\-dry\-run\fR
-just perform check for updates, same as check command
-
-.TP
-\fB\-\-no\-aur\fR
-do not check for AUR updates. Implies \-\-no\-vcs
-
-.TP
-\fB\-\-no\-manual\fR
-do not include manual updates
-
-.TP
-\fB\-\-no\-vcs\fR
-do not check VCS packages
-
-.SH OPTIONS 'ahriman update'
-usage: ahriman repo-update [-h] [--dry-run] [--no-aur] [--no-manual] [--no-vcs] [package ...]
-
-check for packages updates and run build process if requested
-
-.TP
-\fBpackage\fR
-filter check by package base
-
-.TP
-\fB\-\-dry\-run\fR
-just perform check for updates, same as check command
-
-.TP
-\fB\-\-no\-aur\fR
-do not check for AUR updates. Implies \-\-no\-vcs
-
-.TP
-\fB\-\-no\-manual\fR
-do not include manual updates
-
-.TP
-\fB\-\-no\-vcs\fR
-do not check VCS packages
-
-.SH OPTIONS 'ahriman user-add'
-usage: ahriman user-add [-h] [--as-service] [--no-reload] [-p PASSWORD]
-                        [-r {UserAccess.Safe,UserAccess.Read,UserAccess.Write}] [-s]
-                        username
-
-update user for web services with the given password and role. In case if password was not entered it will be asked interactively
-
-.TP
-\fBusername\fR
-username for web service
-
-.TP
-\fB\-\-as\-service\fR
-add user as service user
-
-.TP
-\fB\-\-no\-reload\fR
-do not reload authentication module
-
-.TP
-\fB\-p\fR \fI\,PASSWORD\/\fR, \fB\-\-password\fR \fI\,PASSWORD\/\fR
-user password. Blank password will be treated as empty password, which is in particular must be used for OAuth2
-authorization type.
-
-.TP
-\fB\-r\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}, \fB\-\-role\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}
-user access level
-
-.TP
-\fB\-s\fR, \fB\-\-secure\fR
-set file permissions to user\-only
-
-.SH OPTIONS 'ahriman user-remove'
-usage: ahriman user-remove [-h] [--no-reload] [-s] username
-
-remove user from the user mapping and update the configuration
-
-.TP
-\fBusername\fR
-username for web service
-
-.TP
-\fB\-\-no\-reload\fR
-do not reload authentication module
-
-.TP
-\fB\-s\fR, \fB\-\-secure\fR
-set file permissions to user\-only
-
-.SH OPTIONS 'ahriman web'
-usage: ahriman web [-h]
-
-start web server
-
-
-
-.SH COMMENTS
-Argument list can also be read from file by using @ prefix.
-
-.SH AUTHORS
-.B ahriman
-was written by ahriman team <>.
-.SH DISTRIBUTION
-The latest version of ahriman may be downloaded from
-.UR https://github.com/arcan1s/ahriman
-.UE

docs/ahriman.application.application.rst

@@ -0,0 +1,61 @@
+ahriman.application.application package
+=======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application.application.workers
+
+Submodules
+----------
+
+ahriman.application.application.application module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_packages module
+------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_properties module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_repository module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.updates\_iterator module
+--------------------------------------------------------
+
+.. automodule:: ahriman.application.application.updates_iterator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.application.workers.rst

@@ -0,0 +1,37 @@
+ahriman.application.application.workers package
+===============================================
+
+Submodules
+----------
+
+ahriman.application.application.workers.local\_updater module
+-------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.workers.local_updater
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.workers.remote\_updater module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.workers.remote_updater
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.workers.updater module
+------------------------------------------------------
+
+.. automodule:: ahriman.application.application.workers.updater
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.application.workers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.handlers.rst

@@ -0,0 +1,293 @@
+ahriman.application.handlers package
+====================================
+
+Submodules
+----------
+
+ahriman.application.handlers.add module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.backup module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.backup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.change module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.change
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.clean module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.clean
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.copy module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.copy
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.daemon module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.daemon
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.dump module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.dump
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.handler module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.help module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.help
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.key\_import module
+-----------------------------------------------
+
+.. automodule:: ahriman.application.handlers.key_import
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.patch module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.rebuild module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.rebuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.remove module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.remove\_unknown module
+---------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove_unknown
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.repositories module
+------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.restore module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.restore
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.run module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.run
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.search module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.service\_updates module
+----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.service_updates
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.setup module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.setup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.shell module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.shell
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.sign module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.statistics module
+----------------------------------------------
+
+.. automodule:: ahriman.application.handlers.statistics
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.status module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.status\_update module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status_update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.structure module
+---------------------------------------------
+
+.. automodule:: ahriman.application.handlers.structure
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.tree\_migrate module
+-------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.tree_migrate
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.triggers module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.triggers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.triggers\_support module
+-----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.triggers_support
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.unsafe\_commands module
+----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.unsafe_commands
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.update module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.users module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.users
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.validate module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.validate
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.versions module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.versions
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.web module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.handlers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.rst

@@ -0,0 +1,54 @@
+ahriman.application package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application.application
+   ahriman.application.handlers
+
+Submodules
+----------
+
+ahriman.application.ahriman module
+----------------------------------
+
+.. automodule:: ahriman.application.ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.help\_formatter module
+------------------------------------------
+
+.. automodule:: ahriman.application.help_formatter
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.interactive\_shell module
+---------------------------------------------
+
+.. automodule:: ahriman.application.interactive_shell
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.lock module
+-------------------------------
+
+.. automodule:: ahriman.application.lock
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.alpm.remote.rst

@@ -0,0 +1,45 @@
+ahriman.core.alpm.remote package
+================================
+
+Submodules
+----------
+
+ahriman.core.alpm.remote.aur module
+-----------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.aur
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.official module
+----------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.official
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.official\_syncdb module
+------------------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.official_syncdb
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.remote module
+--------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.alpm.rst

@@ -0,0 +1,53 @@
+ahriman.core.alpm package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm.remote
+
+Submodules
+----------
+
+ahriman.core.alpm.pacman module
+-------------------------------
+
+.. automodule:: ahriman.core.alpm.pacman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.pacman\_database module
+-----------------------------------------
+
+.. automodule:: ahriman.core.alpm.pacman_database
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.pkgbuild\_parser module
+-----------------------------------------
+
+.. automodule:: ahriman.core.alpm.pkgbuild_parser
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.repo module
+-----------------------------
+
+.. automodule:: ahriman.core.alpm.repo
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.auth.rst

@@ -0,0 +1,53 @@
+ahriman.core.auth package
+=========================
+
+Submodules
+----------
+
+ahriman.core.auth.auth module
+-----------------------------
+
+.. automodule:: ahriman.core.auth.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.helpers module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.helpers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.mapping module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.mapping
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.oauth module
+------------------------------
+
+.. automodule:: ahriman.core.auth.oauth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.pam module
+----------------------------
+
+.. automodule:: ahriman.core.auth.pam
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.build_tools.rst

@@ -0,0 +1,37 @@
+ahriman.core.build\_tools package
+=================================
+
+Submodules
+----------
+
+ahriman.core.build\_tools.package\_archive module
+-------------------------------------------------
+
+.. automodule:: ahriman.core.build_tools.package_archive
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.build\_tools.sources module
+----------------------------------------
+
+.. automodule:: ahriman.core.build_tools.sources
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.build\_tools.task module
+-------------------------------------
+
+.. automodule:: ahriman.core.build_tools.task
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.build_tools
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.configuration.rst

@@ -0,0 +1,61 @@
+ahriman.core.configuration package
+==================================
+
+Submodules
+----------
+
+ahriman.core.configuration.configuration module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.configuration.configuration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.configuration\_multi\_dict module
+------------------------------------------------------------
+
+.. automodule:: ahriman.core.configuration.configuration_multi_dict
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.schema module
+----------------------------------------
+
+.. automodule:: ahriman.core.configuration.schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.shell\_interpolator module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.configuration.shell_interpolator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.shell\_template module
+-------------------------------------------------
+
+.. automodule:: ahriman.core.configuration.shell_template
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.validator module
+-------------------------------------------
+
+.. automodule:: ahriman.core.configuration.validator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.configuration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.migrations.rst

@@ -0,0 +1,141 @@
+ahriman.core.database.migrations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.migrations.m000\_initial module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m000_initial
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m001\_package\_source module
+-------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m001_package_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m002\_user\_access module
+----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m002_user_access
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m003\_patch\_variables module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m003_patch_variables
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m004\_logs module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m004_logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m005\_make\_opt\_depends module
+----------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m005_make_opt_depends
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m006\_packages\_architecture\_required module
+------------------------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m006_packages_architecture_required
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m007\_check\_depends module
+------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m007_check_depends
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m008\_packagers module
+-------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m008_packagers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m009\_local\_source module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m009_local_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m010\_version\_based\_logs\_removal module
+---------------------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m010_version_based_logs_removal
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m011\_repository\_name module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m011_repository_name
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m012\_last\_commit\_sha module
+---------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m012_last_commit_sha
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m013\_dependencies module
+----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m013_dependencies
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m014\_auditlog module
+------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m014_auditlog
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m015\_logs\_process\_id module
+---------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m015_logs_process_id
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.migrations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.operations.rst

@@ -0,0 +1,85 @@
+ahriman.core.database.operations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.operations.auth\_operations module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.auth_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.build\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.build_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.changes\_operations module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.changes_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.dependencies\_operations module
+----------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.dependencies_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.event\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.event_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.logs\_operations module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.logs_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.operations module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.package\_operations module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.package_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.patch\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.patch_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.rst

@@ -0,0 +1,30 @@
+ahriman.core.database package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.database.migrations
+   ahriman.core.database.operations
+
+Submodules
+----------
+
+ahriman.core.database.sqlite module
+-----------------------------------
+
+.. automodule:: ahriman.core.database.sqlite
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.distributed.rst

@@ -0,0 +1,45 @@
+ahriman.core.distributed package
+================================
+
+Submodules
+----------
+
+ahriman.core.distributed.distributed\_system module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.distributed.distributed_system
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.distributed.worker\_loader\_trigger module
+-------------------------------------------------------
+
+.. automodule:: ahriman.core.distributed.worker_loader_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.distributed.worker\_trigger module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.distributed.worker_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.distributed.workers\_cache module
+----------------------------------------------
+
+.. automodule:: ahriman.core.distributed.workers_cache
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.distributed
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.formatters.rst

@@ -0,0 +1,165 @@
+ahriman.core.formatters package
+===============================
+
+Submodules
+----------
+
+ahriman.core.formatters.aur\_printer module
+-------------------------------------------
+
+.. automodule:: ahriman.core.formatters.aur_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.build\_printer module
+---------------------------------------------
+
+.. automodule:: ahriman.core.formatters.build_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.changes\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.changes_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.configuration\_paths\_printer module
+------------------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_paths_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.configuration\_printer module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.event\_stats\_printer module
+----------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.event_stats_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.package\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.package_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.package\_stats\_printer module
+------------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.package_stats_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.patch\_printer module
+---------------------------------------------
+
+.. automodule:: ahriman.core.formatters.patch_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.printer module
+--------------------------------------
+
+.. automodule:: ahriman.core.formatters.printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.repository\_printer module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.repository_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.repository\_stats\_printer module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.repository_stats_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.status\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.status_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.string\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.string_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.tree\_printer module
+--------------------------------------------
+
+.. automodule:: ahriman.core.formatters.tree_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.update\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.update_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.user\_printer module
+--------------------------------------------
+
+.. automodule:: ahriman.core.formatters.user_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.validation\_printer module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.validation_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.version\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.version_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.formatters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.gitremote.rst

@@ -0,0 +1,45 @@
+ahriman.core.gitremote package
+==============================
+
+Submodules
+----------
+
+ahriman.core.gitremote.remote\_pull module
+------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_pull
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_pull\_trigger module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_pull_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_push module
+------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_push
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_push\_trigger module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_push_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.gitremote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.http.rst

@@ -0,0 +1,29 @@
+ahriman.core.http package
+=========================
+
+Submodules
+----------
+
+ahriman.core.http.sync\_ahriman\_client module
+----------------------------------------------
+
+.. automodule:: ahriman.core.http.sync_ahriman_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.http.sync\_http\_client module
+-------------------------------------------
+
+.. automodule:: ahriman.core.http.sync_http_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.http
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.log.rst

@@ -0,0 +1,45 @@
+ahriman.core.log package
+========================
+
+Submodules
+----------
+
+ahriman.core.log.http\_log\_handler module
+------------------------------------------
+
+.. automodule:: ahriman.core.log.http_log_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.journal\_handler module
+----------------------------------------
+
+.. automodule:: ahriman.core.log.journal_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.lazy\_logging module
+-------------------------------------
+
+.. automodule:: ahriman.core.log.lazy_logging
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.log\_loader module
+-----------------------------------
+
+.. automodule:: ahriman.core.log.log_loader
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.log
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.report.rst

@@ -0,0 +1,85 @@
+ahriman.core.report package
+===========================
+
+Submodules
+----------
+
+ahriman.core.report.console module
+----------------------------------
+
+.. automodule:: ahriman.core.report.console
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.email module
+--------------------------------
+
+.. automodule:: ahriman.core.report.email
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.html module
+-------------------------------
+
+.. automodule:: ahriman.core.report.html
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.jinja\_template module
+------------------------------------------
+
+.. automodule:: ahriman.core.report.jinja_template
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.remote\_call module
+---------------------------------------
+
+.. automodule:: ahriman.core.report.remote_call
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.report module
+---------------------------------
+
+.. automodule:: ahriman.core.report.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.report\_trigger module
+------------------------------------------
+
+.. automodule:: ahriman.core.report.report_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.rss module
+------------------------------
+
+.. automodule:: ahriman.core.report.rss
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.telegram module
+-----------------------------------
+
+.. automodule:: ahriman.core.report.telegram
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.repository.rst

@@ -0,0 +1,69 @@
+ahriman.core.repository package
+===============================
+
+Submodules
+----------
+
+ahriman.core.repository.cleaner module
+--------------------------------------
+
+.. automodule:: ahriman.core.repository.cleaner
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.event\_logger module
+--------------------------------------------
+
+.. automodule:: ahriman.core.repository.event_logger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.executor module
+---------------------------------------
+
+.. automodule:: ahriman.core.repository.executor
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.package\_info module
+--------------------------------------------
+
+.. automodule:: ahriman.core.repository.package_info
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.repository module
+-----------------------------------------
+
+.. automodule:: ahriman.core.repository.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.repository\_properties module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.repository.repository_properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.update\_handler module
+----------------------------------------------
+
+.. automodule:: ahriman.core.repository.update_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.rst

@@ -0,0 +1,93 @@
+ahriman.core package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm
+   ahriman.core.auth
+   ahriman.core.build_tools
+   ahriman.core.configuration
+   ahriman.core.database
+   ahriman.core.distributed
+   ahriman.core.formatters
+   ahriman.core.gitremote
+   ahriman.core.http
+   ahriman.core.log
+   ahriman.core.report
+   ahriman.core.repository
+   ahriman.core.sign
+   ahriman.core.status
+   ahriman.core.support
+   ahriman.core.triggers
+   ahriman.core.upload
+
+Submodules
+----------
+
+ahriman.core.exceptions module
+------------------------------
+
+.. automodule:: ahriman.core.exceptions
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.module\_loader module
+----------------------------------
+
+.. automodule:: ahriman.core.module_loader
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.spawn module
+-------------------------
+
+.. automodule:: ahriman.core.spawn
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.tree module
+------------------------
+
+.. automodule:: ahriman.core.tree
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.types module
+-------------------------
+
+.. automodule:: ahriman.core.types
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.util module
+------------------------
+
+.. automodule:: ahriman.core.util
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.utils module
+-------------------------
+
+.. automodule:: ahriman.core.utils
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.sign.rst

@@ -0,0 +1,21 @@
+ahriman.core.sign package
+=========================
+
+Submodules
+----------
+
+ahriman.core.sign.gpg module
+----------------------------
+
+.. automodule:: ahriman.core.sign.gpg
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.status.rst

@@ -0,0 +1,45 @@
+ahriman.core.status package
+===========================
+
+Submodules
+----------
+
+ahriman.core.status.client module
+---------------------------------
+
+.. automodule:: ahriman.core.status.client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.status.local\_client module
+----------------------------------------
+
+.. automodule:: ahriman.core.status.local_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.status.watcher module
+----------------------------------
+
+.. automodule:: ahriman.core.status.watcher
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.status.web\_client module
+--------------------------------------
+
+.. automodule:: ahriman.core.status.web_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.support.pkgbuild.rst

@@ -0,0 +1,37 @@
+ahriman.core.support.pkgbuild package
+=====================================
+
+Submodules
+----------
+
+ahriman.core.support.pkgbuild.keyring\_generator module
+-------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.keyring_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.pkgbuild.mirrorlist\_generator module
+----------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.mirrorlist_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.pkgbuild.pkgbuild\_generator module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.pkgbuild_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.support.pkgbuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.support.rst

@@ -0,0 +1,45 @@
+ahriman.core.support package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.support.pkgbuild
+
+Submodules
+----------
+
+ahriman.core.support.keyring\_trigger module
+--------------------------------------------
+
+.. automodule:: ahriman.core.support.keyring_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.mirrorlist\_trigger module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.support.mirrorlist_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.package\_creator module
+--------------------------------------------
+
+.. automodule:: ahriman.core.support.package_creator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.support
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.triggers.rst

@@ -0,0 +1,29 @@
+ahriman.core.triggers package
+=============================
+
+Submodules
+----------
+
+ahriman.core.triggers.trigger module
+------------------------------------
+
+.. automodule:: ahriman.core.triggers.trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.triggers.trigger\_loader module
+--------------------------------------------
+
+.. automodule:: ahriman.core.triggers.trigger_loader
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.triggers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.upload.rst

@@ -0,0 +1,69 @@
+ahriman.core.upload package
+===========================
+
+Submodules
+----------
+
+ahriman.core.upload.github module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.github
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.http\_upload module
+---------------------------------------
+
+.. automodule:: ahriman.core.upload.http_upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.remote\_service module
+------------------------------------------
+
+.. automodule:: ahriman.core.upload.remote_service
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.rsync module
+--------------------------------
+
+.. automodule:: ahriman.core.upload.rsync
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.s3 module
+-----------------------------
+
+.. automodule:: ahriman.core.upload.s3
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.upload module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.upload\_trigger module
+------------------------------------------
+
+.. automodule:: ahriman.core.upload.upload_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.models.rst

@@ -0,0 +1,341 @@
+ahriman.models package
+======================
+
+Submodules
+----------
+
+ahriman.models.action module
+----------------------------
+
+.. automodule:: ahriman.models.action
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.aur\_package module
+----------------------------------
+
+.. automodule:: ahriman.models.aur_package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.auth\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.auth_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.build\_status module
+-----------------------------------
+
+.. automodule:: ahriman.models.build_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.changes module
+-----------------------------
+
+.. automodule:: ahriman.models.changes
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.context\_key module
+----------------------------------
+
+.. automodule:: ahriman.models.context_key
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.counters module
+------------------------------
+
+.. automodule:: ahriman.models.counters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.dependencies module
+----------------------------------
+
+.. automodule:: ahriman.models.dependencies
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.event module
+---------------------------
+
+.. automodule:: ahriman.models.event
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.filesystem\_package module
+-----------------------------------------
+
+.. automodule:: ahriman.models.filesystem_package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.internal\_status module
+--------------------------------------
+
+.. automodule:: ahriman.models.internal_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.log\_handler module
+----------------------------------
+
+.. automodule:: ahriman.models.log_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.log\_record module
+---------------------------------
+
+.. automodule:: ahriman.models.log_record
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.log\_record\_id module
+-------------------------------------
+
+.. automodule:: ahriman.models.log_record_id
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.metrics\_timer module
+------------------------------------
+
+.. automodule:: ahriman.models.metrics_timer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.migration module
+-------------------------------
+
+.. automodule:: ahriman.models.migration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.migration\_result module
+---------------------------------------
+
+.. automodule:: ahriman.models.migration_result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package module
+-----------------------------
+
+.. automodule:: ahriman.models.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package\_description module
+------------------------------------------
+
+.. automodule:: ahriman.models.package_description
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package\_source module
+-------------------------------------
+
+.. automodule:: ahriman.models.package_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.packagers module
+-------------------------------
+
+.. automodule:: ahriman.models.packagers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.pacman\_synchronization module
+---------------------------------------------
+
+.. automodule:: ahriman.models.pacman_synchronization
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.pkgbuild module
+------------------------------
+
+.. automodule:: ahriman.models.pkgbuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.pkgbuild\_patch module
+-------------------------------------
+
+.. automodule:: ahriman.models.pkgbuild_patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.process\_status module
+-------------------------------------
+
+.. automodule:: ahriman.models.process_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.property module
+------------------------------
+
+.. automodule:: ahriman.models.property
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.remote\_source module
+------------------------------------
+
+.. automodule:: ahriman.models.remote_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.report\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.report_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.repository\_id module
+------------------------------------
+
+.. automodule:: ahriman.models.repository_id
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.repository\_paths module
+---------------------------------------
+
+.. automodule:: ahriman.models.repository_paths
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.repository\_stats module
+---------------------------------------
+
+.. automodule:: ahriman.models.repository_stats
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.result module
+----------------------------
+
+.. automodule:: ahriman.models.result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.scan\_paths module
+---------------------------------
+
+.. automodule:: ahriman.models.scan_paths
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.series\_statistics module
+----------------------------------------
+
+.. automodule:: ahriman.models.series_statistics
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.sign\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.sign_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.smtp\_ssl\_settings module
+-----------------------------------------
+
+.. automodule:: ahriman.models.smtp_ssl_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.upload\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.upload_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.user module
+--------------------------
+
+.. automodule:: ahriman.models.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.user\_access module
+----------------------------------
+
+.. automodule:: ahriman.models.user_access
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.waiter module
+----------------------------
+
+.. automodule:: ahriman.models.waiter
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.worker module
+----------------------------
+
+.. automodule:: ahriman.models.worker
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.models
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.rst

@@ -0,0 +1,21 @@
+ahriman package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application
+   ahriman.core
+   ahriman.models
+   ahriman.web
+
+Module contents
+---------------
+
+.. automodule:: ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.apispec.rst

@@ -0,0 +1,29 @@
+ahriman.web.apispec package
+===========================
+
+Submodules
+----------
+
+ahriman.web.apispec.decorators module
+-------------------------------------
+
+.. automodule:: ahriman.web.apispec.decorators
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.apispec.info module
+-------------------------------
+
+.. automodule:: ahriman.web.apispec.info
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.apispec
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.middlewares.rst

@@ -0,0 +1,29 @@
+ahriman.web.middlewares package
+===============================
+
+Submodules
+----------
+
+ahriman.web.middlewares.auth\_handler module
+--------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.auth_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.middlewares.exception\_handler module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.exception_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.middlewares
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.rst

@@ -0,0 +1,56 @@
+ahriman.web package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.apispec
+   ahriman.web.middlewares
+   ahriman.web.schemas
+   ahriman.web.views
+
+Submodules
+----------
+
+ahriman.web.cors module
+-----------------------
+
+.. automodule:: ahriman.web.cors
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.keys module
+-----------------------
+
+.. automodule:: ahriman.web.keys
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.routes module
+-------------------------
+
+.. automodule:: ahriman.web.routes
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.web module
+----------------------
+
+.. automodule:: ahriman.web.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.schemas.rst

@@ -0,0 +1,317 @@
+ahriman.web.schemas package
+===========================
+
+Submodules
+----------
+
+ahriman.web.schemas.aur\_package\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.aur_package_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.auth\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.auth_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.build\_options\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.build_options_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.changes\_schema module
+------------------------------------------
+
+.. automodule:: ahriman.web.schemas.changes_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.counters\_schema module
+-------------------------------------------
+
+.. automodule:: ahriman.web.schemas.counters_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.dependencies\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.dependencies_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.error\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.error_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.event\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.event_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.event\_search\_schema module
+------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.event_search_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.file\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.file_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.info\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.info_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.internal\_status\_schema module
+---------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.internal_status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.log\_schema module
+--------------------------------------
+
+.. automodule:: ahriman.web.schemas.log_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.login\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.login_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.logs\_rotate\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.logs_rotate_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.logs\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.logs_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.oauth2\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.oauth2_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_name\_schema module
+------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_name_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_names\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_names_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_patch\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_patch_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_properties\_schema module
+------------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_properties_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_schema module
+------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_status\_schema module
+--------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_version\_schema module
+---------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_version_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pagination\_schema module
+---------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pagination_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.patch\_name\_schema module
+----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.patch_name_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.patch\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.patch_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pgp\_key\_id\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pgp_key_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pgp\_key\_schema module
+-------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pgp_key_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.process\_id\_schema module
+----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.process_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.process\_schema module
+------------------------------------------
+
+.. automodule:: ahriman.web.schemas.process_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.remote\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.remote_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.repository\_id\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.repository_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.repository\_stats\_schema module
+----------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.repository_stats_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.search\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.search_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.status\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.update\_flags\_schema module
+------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.update_flags_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.worker\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.worker_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.schemas
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.api.rst

@@ -0,0 +1,29 @@
+ahriman.web.views.api package
+=============================
+
+Submodules
+----------
+
+ahriman.web.views.api.docs module
+---------------------------------
+
+.. automodule:: ahriman.web.views.api.docs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.api.swagger module
+------------------------------------
+
+.. automodule:: ahriman.web.views.api.swagger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.api
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.rst

@@ -0,0 +1,55 @@
+ahriman.web.views package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.api
+   ahriman.web.views.v1
+   ahriman.web.views.v2
+
+Submodules
+----------
+
+ahriman.web.views.base module
+-----------------------------
+
+.. automodule:: ahriman.web.views.base
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.index module
+------------------------------
+
+.. automodule:: ahriman.web.views.index
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.static module
+-------------------------------
+
+.. automodule:: ahriman.web.views.static
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.status\_view\_guard module
+--------------------------------------------
+
+.. automodule:: ahriman.web.views.status_view_guard
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.auditlog.rst

@@ -0,0 +1,21 @@
+ahriman.web.views.v1.auditlog package
+=====================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.auditlog.events module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.auditlog.events
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.auditlog
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.distributed.rst

@@ -0,0 +1,21 @@
+ahriman.web.views.v1.distributed package
+========================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.distributed.workers module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.distributed.workers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.distributed
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.packages.rst

@@ -0,0 +1,69 @@
+ahriman.web.views.v1.packages package
+=====================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.packages.changes module
+--------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.changes
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.dependencies module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.dependencies
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.logs module
+-----------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.package module
+--------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.packages module
+---------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.patch module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.packages.patches module
+--------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.packages.patches
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.rst

@@ -0,0 +1,23 @@
+ahriman.web.views.v1 package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.v1.auditlog
+   ahriman.web.views.v1.distributed
+   ahriman.web.views.v1.packages
+   ahriman.web.views.v1.service
+   ahriman.web.views.v1.status
+   ahriman.web.views.v1.user
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.service.rst

@@ -0,0 +1,93 @@
+ahriman.web.views.v1.service package
+====================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.service.add module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.logs module
+----------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.pgp module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.pgp
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.process module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.process
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.rebuild module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.rebuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.remove module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.request module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.request
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.search module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.update module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.upload module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.service
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.status.rst

@@ -0,0 +1,37 @@
+ahriman.web.views.v1.status package
+===================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.status.info module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.info
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.repositories module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.status module
+-----------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.user.rst

@@ -0,0 +1,29 @@
+ahriman.web.views.v1.user package
+=================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.user.login module
+--------------------------------------
+
+.. automodule:: ahriman.web.views.v1.user.login
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.user.logout module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.user.logout
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v2.packages.rst

@@ -0,0 +1,21 @@
+ahriman.web.views.v2.packages package
+=====================================
+
+Submodules
+----------
+
+ahriman.web.views.v2.packages.logs module
+-----------------------------------------
+
+.. automodule:: ahriman.web.views.v2.packages.logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v2.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v2.rst

@@ -0,0 +1,18 @@
+ahriman.web.views.v2 package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.v2.packages
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v2
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/architecture.md

@@ -1,204 +0,0 @@
-# Package structure
-
-Packages have strict rules of importing:
-
-* `ahriman.application` package must not be used anywhere except for itself.
-* `ahriman.core` and `ahriman.models` packages don't have any import restriction. Actually we would like to totally restrict importing of `core` package from `models`, but it is impossible at the moment.
-* `ahriman.web` package is allowed to be imported from `ahriman.application` (web handler only, only `ahriman.web.web` methods). It also must not be imported globally, only local import is allowed. 
-
-Full dependency diagram:
-
-![architecture](ahriman-architecture.svg)
-
-## `ahriman.application` package
-
-This package contains application (aka executable) related classes and everything for that. It also contains package called `ahriman.application.handlers` in which all available subcommands are described as separated classes derived from base `ahriman.application.handlers.handler.Handler` class.
-
-`ahriman.application.application.application.Application` (god class) is used for any interaction from parsers with repository, web etc. It is divided into multiple traits by functions (package related and repository related) in the same package.
-
-`ahriman.application.formatters` package provides `Printer` sub-classes for printing data (e.g. package properties) to stdout which are used by some handlers.
-
-`ahriman.application.ahriman` contains only command line parses and executes specified `Handler` on success, `ahriman.application.lock.Lock` is additional class which provides file-based lock and also performs some common checks.
-
-## `ahriman.core` package
-
-This package contains everything which is required for any time of application run and separated to several packages:
-
-* `ahriman.core.alpm` package controls pacman related functions. It provides wrappers for `pyalpm` library and safe calls for repository tools (`repo-add` and `repo-remove`).
-* `ahriman.core.auth` package provides classes for authorization methods used by web mostly. Base class is `ahriman.core.auth.auth.Auth` which must be called by `load` method.
-* `ahriman.core.build_tools` is a package which provides wrapper for `devtools` commands.
-* `ahriman.core.report` is a package with reporting classes. Usually it must be called by `ahriman.core.report.report.Report.load` method.
-* `ahriman.core.repository` contains several traits and base repository (`ahriman.core.repository.repository.Repository` class) implementation.
-* `ahriman.core.sign` package provides sign feature (only gpg calls are available).
-* `ahriman.core.status` contains helpers and watcher class which are required for web application. Reporter must be initialized by using `ahriman.core.status.client.Client.load` method.
-* `ahriman.core.upload` package provides sync feature, must be called by `ahriman.core.upload.upload.Upload.load` method.
-
-This package also provides some generic functions and classes which may be used by other packages:
-
-* `ahriman.core.configuration.Configuration` is an extension for standard `configparser` library.
-* `ahriman.core.exceptions` provides custom exceptions.
-* `ahriman.core.spawn.Spawn` is a tool which can spawn another `ahriman` process. This feature is used by web application.
-* `ahriman.core.tree` is a dependency tree implementation.
-
-## `ahriman.models` package
-
-It provides models for any other part of application. Unlike `ahriman.core` package classes from here provides only conversion methods (e.g. create class from another or convert to). Mostly case classes and enumerations.
-
-## `ahriman.web` package
-
-Web application. It is important that this package is isolated from any other to allow it to be optional feature (i.e. dependencies which are required by the package are optional).
-
-* `ahriman.web.middlewares` provides middlewares for request handlers.
-* `ahriman.web.views` contains web views derived from aiohttp view class.
-* `ahriman.web.routes` creates routes for web application.
-* `ahriman.web.web` provides main web application functions (e.g. start, initialization).
-
-# Application run
-
-* Parse command line arguments, find command and related handler which is set by parser.
-* Call `Handler.execute` method.
-* Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or process in current process otherwise. Class attribute `ALLOW_MULTI_ARCHITECTURE_RUN` controls whether application can be run in multiple processes or not - this feature is required for some handlers (e.g. `Web`) which should be able to spawn child process in daemon mode (it is impossible to do for daemonic processes).
-* In each child process call lock functions.
-* After success checks pass control to `Handler.run` method defined by specific handler class.
-* Return result (success or failure) of each subprocess and exit from application.
-
-In most cases handlers spawn god class `ahriman.application.application.Application` class and call required methods.
-
-Application is designed to run from `systemd` services and provides parametrized by architecture timer and service file for that.
-
-# Basic flows
-
-## Add new packages or rebuild existing
-
-Idea is to copy package to the directory from which it will be handled at the next update run. Different variants are supported:
-
-* If supplied argument is file then application moves the file to the directory with built packages. Same rule applies for directory, but in this case it copies every package-like file from the specified directory.
-* If supplied argument is directory and there is `PKGBUILD` file there it will be treated as local package. In this case it will queue this package to build and copy source files (`PKGBUILD` and `.SRCINFO`) to caches.
-* If supplied argument iis not file then application tries to lookup for the specified name in AUR and clones it into the directory with manual updates. This scenario can also handle package dependencies which are missing in repositories.
-
-This logic can be overwritten by specifying the `source` parameter, which is partially useful if you would like to add package from AUR, but there is local directory cloned from AUR.
-
-## Rebuild packages
-
-Same as add function for every package in repository. Optional filter by reverse dependency can be supplied.
-
-## Remove packages
-
-This flow removes package from filesystem, updates repository database and also runs synchronization and reporting methods.
-
-## Update packages
-
-This feature is divided into to stages: check AUR for updates and run rebuild for required packages. Whereas check does not do anything except for check itself, update flow is the following:
-
-1. Process every built package first. Those packages are usually added manually.
-2. Run sync and report methods.
-3. Generate dependency tree for packages to be built.
-4. For each level of tree it does:
-   1. Download package data from AUR.
-   2. Build every package in clean chroot.
-   3. Sign packages if required.
-   4. Add packages to database and sign database if required.
-   5. Process sync and report methods.
-
-After any step any package data is being removed.
-
-# Core functions reference
-
-## Configuration 
-
-`ahriman.core.configuration.Configuration` class provides some additional methods (e.g. `getpath` and `getlist`) and also combines multiple files into single configuration dictionary using architecture overrides. It is the recommended way to deal with settings.
-
-## Utils
-
-For every external command run (which is actually not recommended if possible) custom wrapper for `subprocess` is used. Additional functions `ahriman.core.auth.helpers` provide safe calls for `aiohttp_security` methods and are required to make this dependency optional.
-
-## Submodules
-
-Some packages provide different behaviour depending on configuration settings. In these cases inheritance is used and recommended way to deal with them is to call class method `load` from base classes.
-
-## Authorization
-
-The package provides several authorization methods: disabled, based on configuration and OAuth2. 
-
-Disabled (default) authorization provider just allows everything for everyone and does not have any specific configuration (it uses some default configuration parameters though). It also provides generic interface for derived classes.
-
-Mapping (aka configuration) provider uses hashed passwords with salt from configuration file in order to authenticate users. This provider also enables user permission checking (read/write) (authorization). Thus, it defines the following methods:
-
-* `check_credentials` - user password validation (authentication).
-* `verify_access` - user permission validation (authorization).
-
-Passwords must be stored in configuration as `hash(password + salt)`, where `password` is user defined password (taken from user input), `salt` is random string (any length) defined globally in configuration and `hash` is secure hash function. Thus, the following configuration
-
-```ini
-[auth:read]
-username = $6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0
-```
-
-means that there is user `username` with `read` access and password `password` hashed by `sha512` with salt `salt`.
-
-OAuth provider uses library definitions (`aioauth-client`) in order _authenticate_ users. It still requires user permission to be set in configuration, thus it inherits mapping provider without any changes. Whereas we could override `check_credentials` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
-
-OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature is used by service reporting (aka robots).
-
-In order to configure users there are special commands.
-
-## Remote synchronization
-
-There are several supported synchronization providers, currently they are `rsync`, `s3`, `github`. 
-
-`rsync` provider does not have any specific logic except for running external rsync application with configured arguments. The service does not handle SSH configuration, thus it has to be configured before running application manually.
-
-`s3` provider uses `boto3` package and implements sync feature. The files are stored in architecture directory (e.g. if bucket is `repository`, packages will be stored in `repository/x86_64` for the `x86_64` architecture), bucket must be created before any action and API key must have permissions to write to the bucket. No external configuration required. In order to upload only changed files the service compares calculated hashes with the Amazon ETags, used realization is described [here](https://teppen.io/2018/10/23/aws_s3_verify_etags/). 
-
-`github` provider authenticates through basic auth, API key with repository write permissions is required. There will be created a release with the name of the architecture in case if it does not exist; files will be uploaded to the release assets. It also stores array of files and their MD5 checksums in release body in order to upload only changed ones. According to the Github API in case if there is already uploaded asset with the same name (e.g. database files), asset will be removed first.
-
-## Additional features
-
-Some features require optional dependencies to be installed:
-
-* Version control executables (e.g. `git`, `svn`) for VCS packages.
-* `gnupg` application for package and repository sign feature.
-* `rsync` application for rsync based repository sync.
-* `boto3` python package for `S3` sync.
-* `Jinja2` python package for HTML report generation (it is also used by web application).
-
-# Web application
-
-Web application requires the following python packages to be installed:
-
-* Core part requires `aiohttp` (application itself), `aiohttp_jinja2` and `Jinja2` (HTML generation from templates).
-* In addition, `aiohttp_debugtoolbar` is required for debug panel. Please note that this option does not work together with authorization and basically must not be used in production.
-* In addition, authorization feature requires `aiohttp_security`, `aiohttp_session` and `cryptography`.
-* In addition to base authorization dependencies, OAuth2 also requires `aioauth-client` library.
-
-## Middlewares
-
-Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
-
-## Web views
-
-All web views are defined in separated package and derived from `ahriman.web.views.base.Base` class which provides typed interfaces for web application. 
-
-REST API supports both form and JSON data, but the last one is recommended. 
-
-Different APIs are separated into different packages:
-
-* `ahriman.web.views.service` provides views for application controls.
-* `ahriman.web.views.status` package provides REST API for application reporting.
-* `ahriman.web.views.user` package provides login and logout methods which can be called without authorization.
-
-## Templating
-
-Package provides base jinja templates which can be overridden by settings. Vanilla templates are actively using bootstrap library.
-
-## Requests and scopes
-
-Service provides optional authorization which can be turned on in settings. In order to control user access there are two levels of authorization - read-only (only GET-like requests) and write (anything) which are provided by each web view directly.
-
-If this feature is configured any request will be prohibited without authentication. In addition, configuration flag `auth.safe_build_status` can be used in order to allow seeing main page without authorization.
-
-For authenticated users it uses encrypted session cookies to store tokens; encryption key is generated each time at the start of the application. It also stores expiration time of the session inside.
-
-## External calls
-
-Web application provides external calls to control main service. It spawns child process with specific arguments and waits for its termination. This feature must be used either with authorization or in safe (i.e. when status page is not available world-wide) environment.

docs/architecture.rst

@@ -0,0 +1,471 @@
+Architecture
+============
+
+Package structure
+-----------------
+
+Packages have strict rules of importing:
+
+* ``ahriman.application`` package must not be used outside of this package.
+* ``ahriman.core`` and ``ahriman.models`` packages don't have any import restriction. Actually we would like to totally restrict importing of ``core`` package from ``models``, but it is impossible at the moment.
+* ``ahriman.web`` package is allowed to be imported from ``ahriman.application`` (web handler only, only ``ahriman.web.web`` methods).
+* The idea remains the same for all imports, if an package requires some specific dependencies, it must be imported locally to keep dependencies optional.
+
+Full dependency diagram:
+
+.. graphviz:: _static/architecture.dot
+   :alt: architecture
+
+``ahriman.application`` package
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This package contains application (aka executable) related classes and everything for it. It also contains package called ``ahriman.application.handlers`` in which all available subcommands are described as separated classes derived from the base ``ahriman.application.handlers.handler.Handler`` class. Those classes are being loaded dynamically through the lookup of the ``ahriman.application.handlers`` package.
+
+``ahriman.application.application.Application`` (god class) is used for any interaction from parsers with repository. It is divided into multiple traits by functions (package related and repository related) in the same package.
+
+``ahriman.application.application.workers`` package contains specific wrappers for local and remote build processes.
+
+``ahriman.application.ahriman`` contains only command line parses and executes specified ``Handler`` on success, ``ahriman.application.lock.Lock`` is additional class which provides file-based lock and also performs some common checks.
+
+``ahriman.core`` package
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This package contains everything required for the most of application actions and it is separated into several packages:
+
+* ``ahriman.core.alpm`` package controls pacman related functions. It provides wrappers for ``pyalpm`` library and safe calls for repository tools (``repo-add`` and ``repo-remove``). Also this package contains ``ahriman.core.alpm.remote`` package which provides wrapper for remote sources (e.g. AUR RPC and official repositories RPC) and some other helpers.
+* ``ahriman.core.auth`` package provides classes for authorization methods used by web mostly. Base class is ``ahriman.core.auth.Auth`` which must be instantiated by ``load`` method. This package is only required by the ``ahriman.web`` package.
+* ``ahriman.core.build_tools`` is a package which provides wrapper for ``devtools`` commands.
+* ``ahriman.core.configuration`` contains extensions for standard ``configparser`` module and some validation related classes.
+* ``ahriman.core.database`` is everything for database, including data and schema migrations.
+* ``ahriman.core.distributed`` package with triggers and helpers for distributed build system.
+* ``ahriman.core.formatters`` package provides ``Printer`` sub-classes for printing data (e.g. package properties) to stdout which are used by some handlers.
+* ``ahriman.core.gitremote`` is a package with remote PKGBUILD triggers. Should not be called directly.
+* ``ahriman.core.http`` package provides HTTP clients which can be used later by other classes.
+* ``ahriman.core.log`` is a log utils package. It includes logger loader class, custom HTTP based logger and some wrappers.
+* ``ahriman.core.report`` is a package with reporting triggers. Should not be called directly.
+* ``ahriman.core.repository`` contains several traits and base repository (``ahriman.core.repository.Repository`` class) implementation.
+* ``ahriman.core.sign`` package provides sign feature (only gpg calls are available).
+* ``ahriman.core.status`` contains helpers and watcher class which are required for web application. Reporter must be initialized by using ``ahriman.core.status.client.Client.load`` method.
+* ``ahriman.core.support`` provides plugins for support packages (mirrorlist and keyring) generation.
+* ``ahriman.core.triggers`` package contains base trigger classes. Classes from this package must be imported in order to implement user extensions. In fact, ``ahriman.core.report``, ``ahriman.core.upload`` and other built-in triggers use this package.
+* ``ahriman.core.upload`` package provides sync feature, should not be called directly.
+
+This package also provides some generic functions and classes which may be used by other packages:
+
+* ``ahriman.core.exceptions`` provides custom exceptions.
+* ``ahriman.core.module_loader`` provides ``implementations`` method which can be used for dynamic classes load. In particular, this method is used for web views and application handlers loading.
+* ``ahriman.core.spawn.Spawn`` is a tool which can spawn another ``ahriman`` process. This feature is used by web application.
+* ``ahriman.core.tree`` is a dependency tree implementation.
+* ``ahriman.core.types`` are an additional global types for mypy checks.
+* ``ahriman.core.utils`` contains some useful functions which are not the part of any other class.
+
+``ahriman.models`` package
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It provides models for any other part of application. Unlike ``ahriman.core`` package classes from here provide only conversion methods (e.g. create class from another or convert to). It is mostly presented by case classes and enumerations.
+
+``ahriman.web`` package
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Web application. It is important that this package is isolated from any other to allow it to be optional feature (i.e. dependencies which are required by the package are optional).
+
+* ``ahriman.web.middlewares`` provides middlewares for request handlers.
+* ``ahriman.web.schemas`` provides schemas (actually copy paste from dataclasses) used by swagger documentation.
+* ``ahriman.web.views`` contains web views derived from aiohttp view class. Those classes are loaded dynamically through the filesystem lookup.
+* ``ahriman.web.apispec`` provides generators for swagger documentation.
+* ``ahriman.web.cors`` contains helpers for cross origin resource sharing middlewares.
+* ``ahriman.web.routes`` creates routes for web application.
+* ``ahriman.web.web`` provides main web application functions (e.g. start, initialization).
+
+Application run
+---------------
+
+#. Parse command line arguments, find subcommand and related handler which is set by the parser.
+#. Call ``Handler.execute`` method.
+#. Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or continue in current process otherwise. Class attribute ``ALLOW_MULTI_ARCHITECTURE_RUN`` controls whether the application can be run in multiple processes or not - this feature is required for some handlers (e.g. ``Config``, which utilizes stdout to print messages).
+#. In each child process call lock functions.
+#. After success checks pass control to ``Handler.run`` method defined by specific handler class.
+#. Return result (success or failure) of each subprocess and exit from application.
+#. Some handlers may override their status and throw ``ExitCode`` exception. This exception is just silently suppressed and changes application exit code to ``1``.
+
+In the most cases handlers spawn god class ``ahriman.application.application.Application`` class and call required methods.
+
+The application is designed to run from ``systemd`` services and provides parametrized by repository identifier timer and service file for that.
+
+Subcommand design
+^^^^^^^^^^^^^^^^^
+
+All subcommands are divided into several groups depending on the role they are doing:
+
+* ``aur`` (``aur-search``) group is for AUR operations.
+* ``help`` (e.g. ``help``) are system commands.
+* ``package`` subcommands (e.g. ``package-add``) allow to perform single package actions.
+* ``patch`` subcommands (e.g. ``patch-list``) are the special case of ``package`` subcommands introduced in order to control patches for packages.
+* ``repo`` subcommands (e.g. ``repo-check``) usually perform actions on whole repository.
+* ``service`` subcommands (e.g. ``service-setup``) perform actions which are related to whole service managing: create repository, show configuration.
+* ``user`` subcommands (``user-add``) are intended for user management.
+* ``web`` subcommands are related to web service management.
+
+For historical reasons and in order to keep backward compatibility some subcommands have aliases to their shorter forms or even other groups, but the application doesn't guarantee that they will remain unchanged.
+
+Filesystem tree
+---------------
+
+The application supports two types of trees, one is for the legacy configuration (when there were no explicit repository name configuration available) and another one is the new-style tree. This document describes only new-style tree in order to avoid deprecated structures.
+
+Having default root as ``/var/lib/ahriman`` (differs from container though), the directory structure is the following:
+
+.. code-block::
+
+   /var/lib/ahriman/
+   ├── ahriman.db
+   ├── cache
+   ├── chroot
+   │   └── aur
+   ├── packages
+   │   └── aur
+   │       └── x86_64
+   ├── pacman
+   │   └── aur
+   │       └── x86_64
+   │           ├── local
+   │           │   └── ALPM_DB_VERSION
+   │           └── sync
+   │               ├── core.db
+   │               ├── extra.db
+   │               └── multilib.db
+   │
+   └── repository
+       └── aur
+           └── x86_64
+               ├── aur.db -> aur.db.tar.gz
+               ├── aur.db.tar.gz
+               ├── aur.files -> aur.files.tar.gz
+               └── aur.files.tar.gz
+
+There are multiple subdirectories, some of them are commons for any repository, but some of them are not.
+
+* ``cache`` is a directory with locally stored PKGBUILD's and VCS packages. It is common for all repositories and architectures.
+* ``chroot/{repository}`` is a chroot directory for ``devtools``. It is specific for each repository, but shared for different architectures inside (the ``devtools`` handles architectures automatically).
+* ``packages/{repository}/{architecture}`` is a directory with prebuilt packages. When a package is built, first it will be uploaded to this directory and later will be handled by update process. It is architecture and repository specific.
+* ``pacman/{repository}/{architecture}`` is the repository and architecture specific caches for pacman's databases.
+* ``repository/{repository}/{architecture}`` is a repository packages directory.
+
+Normally you should avoid direct interaction with the application tree. For tree migration process refer to the :doc:`migration notes <migrations/index>`.
+
+Database
+--------
+
+The service uses SQLite database in order to store some internal info.
+
+Database instance
+^^^^^^^^^^^^^^^^^
+
+All methods related to the specific part of database (basically operations per table) are split into different traits located inside ``ahriman.core.database.operations`` package. The base trait ``ahriman.core.database.operations.Operations`` also provides generic methods for database access (e.g. row converters and transactional support).
+
+The ``ahriman.core.database.SQLite`` class itself derives from all of these traits and implements methods for initialization, including migrations.
+
+Schema and data migrations
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The schema migrations are applied according to current ``pragma user_info`` values, located at ``ahriman.core.database.migrations`` package and named as ``m000_migration_name.py`` (the preceding ``m`` is required in order to import migration content for tests). Additional class ``ahriman.core.database.migrations.Migrations`` reads all migrations automatically and applies them in alphabetical order.
+
+These migrations can also contain data migrations. Though the recommended way is to migrate data directly from SQL queries, sometimes it is required to have external data (like packages list) in order to set correct data. To do so, special method ``migrate_data`` is used.
+
+Type conversions
+^^^^^^^^^^^^^^^^
+
+By default, it parses rows into python dictionary. In addition, the following pseudo-types are supported:
+
+* ``dict[str, Any]`` and ``list[Any]`` - for storing JSON data structures in database (technically there is no restriction on types for dictionary keys and values, but it is recommended to use only string keys). The type is stored as ``json`` data type and ``json.loads`` and ``json.dumps`` methods are used in order to read and write from/to database respectively.
+
+Basic flows
+-----------
+
+By default package build operations are performed with ``PACKAGER`` which is specified in ``makepkg.conf``, however, it is possible to override this variable from command line; in this case service performs lookup in the following way:
+
+* If packager is not set, it reads environment variables (e.g. ``DOAS_USER``, ``SUDO_USER`` and ``USER``), otherwise it uses value from command line.
+* It checks users for the specified username and tries to extract packager variable from it.
+* If packager value has been found, it will be passed as ``PACKAGER`` system variable (additional sudo configuration to pass environment variables might be required).
+
+Add new packages or rebuild existing
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The idea is to add package to a build queue from which it will be handled automatically during the next update run. Different variants are supported:
+
+* If supplied argument is file, then application moves the file to the directory with the built packages. Same rule is applied for directory, but in this case it copies every package-like file from the specified directory.
+* If supplied argument is directory and there is ``PKGBUILD`` file there, it will be treated as local package. In this case it will queue this package to build and copy source files (``PKGBUILD`` and ``.SRCINFO``) to caches.
+* If supplied argument looks like URL (i.e. it has scheme, which is neither ``data`` nor ``file``, e.g. ``http://``), it tries to download the package from the specified remote source.
+* If supplied argument is not file then application tries to lookup for the specified name in AUR and clones it into the temporary directory, from which it will be added into the build queue. This scenario can also handle package dependencies which are missing in repositories.
+
+This logic can be overwritten by specifying the ``source`` parameter, which is partially useful if you would like to add package from AUR, but there is local directory cloned from AUR. Also the official repositories calls are hidden behind explicit source definition.
+
+Rebuild packages
+^^^^^^^^^^^^^^^^
+
+Same as add function for every package in repository. Optional filters by reverse dependency or build status can be supplied.
+
+Remove packages
+^^^^^^^^^^^^^^^
+
+This flow removes package from filesystem, updates repository database and also runs synchronization and reporting methods.
+
+Check outdated packages
+^^^^^^^^^^^^^^^^^^^^^^^
+
+There are few ways for packages to be marked as out-of-date and hence requiring rebuild. Those are following:
+
+#. User requested update of the package. It can be caused by calling ``package-add`` subcommand (or ``package-update`` with arguments).
+#. The most common way for packages to be marked as out-of-dated is that the version in AUR (or the official repositories) is newer than in the repository.
+#. In addition to the above, if package is named as VCS (e.g. has suffix ``-git``) and the last update was more than specified threshold ago, the service will also try to fetch sources and check if the revision is newer than the built one.
+#. In addition, there is ability to check if the dependencies of the package have been updated (e.g. if linked library has been renamed or the modules directory - e.g. in case of python and ruby packages - has been changed). And if so, the package will be marked as out-of-dated as well.
+
+Update packages
+^^^^^^^^^^^^^^^
+
+This feature is divided into the following stages: check AUR for updates and run rebuild for required packages. The package update flow is the following:
+
+#. Process every built package first. Those packages are usually added manually.
+#. Run sync and report methods.
+#. Generate dependency tree for packages to be built.
+#. For each level of tree it does:
+
+   #. Download package data from AUR.
+   #. Bump ``pkgrel`` if there is duplicate version in the local repository (see explanation below).
+   #. Build every package in clean chroot.
+   #. Sign packages if required.
+   #. Add packages to database and sign database if required.
+   #. Process triggers.
+
+After any step any package data is being removed.
+
+In case if there are configured workers, the build process itself will be delegated to the remote instances. Packages will be partitioned to the chunks according to the amount of configured workers.
+
+Distributed builds
+^^^^^^^^^^^^^^^^^^
+
+This feature consists of two parts:
+
+* Upload built packages to the node.
+* Delegate packages building to separated nodes.
+
+The upload process is performed via special API endpoint, which is disabled by default, and is performed in several steps:
+
+#. Upload package to temporary file.
+#. Copy content from temporary file to the built package directory with dot (``.``) prefix.
+#. Rename copied file, removing preceding dot.
+
+After success upload, the update process must be called as usual in order to copy built packages to the main repository tree.
+
+On the other side, the delegation uses upload feature, but in addition it also calls external services in order to trigger build process. The packages are separated into the chunks based on the amount of the configured workers and their dependencies.
+
+pkgrel bump rules
+^^^^^^^^^^^^^^^^^
+
+The application is able to automatically bump package release (``pkgrel`` variable) during the build process if there is duplicated version in the repository. The version will be incremented as following:
+
+#. Get version of the remote package.
+#. Get version of the local package if available.
+#. If the local version is not set, proceed with the remote one.
+#. If the local version is set and the remote version is newer than local one, proceed with remote.
+#. Extract ``pkgrel`` value.
+#. If it has ``major.minor`` notation (e.g. ``1.1``), then increment last part by 1, e.g. ``1.1 -> 1.2``, ``1.0.1 -> 1.0.2``.
+#. If ``pkgrel`` is a number (e.g. ``1``), then append 1 to the end of the string, e.g. ``1 -> 1.1``.
+
+Implicit dependencies resolution
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In addition to the depends/optional/make/check depends lists the server also handles implicit dependencies. After success build, the application traverse through the build tree and finds:
+
+* Libraries to which the binaries (ELF-files) are linked. To do so, the ``NEEDED`` section of the ELF-files is read.
+* Directories which contains files of the package, but do not belong to this package. This case covers, for example, python and ruby submodules.
+
+Having the initial dependencies tree, the application is looking for packages which contains those (both files and directories) paths and creates the initial packages list. After that, the packages list is reduced in the following way:
+
+* From any leaf exclude the package itself and possible debug packages.
+* If the entry (i.e. file or directory) belongs to the package which is in base group, it will be removed.
+* If there is a package which depends on the another package which provide the same entry, the package will be removed.
+* After that, if there is a package which *optionally* depends on the another package in the remaining list, the package will be removed.
+* And finally, if there is any path, which is the child of the entry, and it contains the same package, the package from the smaller entry will be removed.
+
+Those paths are also filtered by regular expressions set in the configuration.
+
+All those implicit dependencies are stored in the database and extracted on each check. In case if any of the repository packages doesn't contain any entry anymore (e.g. so version has been changed or modules directory has been changed), the dependent package will be marked as out-of-dated.
+
+Core functions reference
+------------------------
+
+Configuration
+^^^^^^^^^^^^^
+
+``ahriman.core.configuration.Configuration`` class provides some additional methods (e.g. ``getpath`` and ``getlist``) and also combines multiple files into single configuration dictionary using repository identifier overrides. It is the recommended way to deal with settings.
+
+Enumerations
+^^^^^^^^^^^^
+
+All enumerations are derived from ``enum.StrEnum``. Integer enumerations in general are not allowed, because most of operations require conversions from string variable. Derivation from string based enumeration is required to make json conversions implicitly (e.g. during calling ``json.dumps`` methods).
+
+In addition, some enumerations provide ``from_option`` class methods in order to allow some flexibility while reading configuration options.
+
+Utils
+^^^^^
+
+For every external command run (which is actually not recommended if possible) custom wrapper for ``subprocess`` is used. Additional functions ``ahriman.core.auth.helpers`` provide safe calls for ``aiohttp_security`` methods and are required to make this dependency optional.
+
+Context variables
+^^^^^^^^^^^^^^^^^
+
+Package provides implicit global variables which can be accessed from ``ahriman.core`` package as ``context`` variable, wrapped by ``contextvars.ContextVar`` class. The value of the variable is defaulting to private ``_Context`` class which is defined in the same module. The default values - such as ``database`` and ``sign`` - are being set on the service initialization.
+
+The ``_Context`` class itself mimics default collection interface (as is ``Mapping``) and can be modified by ``_Context.set`` method. The stored variables can be achieved by ``_Context.get`` method, which is unlike default ``Mapping`` interface also performs type and presence checks.
+
+In order to provide statically typed interface, the ``ahriman.models.context_key.ContextKey`` class is used for both ``_Content.get`` and ``_Content.set`` methods; the context instance itself, however, does not store information about types.
+
+Submodules
+^^^^^^^^^^
+
+Some packages provide different behaviour depending on configuration settings. In these cases inheritance is used and recommended way to deal with them is to call class method ``load`` from base classes.
+
+Authorization
+^^^^^^^^^^^^^
+
+The package provides several authorization methods: disabled, based on configuration, PAM and OAuth2.
+
+Disabled (default) authorization provider just allows everything for everyone and does not have any specific configuration (it uses some default configuration parameters though). It also provides generic interface for derived classes.
+
+Mapping (aka configuration) provider uses hashed passwords with optional salt from the database in order to authenticate users. This provider also enables user permission checking (read/write) (authorization). Thus, it defines the following methods:
+
+* ``check_credentials`` - user password validation (authentication).
+* ``verify_access`` - user permission validation (authorization).
+
+Passwords must be stored in database as ``hash(password + salt)``, where ``password`` is user defined password (taken from user input), ``salt`` is random string (any length) defined globally in configuration and ``hash`` is a secure hash function. Thus, the following configuration
+
+.. code-block::
+
+   "username","password","access"
+   "username","$6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0","read"
+
+means that there is user ``username`` with ``read`` access and password ``password`` hashed by ``sha512`` with salt ``salt``.
+
+OAuth provider uses library definitions (``aioauth-client``) in order *authenticate* users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override ``check_credentials`` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
+
+OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature can be used by service reporting (aka robots).
+
+In addition, web service checks the source socket used. In case if it belongs to ``socket.AF_UNIX`` family, it will skip any further checks considering the request to be performed in safe environment (e.g. on the same physical machine). This feature, in particular is being used by the reporter instances in case if socket address is set in configuration. Note, however, that this behaviour can be disabled by configuration.
+
+In order to configure users there are special subcommands.
+
+Triggers
+^^^^^^^^
+
+Triggers are extensions which can be used in order to perform any actions on application start, after the update process and, finally, before the application exit.
+
+The main idea is to load classes by their full path (e.g. ``ahriman.core.upload.UploadTrigger``) by using ``importlib``: get the last part of the import and treat it as class name, join remain part by ``.`` and interpret as module path, import module and extract attribute from it.
+
+The loaded triggers will be called with ``ahriman.models.result.Result`` and ``list[Packages]`` arguments, which describes the process result and current repository packages respectively. Any exception raised will be suppressed and will generate an exception message in logs.
+
+In addition triggers can implement ``on_start`` and ``on_stop`` actions which will be called on the application start and right before the application exit respectively. The ``on_start`` action is usually being called from handlers directly in order to make sure that no trigger will be run when it is not required (e.g. on user management). As soon as ``on_start`` action is called, the additional flag will be set; ``ahriman.core.triggers.TriggerLoader`` class implements ``__del__`` method in which, if the flag is set, the ``on_stop`` actions will be called.
+
+For more details how to deal with the triggers, refer to :doc:`documentation <triggers>` and modules descriptions.
+
+Remote synchronization
+^^^^^^^^^^^^^^^^^^^^^^
+
+There are several supported synchronization providers, currently they are ``rsync``, ``s3``, ``github``.
+
+``rsync`` provider does not have any specific logic except for running external rsync application with configured arguments. The service does not handle SSH configuration, thus it has to be configured before running application manually.
+
+``s3`` provider uses ``boto3`` package and implements sync feature. The files are stored in architecture specific directory (e.g. if bucket is ``repository``, packages will be stored in ``repository/aur/x86_64`` for the ``aur`` repository and ``x86_64`` architecture), bucket must be created before any action and API key must have permissions to write to the bucket. No external configuration required. In order to upload only changed files the service compares calculated hashes with the Amazon ETags, the implementation used is described `here <https://teppen.io/2018/10/23/aws_s3_verify_etags/>`__.
+
+``github`` provider authenticates through basic auth, API key with repository write permissions is required. There will be created a release with the name of the architecture in case if it does not exist; files will be uploaded to the release assets. It also stores array of files and their MD5 checksums in release body in order to upload only changed ones. According to the GitHub API in case if there is already uploaded asset with the same name (e.g. database files), asset will be removed first.
+
+PKGBUILD parsing
+^^^^^^^^^^^^^^^^
+
+The application provides a house-made shell parser ``ahriman.core.alpm.pkgbuild_parser.PkgbuildParser`` to process PKGBUILDs and extract package data from them. It relies on the ``shlex.shlex`` parser with some configuration tweaks and adds some token post-processing.
+
+#. During the parser process, firstly, it extract next token from the source file (basically, the word) and tries to match it to the variable assignment. If so, then just processes accordingly.
+#. If it is not an assignment, the parser checks if the token was quoted.
+#. If it wasn't quoted then the parser tries to match the array starts (two consecutive tokens like ``array=`` and ``(``) or it is function (``function``, ``()`` and ``{``).
+#. The arrays are processed until the next closing bracket ``)``. After extraction, the parser tries to expand an array according to bash rules (``prefix{first,second}suffix`` constructions).
+#. The functions are just read until the closing bracket ``}`` and then reread whole text from the input string without a tokenization.
+
+All extracted fields are packed as ``ahriman.models.pkgbuild_patch.PkgbuildPatch`` and then can be used as ``ahriman.models.pkgbuild.Pkgbuild`` instance.
+
+The PKGBUILD class also provides some additional functions on top of that:
+
+* Ability to extract fields defined inside ``package*()`` functions, which are in particular used for the multi-packages.
+* Shell substitution, which supports constructions ``$var`` (including ``${var}``), ``${var#(#)pattern}``, ``${var%(%)pattern}`` and ``${var/(/)pattern/replacement}`` (including ``#pattern`` and ``%pattern``).
+
+Additional features
+^^^^^^^^^^^^^^^^^^^
+
+Some features require optional dependencies to be installed:
+
+* ``gnupg`` application for package and repository sign feature.
+* ``rsync`` application for rsync based repository sync.
+* ``boto3`` python package for ``S3`` sync.
+* ``Jinja2`` python package for HTML report generation (it is also used by web application).
+
+Web application
+---------------
+
+Web application requires the following python packages to be installed:
+
+* Core part requires ``aiohttp`` (application itself), ``aiohttp_jinja2`` and ``Jinja2`` (HTML generation from templates).
+* Additional web features also require ``aiohttp-apispec`` (autogenerated documentation), ``aiohttp_cors`` (CORS support, required by documentation).
+* In addition, authorization feature requires ``aiohttp_security``, ``aiohttp_session`` and ``cryptography``.
+* In addition to base authorization dependencies, OAuth2 also requires ``aioauth-client`` library.
+* In addition if you would like to disable authorization for local access (recommended way in order to run the application itself with reporting support), the ``requests-unixsocket2`` library is required.
+
+Middlewares
+^^^^^^^^^^^
+
+Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
+
+HEAD and OPTIONS requests
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``HEAD`` request is automatically generated by ``ahriman.web.views.base.BaseView`` class. It just calls ``GET`` method, removes any data from body and returns the result. In case if no ``GET`` method available for this view, the ``aiohttp.web.HTTPMethodNotAllowed`` exception will be raised.
+
+On the other side, ``OPTIONS`` method is implemented in the ``ahriman.web.middlewares.exception_handler.exception_handler`` middleware. In case if ``aiohttp.web.HTTPMethodNotAllowed`` exception is raised and original method was ``OPTIONS``, the middleware handles it, converts to valid request and returns response to user.
+
+Web views
+^^^^^^^^^
+
+All web views are defined in separated package and derived from ``ahriman.web.views.base.Base`` class which provides typed interfaces for web application. 
+
+REST API supports only JSON data.
+
+Different APIs are separated into different packages:
+
+* ``ahriman.web.views.api`` not a real API, but some views which provide OpenAPI support.
+* ``ahriman.web.views.*.auditlog`` provides event log API.
+* ``ahriman.web.views.*.distributed`` is an API for builders interaction for multi-node setup.
+* ``ahriman.web.views.*.packages`` contains views which provide information about existing packages.
+* ``ahriman.web.views.*.service`` provides views for application controls.
+* ``ahriman.web.views.*.status`` package provides REST API for application reporting.
+* ``ahriman.web.views.*.user`` package provides login and logout methods which can be called without authorization.
+
+The views are also divided by supporting API versions (e.g. ``v1``, ``v2``).
+
+Templating
+^^^^^^^^^^
+
+Package provides base jinja templates which can be overridden by settings. Vanilla templates actively use bootstrap library.
+
+Requests and scopes
+^^^^^^^^^^^^^^^^^^^
+
+Service provides optional authorization which can be turned on in settings. In order to control user access there are two levels of authorization - read-only (only GET-like requests) and write (anything), settings for which are provided by each web view directly.
+
+If this feature is configured any request will be prohibited without authentication. In addition, configuration flag ``auth.allow_read_only`` can be used in order to allow read-only operations - reading index page and packages - without authorization.
+
+For authenticated users it uses encrypted session cookies to store tokens; encryption key is read from configuration or generated at the start of the application if not set. It also stores expiration time of the session inside.
+
+External calls
+^^^^^^^^^^^^^^
+
+Web application provides external calls to control main service. It spawns child process with specific arguments and waits for its termination. This feature must be used either with authorization or in safe (i.e. when status page is not available world-wide) environment.
+
+For most actions it also extracts user from authentication (if provided) and passes it to the underlying process.

docs/command-line.rst

@@ -0,0 +1,10 @@
+Commands reference
+==================
+
+ahriman
+-------
+
+.. argparse::
+   :module: ahriman.application.ahriman
+   :func: _parser
+   :prog: ahriman

docs/conf.py

@@ -0,0 +1,100 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import datetime
+import sys
+
+from pathlib import Path
+
+from ahriman import __version__
+
+
+basedir = Path(__file__).resolve().parent.parent / "src"
+sys.path.insert(0, str(basedir))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "ahriman"
+copyright = f"2021-{datetime.date.today().year}, ahriman team"
+author = "ahriman team"
+
+# The full version, including alpha/beta/rc tags
+release = __version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+    "sphinxarg.ext",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+html_logo = "_static/logo.svg"
+
+add_module_names = False
+
+modindex_common_prefix = [
+    "ahriman.application.",
+    "ahriman.core.",
+    "ahriman.models.",
+    "ahriman.web.",
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autoclass_content = "both"
+
+autodoc_member_order = "groupwise"
+
+autodoc_mock_imports = ["cryptography", "pyalpm"]
+
+autodoc_default_options = {
+    "no-undoc-members": True,
+}
+
+graphviz_output_format = "svg"

docs/configuration.md

@@ -1,174 +0,0 @@
-# ahriman configuration
-
-Some groups can be specified for each architecture separately. E.g. if there are `build` and `build:x86_64` groups it will use the option from `build:x86_64` for the `x86_64` architecture and `build` for any other (architecture specific group has higher priority). In case if both groups are presented, architecture specific options will be merged into global ones overriding them.
-
-Some values have list of strings type. Those values will be read in the same way as shell does:
-
-* By default, it splits value by spaces excluding empty elements. 
-* In case if quotation mark (`"` or `'`) will be found, any spaces inside will be ignored.
-* In order to use quotation mark inside value it is required to put it to another quotation mark, e.g. `wor"'"d "with quote"` will be parsed as `["wor'd", "with quote"]` and vice versa.
-* Unclosed quotation mark is not allowed and will rise an exception.
-
-## `settings` group
-
-Base configuration settings.
-
-* `include` - path to directory with configuration files overrides, string, required.
-* `logging` - path to logging configuration, string, required. Check `logging.ini` for reference.
-
-## `alpm` group
-
-libalpm and AUR related configuration.
-
-* `aur_url` - base url for AUR, string, required.
-* `database` - path to pacman local database cache, string, required.
-* `repositories` - list of pacman repositories, space separated list of strings, required.
-* `root` - root for alpm library, string, required.
-
-## `auth` group
-
-Base authorization settings. `OAuth` provider requires `aioauth-client` library to be installed.
-
-* `target` - specifies authorization provider, string, optional, default `disabled`. Allowed values are `disabled`, `configuration`, `oauth`.
-* `client_id` - OAuth2 application client ID, string, required in case if `oauth` is used.
-* `client_secret` - OAuth2 application client secret key, string, required in case if `oauth` is used.
-* `max_age` - parameter which controls both cookie expiration and token expiration inside the service, integer, optional, default is 7 days.
-* `oauth_provider` - OAuth2 provider class name as is in `aioauth-client` (e.g. `GoogleClient`, `GithubClient` etc), string, required in case if `oauth` is used.
-* `oauth_scopes` - scopes list for OAuth2 provider, which will allow retrieving user email (which is used for checking user permissions), e.g. `https://www.googleapis.com/auth/userinfo.email` for `GoogleClient` or `user:email` for `GithubClient`, space separated list of strings, required in case if `oauth` is used.
-* `safe_build_status` - allow requesting status page without authorization, boolean, required.
-* `salt` - password hash salt, string, required in case if authorization enabled (automatically generated by `create-user` subcommand).
-
-## `auth:*` groups
-
-Authorization mapping. Group name must refer to user access level, i.e. it should be one of `auth:read` (read hidden pages), `auth:write` (everything is allowed).
-
-Key is always username (case-insensitive), option value depends on authorization provider:
-
-* `OAuth` - by default requires only usernames and ignores values. But in case of direct login method call (via POST request) it will act as `Mapping` authorization method.
-* `Mapping` (default) - reads salted password hashes from values, uses SHA512 in order to hash passwords. Password can be set by using `user-add` subcommand.
-
-## `build:*` groups
-
-Build related configuration. Group name can refer to architecture, e.g. `build:x86_64` can be used for x86_64 architecture specific settings.
-
-* `archbuild_flags` - additional flags passed to `archbuild` command, space separated list of strings, optional.
-* `build_command` - default build command, string, required.
-* `ignore_packages` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
-* `makepkg_flags` - additional flags passed to `makepkg` command, space separated list of strings, optional.
-* `makechrootpkg_flags` - additional flags passed to `makechrootpkg` command, space separated list of strings, optional.
-
-## `repository` group
-
-Base repository settings.
-
-* `name` - repository name, string, required.
-* `root` - root path for application, string, required.
-
-## `sign:*` groups
-
-Settings for signing packages or repository. Group name can refer to architecture, e.g. `sign:x86_64` can be used for x86_64 architecture specific settings.
-
-* `target` - configuration flag to enable signing, space separated list of strings, required. Allowed values are `package` (sign each package separately), `repository` (sign repository database file).
-* `key` - default PGP key, string, required. This key will also be used for database signing if enabled.
-* `key_*` settings - PGP key which will be used for specific packages, string, optional. For example, if there is `key_yay` option the specified key will be used for yay package and default key for others.
-
-## `report` group
-
-Report generation settings.
-
-* `target` - list of reports to be generated, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. `somerandomname` must point to existing section, `email` must point to one of `email` of `email:x86_64` (the one with architecture has higher priority). 
-
-Type will be read from several ways:
-
-* In case if `type` option set inside the section, it will be used.
-* Otherwise, it will look for type from section name removing architecture name.
-* And finally, it will use section name as type.
-
-### `email` type
-
-Section name must be either `email` (plus optional architecture name, e.g. `email:x86_64`) or random name with `type` set.
-
-* `type` - type of the report, string, optional, must be set to `email` if exists.
-* `full_template_path` - path to Jinja2 template for full package description index, string, optional.
-* `homepage` - link to homepage, string, optional.
-* `host` - SMTP host for sending emails, string, required.
-* `link_path` - prefix for HTML links, string, required.
-* `no_empty_report` - skip report generation for empty packages list, boolean, optional, default `yes`.
-* `password` - SMTP password to authenticate, string, optional.
-* `port` - SMTP port for sending emails, int, required.
-* `receivers` - SMTP receiver addresses, space separated list of strings, required.
-* `sender` - SMTP sender address, string, required.
-* `ssl` - SSL mode for SMTP connection, one of `ssl`, `starttls`, `disabled`, optional, default `disabled`.
-* `template_path` - path to Jinja2 template, string, required.
-* `user` - SMTP user to authenticate, string, optional.
-
-### `html` type
-
-Section name must be either `html` (plus optional architecture name, e.g. `html:x86_64`) or random name with `type` set.
-
-* `type` - type of the report, string, optional, must be set to `html` if exists.
-* `path` - path to html report file, string, required.
-* `homepage` - link to homepage, string, optional.
-* `link_path` - prefix for HTML links, string, required.
-* `template_path` - path to Jinja2 template, string, required.
-
-## `upload` group
-
-Remote synchronization settings.
-
-* `target` - list of synchronizations to be used, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. `somerandomname` must point to existing section, `github` must point to one of `github` of `github:x86_64` (with architecture it has higher priority).
-
-Type will be read from several ways:
-
-* In case if `type` option set inside the section, it will be used.
-* Otherwise, it will look for type from section name removing architecture name.
-* And finally, it will use section name as type.
-
-### `github` type
-
-This feature requires Github key creation (see below). Section name must be either `github` (plus optional architecture name, e.g. `github:x86_64`) or random name with `type` set.
-
-* `type` - type of the upload, string, optional, must be set to `github` if exists.
-* `owner` - Github repository owner, string, required.
-* `password` - created Github API key. In order to create it do the following:
-  1. Go to [settings page](https://github.com/settings/profile).
-  2. Switch to [developers settings](https://github.com/settings/apps).
-  3. Switch to [personal access tokens](https://github.com/settings/tokens).
-  4. Generate new token. Required scope is `public_repo` (or `repo` for private repository support).
-* `repository` - Github repository name, string, required. Repository must be created before any action and must have active branch (e.g. with readme).
-* `username` - Github authorization user, string, required. Basically the same as `owner`.
-
-### `rsync` type
-
-Requires `rsync` package to be installed. Do not forget to configure ssh for user `ahriman`. Section name must be either `rsync` (plus optional architecture name, e.g. `rsync:x86_64`) or random name with `type` set.
-
-* `type` - type of the upload, string, optional, must be set to `rsync` if exists.
-* `command` - rsync command to run, space separated list of string, required.
-* `remote` - remote server to rsync (e.g. `1.2.3.4:path/to/sync`), string, required.
-
-### `s3` type
-
-Requires `boto3` library to be installed. Section name must be either `s3` (plus optional architecture name, e.g. `s3:x86_64`) or random name with `type` set.
-
-* `type` - type of the upload, string, optional, must be set to `github` if exists.
-* `access_key` - AWS access key ID, string, required.
-* `bucket` - bucket name (e.g. `bucket`), string, required.
-* `chunk_size` - chunk size for calculating entity tags, int, optional, default 8 * 1024 * 1024.
-* `region` - bucket region (e.g. `eu-central-1`), string, required.
-* `secret_key` - AWS secret access key, string, required.
-
-## `web:*` groups
-
-Web server settings. If any of `host`/`port` is not set, web integration will be disabled. Group name can refer to architecture, e.g. `web:x86_64` can be used for x86_64 architecture specific settings. This feature requires `aiohttp` libraries to be installed.
-
-* `address` - optional address in form `proto://host:port` (`port` can be omitted in case of default `proto` ports), will be used instead of `http://{host}:{port}` in case if set, string, optional. This option is required in case if `OAuth` provider is used.
-* `debug` - enable debug toolbar, boolean, optional, default `no`.
-* `debug_check_host` - check hosts to access debug toolbar, boolean, optional, default `no`.
-* `debug_allowed_hosts` - allowed hosts to get access to debug toolbar, space separated list of string, optional.
-* `host` - host to bind, string, optional.
-* `index_url` - full url of the repository index page, string, optional.
-* `password` - password to authorize in web service in order to update service status, string, required in case if authorization enabled.  
-* `port` - port to bind, int, optional.
-* `static_path` - path to directory with static files, string, required.
-* `templates` - path to templates directory, string, required.
-* `username` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.  

docs/configuration.rst

@@ -0,0 +1,425 @@
+Configuration
+=============
+
+Some groups can be specified for each architecture and/or repository separately. E.g. if there are ``build`` and ``build:x86_64`` groups it will use an option from ``build:x86_64`` for the ``x86_64`` architecture and ``build`` for any other (architecture specific group has higher priority). In case if both groups are presented, architecture specific options will be merged into global ones overriding them. The order which will be used for option resolution is the following:
+
+#. Repository and architecture specific, e.g. ``build:aur:x86_64``.
+#. Repository specific, e.g. ``build:aur``.
+#. Architecture specific, e.g. ``build:x86_64``.
+#. Default section, e.g. ``build``.
+
+There are two variable types which have been added to default ones, they are paths and lists. List values will be read in the same way as shell does:
+
+* By default, it splits value by spaces excluding empty elements. 
+* In case if quotation mark (``"`` or ``'``) will be found, any spaces inside will be ignored.
+* In order to use quotation mark inside value it is required to put it to another quotation mark, e.g. ``wor"'"d "with quote"`` will be parsed as ``["wor'd", "with quote"]`` and vice versa.
+* Unclosed quotation mark is not allowed and will raise an exception.
+
+It is also possible to split list option between multiple declarations. To do so, append key name with ``[]`` (like PHP, sorry!), e.g.:
+
+.. code-block:: ini
+
+   [section]
+   list[] = value1
+   list[] = value2
+
+will lead to ``${section:list}`` value to be set to ``value1 value2``. The values will be set in order of appearance, meaning that values which appear in different include files will be set in alphabetical order of file names. In order to reset list values, set option to empty string, e.g.:
+
+.. code-block:: ini
+
+   [section]
+   list[] = value1
+   list[] =
+   list[] = value2
+   list[] = value3
+
+will set option ``${section:list}`` to ``value2 value3``. Alternatively, setting the original option (e.g. ``list`` in the example above) will also reset value, though the subsequent options with leading ``[]`` will append the previous value.
+
+Path values, except for casting to ``pathlib.Path`` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to ``ahriman.ini.d/logging.ini`` and root configuration path is ``/etc/ahriman.ini``, the value will be expanded to ``/etc/ahriman.ini.d/logging.ini``. In order to disable path expand, use the full path, e.g. ``/etc/ahriman.ini.d/logging.ini``.
+
+Configuration allows string interpolation from the same configuration file, e.g.:
+
+.. code-block:: ini
+
+   [section]
+   key = ${another_key}
+   another_key = value
+
+will read value for the ``key`` option from ``another_key`` in the same section. In case if the cross-section reference is required, the ``${section:another_key}`` notation must be used. It also allows string interpolation from environment variables, e.g.:
+
+.. code-block:: ini
+
+   [section]
+   key = $SECRET
+
+will try to read value from ``SECRET`` environment variable. In case if the required environment variable wasn't found, it will keep original value (i.e. ``$SECRET`` in the example). Dollar sign can be set as ``$$``. All those interpolations will be applied in succession and - expected to be - recursively, e.g. the following configuration:
+
+.. code-block:: ini
+
+   [section1]
+   key = ${section2:key}
+
+   [section2]
+   key = ${home}
+   home = $HOME
+
+will eventually lead ``key`` option in section ``section1`` to be set to the value of ``HOME`` environment variable (if available).
+
+There is also additional subcommand which will allow to validate configuration and print found errors. In order to do so, run ``service-config-validate`` subcommand, e.g.:
+
+.. code-block:: shell
+
+   ahriman service-config-validate
+
+It will check current settings on common errors and compare configuration with known schema.
+
+``settings`` group
+------------------
+
+Base configuration settings.
+
+* ``apply_migrations`` - perform database migrations on the application start, boolean, optional, default ``yes``. Useful if you are using git version. Note, however, that this option must be changed only if you know what to do and going to handle migrations manually.
+* ``database`` - path to the application SQLite database, string, required.
+* ``include`` - path to directory with configuration files overrides, string, optional. Files will be read in alphabetical order.
+* ``keep_last_logs`` - amount of build logs to be kept for each package, integer, optional ,default ``0``. Logs will be cleared at the end of each process.
+* ``logging`` - path to logging configuration, string, required. Check ``logging.ini`` for reference.
+
+``alpm:*`` groups
+-----------------
+
+libalpm and AUR related configuration. Group name can refer to architecture, e.g. ``alpm:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``database`` - path to pacman system database cache, string, required.
+* ``mirror`` - package database mirror used by pacman for synchronization, string, required. This option supports standard pacman substitutions with ``$arch`` and ``$repo``. Note that the mentioned mirror should contain all repositories which are set by ``alpm.repositories`` option.
+* ``repositories`` - list of pacman repositories, used for package search, space separated list of strings, required.
+* ``root`` - root for alpm library, string, required. In the most cases it must point to the system root.
+* ``sync_files_database`` - download files database from mirror, boolean, required.
+* ``use_ahriman_cache`` - use local pacman package cache instead of system one, boolean, required. With this option enabled you might want to refresh database periodically (available as additional flag for some subcommands). If set to ``no``, databases must be synchronized manually.
+
+``auth`` group
+--------------
+
+Base authorization settings. ``OAuth`` provider requires ``aioauth-client`` library to be installed.
+
+* ``target`` - specifies authorization provider, string, optional, default ``disabled``. Allowed values are ``disabled``, ``configuration``, ``oauth``, ``pam``.
+* ``allow_read_only`` - allow requesting status APIs without authorization, boolean, required.
+* ``client_id`` - OAuth2 application client ID, string, required in case if ``oauth`` is used.
+* ``client_secret`` - OAuth2 application client secret key, string, required in case if ``oauth`` is used.
+* ``cookie_secret_key`` - secret key which will be used for cookies encryption, string, optional. It must be 32 bytes URL-safe base64-encoded and can be generated as following ``base64.urlsafe_b64encode(os.urandom(32)).decode("utf8")``. If not set, it will be generated automatically; note, however, that in this case, all sessions will be automatically invalidated during the service restart.
+* ``full_access_group`` - name of the secondary group (e.g. ``wheel``) to be used as admin group in the service, string, required in case if ``pam`` is used.
+* ``max_age`` - parameter which controls both cookie expiration and token expiration inside the service in seconds, integer, optional, default is 7 days.
+* ``oauth_icon`` - OAuth2 login button icon, string, optional, default is ``google``. Must be valid `Bootstrap icon <https://icons.getbootstrap.com/>`__ name.
+* ``oauth_provider`` - OAuth2 provider class name as is in ``aioauth-client`` (e.g. ``GoogleClient``, ``GithubClient`` etc), string, required in case if ``oauth`` is used.
+* ``oauth_scopes`` - scopes list for OAuth2 provider, which will allow retrieving user email (which is used for checking user permissions), e.g. ``https://www.googleapis.com/auth/userinfo.email`` for ``GoogleClient`` or ``user:email`` for ``GithubClient``, space separated list of strings, required in case if ``oauth`` is used.
+* ``permit_root_login`` - allow login as root user, boolean, optional, default ``no``.
+* ``salt`` - additional password hash salt, string, optional.
+
+Authorized users are stored inside internal database, if any of external providers (e.g. ``oauth``) are used, the password field for non-service users must be empty.
+
+``build:*`` groups
+------------------
+
+Build related configuration. Group name can refer to architecture, e.g. ``build:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``archbuild_flags`` - additional flags passed to ``archbuild`` command, space separated list of strings, optional.
+* ``build_command`` - default build command, string, required.
+* ``ignore_packages`` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
+* ``include_debug_packages`` - distribute debug packages, boolean, optional, default ``yes``.
+* ``makepkg_flags`` - additional flags passed to ``makepkg`` command, space separated list of strings, optional.
+* ``makechrootpkg_flags`` - additional flags passed to ``makechrootpkg`` command, space separated list of strings, optional.
+* ``scan_paths`` - paths to be used for implicit dependencies scan, space separated list of strings, optional. If any of those paths is matched against the path, it will be added to the allowed list.
+* ``triggers`` - list of ``ahriman.core.triggers.Trigger`` class implementation (e.g. ``ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger``) which will be loaded and run at the end of processing, space separated list of strings, optional. You can also specify triggers by their paths, e.g. ``/usr/lib/python3.10/site-packages/ahriman/core/report/report.py.ReportTrigger``. Triggers are run in the order of definition.
+* ``triggers_known`` - optional list of ``ahriman.core.triggers.Trigger`` class implementations which are not run automatically and used only for trigger discovery and configuration validation.
+* ``vcs_allowed_age`` - maximal age in seconds of the VCS packages before their version will be updated with its remote source, integer, optional, default is 7 days.
+* ``workers`` - list of worker nodes addresses used for build process, space separated list of strings, optional. Each worker address must be valid and reachable URL, e.g. ``https://10.0.0.1:8080``. If none set, the build process will be run on the current node. There is also special trigger which loads this value based on the list of the discovered nodes.
+
+``repository`` group
+--------------------
+
+Base repository settings.
+
+* ``root`` - root path for application, string, required.
+
+``sign:*`` groups
+-----------------
+
+Settings for signing packages or repository. Group name can refer to architecture, e.g. ``sign:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``target`` - configuration flag to enable signing, space separated list of strings, required. Allowed values are ``package`` (sign each package separately), ``repository`` (sign repository database file).
+* ``key`` - default PGP key, string, required. This key will also be used for database signing if enabled.
+
+``status`` group
+----------------
+
+Reporting to web service related settings. In most cases there is fallback to web section settings.
+
+* ``enabled`` - enable reporting to web service, boolean, optional, default ``yes`` for backward compatibility.
+* ``address`` - remote web service address with protocol, string, optional. In case of websocket, the ``http+unix`` scheme and URL encoded address (e.g. ``%2Fvar%2Flib%2Fahriman`` for ``/var/lib/ahriman``) must be used, e.g. ``http+unix://%2Fvar%2Flib%2Fahriman%2Fsocket``. In case if none set, it will be guessed from ``web`` section.
+* ``password`` - password to authorize in web service in order to update service status, string, required in case if authorization enabled.
+* ``suppress_http_log_errors`` - suppress HTTP log errors, boolean, optional, default ``no``. If set to ``yes``, any HTTP log errors (e.g. if web server is not available, but HTTP logging is enabled) will be suppressed.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+* ``username`` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.
+
+``web`` group
+-------------
+
+Web server settings. This feature requires ``aiohttp`` libraries to be installed.
+
+* ``address`` - optional address in form ``proto://host:port`` (``port`` can be omitted in case of default ``proto`` ports), will be used instead of ``http://{host}:{port}`` in case if set, string, optional. This option is required in case if ``OAuth`` provider is used.
+* ``enable_archive_upload`` - allow to upload packages via HTTP (i.e. call of ``/api/v1/service/upload`` uri), boolean, optional, default ``no``.
+* ``host`` - host to bind, string, optional.
+* ``index_url`` - full URL of the repository index page, string, optional.
+* ``max_body_size`` - max body size in bytes to be validated for archive upload, integer, optional. If not set, validation will be disabled.
+* ``port`` - port to bind, integer, optional.
+* ``service_only`` - disable status routes (including logs), boolean, optional, default ``no``.
+* ``static_path`` - path to directory with static files, string, required.
+* ``templates`` - path to templates directories, space separated list of paths, required.
+* ``unix_socket`` - path to the listening unix socket, string, optional. If set, server will create the socket on the specified address which can (and will) be used by application. Note, that unlike usual host/port configuration, unix socket allows to perform requests without authorization.
+* ``unix_socket_unsafe`` - set unsafe (o+w) permissions to unix socket, boolean, optional, default ``yes``. This option is enabled by default, because it is supposed that unix socket is created in safe environment (only web service is supposed to be used in unsafe), but it can be disabled by configuration.
+* ``wait_timeout`` - wait timeout in seconds, maximum amount of time to be waited before lock will be free, integer, optional.
+
+``keyring`` group
+--------------------
+
+Keyring package generator plugin.
+
+* ``target`` - list of generator settings sections, space separated list of strings, required. It must point to valid section name.
+
+Keyring generator plugin
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``type`` - type of the generator, string, optional, must be set to ``keyring-generator`` if exists.
+* ``description`` - keyring package description, string, optional, default is ``repo PGP keyring``, where ``repo`` is the repository name.
+* ``homepage`` - URL to homepage location if any, string, optional.
+* ``license`` - list of licenses which are applied to this package, space separated list of strings, optional, default is ``Unlicense``.
+* ``package`` - keyring package name, string, optional, default is ``repo-keyring``, where ``repo`` is the repository name.
+* ``packagers`` - list of packagers keys, space separated list of strings, optional, if not set, the user keys from database will be used.
+* ``revoked`` - list of revoked packagers keys, space separated list of strings, optional.
+* ``trusted`` - list of master keys, space separated list of strings, optional, if not set, the ``key`` option from ``sign`` group will be used.
+
+``mirrorlist`` group
+--------------------
+
+Mirrorlist package generator plugin.
+
+* ``target`` - list of generator settings sections, space separated list of strings, required. It must point to valid section name.
+
+Mirrorlist generator plugin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``type`` - type of the generator, string, optional, must be set to ``mirrorlist-generator`` if exists.
+* ``description`` - mirrorlist package description, string, optional, default is ``repo mirror list for use by pacman``, where ``repo`` is the repository name.
+* ``homepage`` - URL to homepage location if any, string, optional.
+* ``license`` - list of licenses which are applied to this package, space separated list of strings, optional, default is ``Unlicense``.
+* ``package`` - mirrorlist package name, string, optional, default is ``repo-mirrorlist``, where ``repo`` is the repository name.
+* ``path`` - absolute path to generated mirrorlist file, string, optional, default is ``/etc/pacman.d/repo-mirrorlist``, where ``repo`` is the repository name.
+* ``servers`` - list of repository mirrors, space separated list of strings, required.
+
+``remote-pull`` group
+---------------------
+
+Remote git source synchronization settings. Unlike ``upload`` triggers those triggers are used for PKGBUILD synchronization - fetch from remote repository PKGBUILDs before updating process.
+
+It supports authorization; to do so you'd need to prefix the URL with authorization part, e.g. ``https://key:token@github.com/arcan1s/ahriman.git``. It is highly recommended to use application tokens instead of your user authorization details. Alternatively, you can use any other option supported by git, e.g.:
+
+* by SSH key: generate SSH key as ``ahriman`` user and put public part of it to the repository keys.
+* by git credentials helper: consult with the `related man page <https://git-scm.com/docs/gitcredentials>`__.
+
+Available options are:
+
+* ``target`` - list of remote pull triggers to be used, space separated list of strings, optional, defaults to ``gitremote``. It must point to valid section (or to section with architecture), e.g. ``gitremote`` must point to either ``gitremote`` or ``gitremote:x86_64`` (the one with architecture has higher priority).
+
+Remote pull trigger
+^^^^^^^^^^^^^^^^^^^
+
+* ``pull_url`` - URL of the remote repository from which PKGBUILDs can be pulled before build process, string, required.
+* ``pull_branch`` - branch of the remote repository from which PKGBUILDs can be pulled before build process, string, optional, default is ``master``.
+
+``remote-push`` group
+---------------------
+
+Remote git source synchronization settings. Same as remote pull triggers those triggers are used for PKGBUILD synchronization - push updated PKGBUILDs to the remote repository after build process.
+
+It supports authorization; to do so you'd need to prefix the URL with authorization part, e.g. ``https://key:token@github.com/arcan1s/ahriman.git``. It is highly recommended to use application tokens instead of your user authorization details. Alternatively, you can use any other option supported by git, e.g.:
+
+* by SSH key: generate SSH key as ``ahriman`` user and put public part of it to the repository keys.
+* by git credentials helper: consult with the `related man page <https://git-scm.com/docs/gitcredentials>`__.
+
+Available options are:
+
+* ``target`` - list of remote push triggers to be used, space separated list of strings, optional, defaults to ``gitremote``. It must point to valid section (or to section with architecture), e.g. ``gitremote`` must point to either ``gitremote`` or ``gitremote:x86_64`` (the one with architecture has higher priority).
+
+Remote push trigger
+^^^^^^^^^^^^^^^^^^^
+
+* ``commit_email`` - git commit email, string, optional, default is ``ahriman@localhost``.
+* ``commit_user`` - git commit user, string, optional, default is ``ahriman``.
+* ``push_url`` - URL of the remote repository to which PKGBUILDs should be pushed after build process, string, required.
+* ``push_branch`` - branch of the remote repository to which PKGBUILDs should be pushed after build process, string, optional, default is ``master``.
+
+``report`` group
+----------------
+
+Report generation settings.
+
+* ``target`` - list of reports to be generated, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``email`` must point to either ``email`` or ``email:x86_64`` (the one with architecture has higher priority).
+
+Type will be read from several sources:
+
+* In case if ``type`` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+``console`` type
+^^^^^^^^^^^^^^^^
+
+Section name must be either ``console`` (plus optional architecture name, e.g. ``console:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``console`` if exists.
+* ``use_utf`` - use utf8 symbols in output if set and ascii otherwise, boolean, optional, default ``yes``.
+
+``email`` type
+^^^^^^^^^^^^^^
+
+Section name must be either ``email`` (plus optional architecture name, e.g. ``email:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``email`` if exists.
+* ``homepage`` - link to homepage, string, optional.
+* ``host`` - SMTP host for sending emails, string, required.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``no_empty_report`` - skip report generation for empty packages list, boolean, optional, default ``yes``.
+* ``password`` - SMTP password to authenticate, string, optional.
+* ``port`` - SMTP port for sending emails, integer, required.
+* ``receivers`` - SMTP receiver addresses, space separated list of strings, required.
+* ``rss_url`` - link to RSS feed, string, optional.
+* ``sender`` - SMTP sender address, string, required.
+* ``ssl`` - SSL mode for SMTP connection, one of ``ssl``, ``starttls``, ``disabled``, optional, default ``disabled``.
+* ``template`` - Jinja2 template name, string, required.
+* ``template_full`` - Jinja2 template name for full package description index, string, optional.
+* ``templates`` - path to templates directories, space separated list of paths, required.
+* ``user`` - SMTP user to authenticate, string, optional.
+
+``html`` type
+^^^^^^^^^^^^^
+
+Section name must be either ``html`` (plus optional architecture name, e.g. ``html:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``html`` if exists.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``path`` - path to HTML report file, string, required.
+* ``rss_url`` - link to RSS feed, string, optional.
+* ``template`` - Jinja2 template name, string, required.
+* ``templates`` - path to templates directories, space separated list of paths, required.
+
+``remote-call`` type
+^^^^^^^^^^^^^^^^^^^^
+
+Section name must be either ``remote-call`` (plus optional architecture name, e.g. ``remote-call:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``remote-call`` if exists.
+* ``aur`` - check for AUR packages updates, boolean, optional, default ``no``.
+* ``local`` - check for local packages updates, boolean, optional, default ``no``.
+* ``manual`` - update manually built packages, boolean, optional, default ``no``.
+* ``wait_timeout`` - maximum amount of time in seconds to be waited before remote process will be terminated, integer, optional, default ``-1``.
+
+``rss`` type
+^^^^^^^^^^^^
+
+Section name must be either ``rss`` (plus optional architecture name, e.g. ``rss:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``rss`` if exists.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``max_entries`` - maximal amount of entries to be included to the report, negative means no limit, integer, optional, default ``-1``.
+* ``path`` - path to generated RSS file, string, required.
+* ``rss_url`` - link to RSS feed, string, optional.
+* ``template`` - Jinja2 template name, string, required.
+* ``templates`` - path to templates directories, space separated list of paths, required.
+
+``telegram`` type
+^^^^^^^^^^^^^^^^^
+
+Section name must be either ``telegram`` (plus optional architecture name, e.g. ``telegram:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``telegram`` if exists.
+* ``api_key`` - telegram bot API key, string, required. Please refer FAQ about how to create chat and bot
+* ``chat_id`` - telegram chat id, either string with ``@`` or integer value, required.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``rss_url`` - link to RSS feed, string, optional.
+* ``template`` - Jinja2 template name, string, required.
+* ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``, ``HTML``, ``Markdown``, string, optional, default ``HTML``.
+* ``templates`` - path to templates directories, space separated list of paths, required.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+
+``upload`` group
+----------------
+
+Remote synchronization settings.
+
+* ``target`` - list of synchronizations to be used, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``github`` must point to one of ``github`` of ``github:x86_64`` (with architecture it has higher priority).
+
+Type will be read from several sources:
+
+* In case if ``type`` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+``github`` type
+^^^^^^^^^^^^^^^
+
+This feature requires GitHub key creation (see below). Section name must be either ``github`` (plus optional architecture name, e.g. ``github:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``github`` if exists.
+* ``owner`` - GitHub repository owner, string, required.
+* ``password`` - created GitHub API key. In order to create it do the following:
+
+  #. Go to `settings page <https://github.com/settings/profile>`__.
+  #. Switch to `developers settings <https://github.com/settings/apps>`__.
+  #. Switch to `personal access tokens <https://github.com/settings/tokens>`__.
+  #. Generate new token. Required scope is ``public_repo`` (or ``repo`` for private repository support).
+
+* ``repository`` - GitHub repository name, string, required. Repository must be created before any action and must have active branch (e.g. with readme).
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+* ``use_full_release_name`` - if set to ``yes``, the release will contain both repository name and architecture, and only architecture otherwise, boolean, optional, default ``no`` (legacy behavior).
+* ``username`` - GitHub authorization user, string, required. Basically the same as ``owner``.
+
+``remote-service`` type
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Section name must be either ``remote-service`` (plus optional architecture name, e.g. ``remote-service:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``remote-service`` if exists.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+
+``rsync`` type
+^^^^^^^^^^^^^^
+
+Requires ``rsync`` package to be installed. Do not forget to configure ssh for user ``ahriman``. Section name must be either ``rsync`` (plus optional architecture name, e.g. ``rsync:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``rsync`` if exists.
+* ``command`` - rsync command to run, space separated list of string, required.
+* ``remote`` - remote server to rsync (e.g. ``ahriman@10.0.0.1:/srv/repo``), string, required.
+
+``s3`` type
+^^^^^^^^^^^
+
+Requires ``boto3`` library to be installed. Section name must be either ``s3`` (plus optional architecture name, e.g. ``s3:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``s3`` if exists.
+* ``access_key`` - AWS access key ID, string, required.
+* ``bucket`` - bucket name (e.g. ``bucket``), string, required.
+* ``chunk_size`` - chunk size for calculating entity tags, integer, optional, default 8 * 1024 * 1024.
+* ``object_path`` - path prefix for stored objects, string, optional. If none set, the prefix as in repository tree will be used.
+* ``region`` - bucket region (e.g. ``eu-central-1``), string, required.
+* ``secret_key`` - AWS secret access key, string, required.
+
+``worker`` group
+----------------
+
+This section controls settings for ``ahriman.core.distributed.WorkerTrigger`` plugin.
+
+* ``address`` - address of the instance, string, required. Must be reachable for the master instance.
+* ``identifier`` - unique identifier of the instance, string, optional.
+* ``time_to_live`` - amount of time which remote worker will be considered alive in seconds, integer, optional, default is ``60``. The ping interval will be set automatically equal this value divided by 4.

docs/faq.md

@@ -1,479 +0,0 @@
-# FAQ
-
-## General topics
-
-### What is the purpose of the project?
-
-This project has been created in order to maintain self-hosted Arch Linux user repository without manual intervention - checking for updates and building packages.
-
-### How do I install it?
-
-TL;DR
-
-```shell
-yay -S ahriman
-sudo -u ahriman ahriman -a x86_64 init
-sudo ahriman -a x86_64 repo-setup --packager "ahriman bot <ahriman@example.com>" --repository "repository"
-systemctl enable --now ahriman@x86_64.timer
-```
-
-#### Long answer
-
-The idea is to install the package as usual, create working directory tree, create configuration for `sudo` and `devtools`. Detailed description of the setup instruction can be found [here](setup.md).
-
-### What does "architecture specific" mean? / How to configure for different architectures?
-
-Some sections can be configured per architecture. The service will merge architecture specific values into common settings. In order to specify settings for specific architecture you must point it in section name.
-
-For example, the section
-
-```ini
-[build]
-build_command = extra-x86_64-build
-```
-
-states that default build command is `extra-x86_64-build`. But if there is section
-
-```ini
-[build:i686]
-build_command = extra-i686-build
-```
-
-the `extra-i686-build` command will be used for `i686` architecture.
-
-### How to use reporter/upload settings?
-
-Normally you probably like to generate only one report for the specific type, e.g. only one email report. In order to do it you will need to have the following configuration:
-
-```ini
-[report]
-target = email
-
-[email]
-...
-```
-
-or in case of multiple architectures and _different_ reporting settings:
-
-```ini
-[report]
-target = email
-
-[email:i686]
-...
-
-[email:x86_64]
-...
-```
-
-But for some cases you would like to have multiple different reports with the same type (e.g. sending different templates to different addresses). For these cases you will need to specify section name in target and type in section, e.g. the following configuration can be used:
-
-```ini
-[report]
-target = email_1 email_2
-
-[email_1]
-type = email
-...
-
-[email_2]
-type = email
-...
-```
-
-### Okay, I've installed ahriman, how do I add new package?
-
-```shell
-sudo -u ahriman ahriman package-add ahriman --now
-```
-
-`--now` flag is totally optional and just run `repo-update` subcommand after the registering the new package, Thus the extended flow is the following:
-
-```shell
-sudo -u ahriman ahriman package-add ahriman
-sudo -u ahriman ahriman repo-update
-```
-
-### AUR is fine, but I would like to create package from local PKGBUILD
-
-TL;DR
-
-```shell
-sudo -u ahriman ahriman package-add /path/to/local/directory/with/PKGBUILD --now
-```
-
-Before using this command you will need to create local directory, put `PKGBUILD` there and generate `.SRCINFO` by using `makepkg --printsrcinfo > .SRCINFO` command. These packages will be stored locally and _will be ignored_ during automatic update; in order to update the package you will need to run `package-add` command again.
-
-### But I just wanted to change PKGBUILD from AUR a bit!
-
-Well it is supported also.
-
-1. Clone sources from AUR.
-2. Make changes you would like to (e.g. edit `PKGBUILD`, add external patches).
-3. Run `sudo -u ahriman ahriman patch-add /path/to/local/directory/with/PKGBUILD`.
-
-The last command will calculate diff from current tree to the `HEAD` and will store it locally. Patches will be applied on any package actions (e.g. it can be used for dependency management).
-
-### Package build fails because it cannot validate PGP signature of source files
-
-TL;DR
-
-```shell
-sudo -u ahriman ahriman key-import ...
-```
-
-### How do I check if there are new commits for VCS packages?
-
-Normally the service handles VCS packages correctly, but it requires additional dependencies:
-
-```shell
-pacman -S breezy darcs mercurial subversion
-```
-
-### I would like to remove package because it is no longer needed/moved to official repositories
-
-```shell
-sudo -u ahriman ahriman package-remove ahriman
-```
-
-Also, there is command `repo-remove-unknown` which checks packages in AUR and local storage and removes ones which have been removed.
-
-Remove commands also remove any package files (patches, caches etc).
-
-### There is new major release of %library-name%, how do I rebuild packages?
-
-TL;DR
-
-```shell
-sudo -u ahriman ahriman repo-rebuild --depends-on python
-```
-
-You can even rebuild the whole repository (which is particular useful in case if you would like to change packager) if you do not supply `--depends-on` option.
-
-However, note that you do not need to rebuild repository in case if you just changed signing option, just use `repo-sign` command instead. 
-
-### Hmm, I have packages built, but how can I use it?
-
-Add the following lines to your `pacman.conf`:
-
-```ini
-[repository]
-Server = file:///var/lib/ahriman/repository/x86_64
-```
-
-(You might need to add `SigLevel` option according to the pacman documentation.)
-
-
-### I would like to serve the repository
-
-Easy. For example, nginx configuration (without SSL) will look like:
-
-```
-server {
-    listen 80;
-    server_name repo.example.com;
-
-    location / {
-        autoindex on;
-        root /var/lib/ahriman/repository;
-    }
-}
-```
-
-Example of the status page configuration is the following (status service is using 8080 port):
-
-```
-server {
-    listen 80;
-    server_name builds.example.com;
-
-    location / {
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarder-Proto $scheme;
-
-        proxy_pass http://127.0.0.1:8080;
-    }
-}
-```
-
-## Remote synchronization
-
-### Wait I would like to use the repository from another server
-
-There are several choices:
-
-1. Easy and cheap, just share your local files through the internet, e.g. for `nginx`:
-   
-    ```
-    server {
-        location /x86_64 {
-            root /var/lib/ahriman/repository/x86_64;
-            autoindex on;
-        }
-    }
-    ```
-   
-2. You can also upload your packages using `rsync` to any available server. In order to use it you would need to configure ahriman first:
-    
-    ```ini
-    [upload]
-    target = rsync
-    
-    [rsync]
-    remote = 192.168.0.1:/srv/repo
-    ```
-   
-    After that just add `/srv/repo` to the `pacman.conf` as usual. You can also upload to S3 (e.g. `Server = https://s3.eu-central-1.amazonaws.com/repository/x86_64`) or to Github (e.g. `Server = https://github.com/ahriman/repository/releases/download/x86_64`).
-
-### How do I configure S3?
-
-1. Install dependencies:
-
-   ```shell
-   pacman -S python-boto3
-   ```
-
-3. Create a bucket.
-4. Create user with write access to the bucket:
-
-    ```
-    {
-        "Version": "2012-10-17",
-        "Statement": [
-            {
-                "Sid": "ListObjectsInBucket",
-                "Effect": "Allow",
-                "Action": [
-                    "s3:ListBucket"
-                ],
-                "Resource": [
-                    "arn:aws:s3:::repository"
-                ]
-            },
-            {
-                "Sid": "AllObjectActions",
-                "Effect": "Allow",
-                "Action": "s3:*Object",
-                "Resource": [
-                    "arn:aws:s3:::repository/*"
-                ]
-            }
-        ]
-    }
-    ```
-
-5. Create an API key for the user and store it.
-6. Configure the service as following:
-
-    ```ini
-    [upload]
-    target = s3
-
-    [s3]
-    access_key = ...
-    bucket = repository
-    region = eu-central-1
-    secret_key = ...
-    ```
-   
-### How do I configure Github?
-
-1. Create a repository.
-2. [Create API key](https://github.com/settings/tokens) with scope `public_repo`.
-3. Configure the service as following:
-
-    ```ini
-    [upload]
-    target = github
-
-    [github]
-    owner = ahriman
-    password = ...
-    repository = repository
-    username = ahriman
-    ```
-
-## Reporting
-
-### I would like to get report to email
-
-1. Install dependencies:
-
-   ```shell
-   yay -S python-jinja
-   ```
-   
-2. Configure the service:
-
-   ```ini
-   [report]
-   target = email
-   
-   [email]
-   host = smtp.example.com
-   link_path = http://example.com/x86_64
-   password = ...
-   port = 465
-   receivers = me@example.com
-   sender = me@example.com
-   user = me@example.com
-   ```
-   
-### I'm using synchronization to S3 and would like to generate index page
-
-1. Install dependencies:
-
-   ```shell
-   yay -S python-jinja
-   ```
-   
-2. Configure the service:
-   
-   ```ini
-   [report]
-   target = html
-   
-   [html]
-   path = /var/lib/ahriman/repository/x86_64/index.html
-   link_path = http://example.com/x86_64
-   ```
-   
-After these steps `index.html` file will be automatically synced to S3
-
-## Web service
-
-### Readme mentions web interface, how do I use it?
-
-1. Install dependencies:
-
-   ```shell
-   yay -S python-aiohttp python-aiohttp-jinja2
-   ```
-
-2. Configure service:
-
-   ```ini
-   [web]
-   port = 8080
-   ```
-
-3. Start the web service `systemctl enable --now ahriman-web@x86_64`.
-
-### I would like to limit user access to the status page
-
-1. Install dependencies 😊:
-   
-   ```shell
-   yay -S python-aiohttp-security python-aiohttp-session python-cryptography
-   ```
-
-2. Configure the service to enable authorization:
-
-   ```ini
-   [auth]
-   target = configuration
-   ```
-   
-3. Create user for the service:
-
-   ```shell
-   sudo -u ahriman ahriman user-add --as-service -r write api
-   ```
-   
-   This command will ask for the password, just type it in stdin; _do not_ leave the field blank, user will not be able to authorize.
-
-4. Create end-user `sudo -u ahriman ahriman user-add -r write my-first-user` with password.
-5. Restart web service `systemctl restart ahriman-web@x86_64`.
-
-### I would like to use OAuth
-
-1. Create OAuth web application, download its `client_id` and `client_secret`.
-2. Guess what? Install dependencies:
-
-   ```shell
-   yay -S python-aiohttp-security python-aiohttp-session python-cryptography python-aioauth-client
-   ```
-   
-3. Configure the service:
-
-   ```ini
-   [auth]
-   target = oauth
-   client_id = ...
-   client_secret = ...
-   
-   [web]
-   address = https://example.com
-   ```
-   
-   Configure `oauth_provider` and `oauth_scopes` in case if you would like to use different from Google provider. Scope must grant access to user email. `web.address` is required to make callback URL available from internet.
-
-4. Create service user:
-
-   ```shell
-   sudo -u ahriman ahriman user-add --as-service -r write api
-   ```
-
-5. Create end-user `sudo -u ahriman ahriman user-add -r write my-first-user`. When it will ask for the password leave it blank.
-6. Restart web service `systemctl restart ahriman-web@x86_64`.
-
-## Other topics
-
-### How does it differ from %another-manager%?
-
-Short answer - I do not know.
-
-#### [archrepo2](https://github.com/lilydjwg/archrepo2)
-
-Don't know, haven't tried it. But it lacks of documentation at least.
-
-* Web interface.
-* No synchronization and reporting.
-* `archrepo2` actively uses direct shell calls and `yaourt` components.
-* It has constantly running process instead of timer process (it is not pro or con).
-
-#### [repoctl](https://github.com/cassava/repoctl)
-
-* Web interface.
-* No reporting.
-* Local packages and patches support.
-* Some actions are not fully automated (e.g. package update still requires manual intervention for the build itself). 
-* `repoctl` has better AUR interaction features. With colors!
-* `repoctl` has much easier configuration and even completion.
-* `repoctl` is able to store old packages.
-* Ability to host repository from same command vs external services (e.g. nginx) in `ahriman`.
-
-#### [repo-scripts](https://github.com/arcan1s/repo-scripts)
-
-Though originally I've created ahriman by trying to improve the project, it still lacks a lot of features:
-
-* Web interface.
-* Better reporting with template support.
-* Synchronization features (there was only `rsync` based).
-* Local packages and patches support.
-* No dependency management.
-* And so on.
-
-`repo-scripts` also have bad architecture and bad quality code and uses out-of-dated `yaourt` and `package-query`.
-
-### I would like to check service logs
-
-By default, the service writes logs to `/dev/log` which can be accessed by using `journalctl` command (logs are written to the journal of the user under which command is run).
-
-You can also edit configuration and forward logs to `stderr`, just change `handlers` value, e.g.:
-
-```shell
-sed -i 's/handlers = syslog_handler/handlers = console_handler/g' /etc/ahriman.ini.d/logging.ini
-```
-
-You can even configure logging as you wish, but kindly refer to python `logging` module configuration.
-
-### Html customization
-
-It is possible to customize html templates. In order to do so, create files somewhere (refer to Jinja2 documentation and the service source code for available parameters) and put `template_path` to configuration pointing to this directory.
-
-### I did not find my question
-
-[Create an issue](https://github.com/arcan1s/ahriman/issues) with type **Question**.

docs/faq/backup.rst

@@ -0,0 +1,35 @@
+Backup and restore
+------------------
+
+The service provides several commands aim to do easy repository backup and restore. If you would like to move repository from the server ``server1.example.com`` to another ``server2.example.com`` you have to perform the following steps:
+
+#. 
+   On the source server ``server1.example.com`` run ``repo-backup`` command, e.g.:
+
+   .. code-block:: shell
+
+      ahriman repo-backup /tmp/repo.tar.gz
+
+   This command will pack all configuration files together with database file into the archive specified as command line argument (i.e. ``/tmp/repo.tar.gz``). In addition it will also archive ``cache`` directory (the one which contains local clones used by e.g. local packages) and ``.gnupg`` of the ``ahriman`` user.
+
+#. 
+   Copy created archive from source server ``server1.example.com`` to target ``server2.example.com``.
+
+#. 
+   Install package as usual on the target server ``server2.example.com`` if you didn't yet.
+
+#. 
+   Extract archive e.g. by using subcommand:
+
+   .. code-block:: shell
+
+      ahriman repo-restore /tmp/repo.tar.gz
+
+   An additional argument ``-o``/``--output`` can be used to specify extraction root (``/`` by default).
+
+#. 
+   Rebuild repository:
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman repo-rebuild --from-database

docs/faq/distributed.rst

@@ -0,0 +1,326 @@
+Distributed builds
+------------------
+
+The service allows to run build on multiple machines and collect packages on main node. There are several ways to achieve it, this section describes officially supported methods.
+
+Remote synchronization and remote server call
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This setup requires at least two instances of the service:
+
+#. Web service (with opt-in authorization enabled), later will be referenced as **master** node.
+#. Application instances responsible for build, later will be referenced as **worker** nodes.
+
+In this example the following settings are assumed:
+
+* Repository architecture is ``x86_64``.
+* Master node address is ``master.example.com``.
+
+Master node configuration
+"""""""""""""""""""""""""
+
+The only requirements for the master node is that API must be available for worker nodes to call (e.g. port must be exposed to internet, or local network in case of VPN, etc) and file upload must be enabled:
+
+.. code-block:: ini
+
+   [web]
+   enable_archive_upload = yes
+
+In addition, the following settings are recommended for the master node:
+
+*
+  As it has been mentioned above, it is recommended to enable authentication (see :doc:`How to enable basic authorization <web>`) and create system user which will be used later. Later this user (if any) will be referenced as ``worker-user``.
+
+*
+  In order to be able to spawn multiple processes at the same time, wait timeout must be configured:
+
+  .. code-block:: ini
+
+     [web]
+     wait_timeout = 0
+
+Worker nodes configuration
+""""""""""""""""""""""""""
+
+#.
+   First of all, in this setup you need to split your repository into chunks manually, e.g. if you have repository on master node with packages ``A``, ``B`` and ``C``, you need to split them between all available workers, as example:
+
+   * Worker #1: ``A``.
+   * Worker #2: ``B`` and ``C``.
+
+   Hint: ``repo-tree`` subcommand provides ``--partitions`` argument.
+
+#.
+   Each worker must be configured to upload files to master node:
+
+   .. code-block:: ini
+
+      [upload]
+      target = remote-service
+
+      [remote-service]
+
+#.
+   Worker must be configured to access web on master node:
+
+   .. code-block:: ini
+
+      [status]
+      address = https://master.example.com
+      username = worker-user
+      password = very-secure-password
+
+   As it has been mentioned above, ``${status:address}`` must be available for workers. In case if unix socket is used, it can be passed in the same option as usual. Optional ``${status:username}``/``${status:password}`` can be supplied in case if authentication was enabled on master node.
+
+#.
+   Each worker must call master node on success:
+
+   .. code-block:: ini
+
+      [report]
+      target = remote-call
+
+      [remote-call]
+      manual = yes
+
+   After success synchronization (see above), the built packages will be put into directory, from which they will be read during manual update, thus ``${remote-call:manual}`` flag is required.
+
+#.
+   Change order of trigger runs. This step is required, because by default the report trigger is called before the upload trigger and we would like to achieve the opposite:
+
+   .. code-block:: ini
+
+      [build]
+      triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.upload.UploadTrigger ahriman.core.report.ReportTrigger ahriman.core.gitremote.RemotePushTrigger
+
+In addition, the following settings are recommended for workers:
+
+*
+  You might want to wait until report trigger will be completed; in this case the following option must be set:
+
+  .. code-block:: ini
+
+     [remote-call]
+     wait_timeout = 0
+
+Dependency management
+"""""""""""""""""""""
+
+By default worker nodes don't know anything about master nodes packages, thus it will try to build each dependency by its own. However, using ``AHRIMAN_REPOSITORY_SERVER`` docker variable (or ``--server`` flag for setup command), it is possible to specify address of the master node for devtools configuration.
+
+Repository and packages signing
+"""""""""""""""""""""""""""""""
+
+You can sign packages on worker nodes and then signatures will be synced to master node. In order to do so, you need to configure worker node as following, e.g.:
+
+.. code-block:: ini
+
+   [sign]
+   target = package
+   key = 8BE91E5A773FB48AC05CC1EDBED105AED6246B39
+
+Note, however, that in this case, signatures will not be validated on master node and just will be copied to repository tree.
+
+If you would like to sign only database files (aka repository sign), it has to be configured only on master node as usual, e.g.:
+
+.. code-block:: ini
+
+   [sign]
+   target = repository
+   key = 8BE91E5A773FB48AC05CC1EDBED105AED6246B39
+
+Double node minimal docker example
+""""""""""""""""""""""""""""""""""
+
+Master node config (``master.ini``) as:
+
+.. code-block:: ini
+
+   [auth]
+   target = configuration
+
+   [web]
+   enable_archive_upload = yes
+   wait_timeout = 0
+
+
+Command to run master node:
+
+.. code-block:: shell
+
+   docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -v master.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web
+
+The user ``worker-user`` has been created additionally. Worker node config (``worker.ini``) as:
+
+.. code-block:: ini
+
+   [status]
+   address = http://172.17.0.1:8080
+   username = worker-user
+   password = very-secure-password
+
+   [upload]
+   target = remote-service
+
+   [remote-service]
+
+   [report]
+   target = remote-call
+
+   [remote-call]
+   manual = yes
+   wait_timeout = 0
+
+   [build]
+   triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.upload.UploadTrigger ahriman.core.report.ReportTrigger ahriman.core.gitremote.RemotePushTrigger
+
+The address above (``http://172.17.0.1:8080``) is somewhat available for worker container.
+
+Command to run worker node:
+
+.. code-block:: shell
+
+   docker run --privileged -v worker.ini:/etc/ahriman.ini.d/overrides.ini -it arcan1s/ahriman:latest package-add ahriman --now
+
+The command above will successfully build ``ahriman`` package, upload it on master node and, finally, will update master node repository.
+
+Check proof-of-concept setup `here <https://github.com/arcan1s/ahriman/tree/master/recipes/distributed-manual>`__.
+
+Addition of new package and repository update
+"""""""""""""""""""""""""""""""""""""""""""""
+
+Just run on worker command as usual, the built packages will be automatically uploaded to master node. Note that automatic update process must be disabled on master node.
+
+Package removal
+"""""""""""""""
+
+This action must be done in two steps:
+
+#. Remove package on worker.
+#. Remove package on master node.
+
+Delegate builds to remote workers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This setup heavily uses upload feature described above and, in addition, also delegates build process automatically to build machines. Same as above, there must be at least two instances available (**master** and **worker**), however, all **worker** nodes must be run in the web service mode.
+
+Master node configuration
+"""""""""""""""""""""""""
+
+In addition to the configuration above, the worker list must be defined in configuration file (``${build:workers}`` option), i.e.:
+
+.. code-block:: ini
+
+   [build]
+   workers = https://worker1.example.com https://worker2.example.com
+
+   [web]
+   enable_archive_upload = yes
+   wait_timeout = 0
+
+In the example above, ``https://worker1.example.com`` and ``https://worker2.example.com`` are remote **worker** node addresses available for **master** node.
+
+In case if authentication is required (which is recommended way to setup it), it can be set by using ``status`` section as usual.
+
+Worker nodes configuration
+""""""""""""""""""""""""""
+
+It is required to point to the master node repository, otherwise internal dependencies will not be handled correctly. In order to do so, the ``--server`` argument (or ``AHRIMAN_REPOSITORY_SERVER`` environment variable for docker images) can be used.
+
+Also, in case if authentication is enabled, the same user with the same password must be created for all workers.
+
+It is also recommended to set ``${web:wait_timeout}`` to infinite in case of multiple conflicting runs and ``${web:service_only}`` to ``yes`` in order to disable status endpoints.
+
+Other settings are the same as mentioned above.
+
+Triple node minimal docker example
+""""""""""""""""""""""""""""""""""
+
+In this example, all instances are run on the same machine with address ``172.17.0.1`` with ports available outside of container. Master node config (``master.ini``) as:
+
+.. code-block:: ini
+
+   [auth]
+   target = configuration
+
+   [status]
+   username = builder-user
+   password = very-secure-password
+
+   [build]
+   workers = http://172.17.0.1:8081 http://172.17.0.1:8082
+
+   [web]
+   enable_archive_upload = yes
+   wait_timeout = 0
+
+Command to run master node:
+
+.. code-block:: shell
+
+   docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -v master.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web
+
+Worker nodes (applicable for all workers) config (``worker.ini``) as:
+
+.. code-block:: ini
+
+   [auth]
+   target = configuration
+
+   [status]
+   address = http://172.17.0.1:8080
+   username = builder-user
+   password = very-secure-password
+
+   [upload]
+   target = remote-service
+
+   [remote-service]
+
+   [report]
+   target = remote-call
+
+   [remote-call]
+   manual = yes
+   wait_timeout = 0
+
+   [web]
+   service_only = yes
+
+   [build]
+   triggers = ahriman.core.upload.UploadTrigger ahriman.core.report.ReportTrigger
+
+Command to run worker nodes (considering there will be two workers, one is on ``8081`` port and other is on ``8082``):
+
+.. code-block:: shell
+
+   docker run --privileged -p 8081:8081 -e AHRIMAN_PORT=8081 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web
+   docker run --privileged -p 8082:8082 -e AHRIMAN_PORT=8082 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web
+
+Unlike the previous setup, it doesn't require to mount repository root for **worker** nodes, because they don't use it anyway.
+
+Check proof-of-concept setup `here <https://github.com/arcan1s/ahriman/tree/master/recipes/distributed>`__.
+
+Addition of new package, package removal, repository update
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+In all scenarios, update process must be run only on **master** node. Unlike the manually distributed packages described above, automatic update must be enabled only for **master** node.
+
+Automatic worker nodes discovery
+""""""""""""""""""""""""""""""""
+
+Instead of setting ``${build:workers}`` option explicitly it is also possible to configure services to load worker list dynamically. To do so, the ``ahriman.core.distributed.WorkerLoaderTrigger`` and ``ahriman.core.distributed.WorkerTrigger`` must be used for **master** and **worker** nodes respectively. See recipes for more details.
+
+Those triggers have to be installed as a separate package:
+
+.. code-block:: shell
+
+   yay -S ahriman-triggers
+
+Known limitations
+"""""""""""""""""
+
+* Workers don't support local packages. However, it is possible to build custom packages by providing sources by using ``ahriman.core.gitremote.RemotePullTrigger`` trigger.
+* No dynamic nodes discovery. In case if one of worker nodes is unavailable, the build process will fail.
+* No pkgrel bump on conflicts.
+* The identical user must be created for all workers. However, the **master** node user can be different from this one.

docs/faq/docker.rst

@@ -0,0 +1,137 @@
+Docker image
+------------
+
+We provide official images which can be found under:
+
+* docker registry ``arcan1s/ahriman``;
+* ghcr.io registry ``ghcr.io/arcan1s/ahriman``.
+
+These images are totally identical.
+
+Docker image is being updated on each commit to master as well as on each version. If you would like to use last (probably unstable) build you can use ``edge`` tag or ``latest`` for any tagged versions; otherwise you can use any version tag available.
+
+The default action (in case if no arguments provided) is ``repo-update``. Basically the idea is to run container, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+In order to make data available outside of container, you would need to mount local (parent) directory inside container by using ``-v /path/to/local/repo:/var/lib/ahriman`` argument, where ``/path/to/local/repo`` is a path to repository on local machine. In addition, you can pass own configuration overrides by using the same ``-v`` flag, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -v /path/to/local/repo:/var/lib/ahriman -v /path/to/overrides/overrides.ini:/etc/ahriman.ini.d/10-overrides.ini arcan1s/ahriman:latest
+
+The action can be specified during run, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest package-add ahriman --now
+
+For more details please refer to the docker FAQ.
+
+Privileged and non-privileged container
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Examples here suggest using ``--privileged`` flag which is required for the devtools and is involved in two types of operations: tmpfs mount and cgroup manipulation. Whereas it is the easiest way to operate, it might be not really secure. The other way to make devtools working is to grant required capabilities, which can be achieved by using flags:
+
+* ``--cap-add=SYS_ADMIN``, which grants permissions to operate with tmpfs for ``systemd-nspawn``.
+* ``-v /sys/fs/cgroup:/sys/fs/cgroup`` which allows access to cgroup manipulation.
+
+Thus, there are two possible ways to run the container:
+
+.. code-block:: shell
+
+   docker run --privileged arcan1s/ahriman:latest
+
+and
+
+.. code-block:: shell
+
+   docker run --cap-add=SYS_ADMIN -v /sys/fs/cgroup:/sys/fs/cgroup arcan1s/ahriman:latest
+
+but for the simplicity this FAQ will always use ``--privileged`` flag.
+
+Environment variables
+^^^^^^^^^^^^^^^^^^^^^
+
+The following environment variables are supported:
+
+* ``AHRIMAN_ARCHITECTURE`` - architecture of the repository, default is ``x86_64``.
+* ``AHRIMAN_DEBUG`` - if set all commands will be logged to console.
+* ``AHRIMAN_FORCE_ROOT`` - force run ahriman as root instead of guessing by subcommand.
+* ``AHRIMAN_HOST`` - host for the web interface, default is ``0.0.0.0``.
+* ``AHRIMAN_MULTILIB`` - if set (default) multilib repository will be used, disabled otherwise.
+* ``AHRIMAN_OUTPUT`` - controls logging handler, e.g. ``syslog``, ``console``. The name must be found in logging configuration. Note that if ``syslog`` handler is used you will need to mount ``/dev/log`` inside container because it is not available there.
+* ``AHRIMAN_PACKAGER`` - packager name from which packages will be built, default is ``ahriman bot <ahriman@example.com>``.
+* ``AHRIMAN_PACMAN_MIRROR`` - override pacman mirror server if set.
+* ``AHRIMAN_PORT`` - HTTP server port if any, default is empty.
+* ``AHRIMAN_POSTSETUP_COMMAND`` - if set, the command which will be called (as root) after the setup command, but before any other actions.
+* ``AHRIMAN_PRESETUP_COMMAND`` - if set, the command which will be called (as root) right before the setup command.
+* ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur``.
+* ``AHRIMAN_REPOSITORY_SERVER`` - optional override for the repository URL. Useful if you would like to download packages from remote instead of local filesystem.
+* ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume.
+* ``AHRIMAN_UNIX_SOCKET`` - full path to unix socket which is used by web server, default is empty. Note that more likely you would like to put it inside ``AHRIMAN_REPOSITORY_ROOT`` directory (e.g. ``/var/lib/ahriman/ahriman/ahriman-web.sock``) or to ``/run/ahriman``.
+* ``AHRIMAN_USER`` - ahriman user, usually must not be overwritten, default is ``ahriman``.
+* ``AHRIMAN_VALIDATE_CONFIGURATION`` - if set (default) validate service configuration.
+
+You can pass any of these variables by using ``-e`` argument, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+Daemon service
+^^^^^^^^^^^^^^
+
+There is special ``repo-daemon`` subcommand which emulates systemd timer and will perform repository update periodically:
+
+.. code-block:: shell
+
+   docker run --privileged -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest repo-daemon
+
+This command uses same rules as ``repo-update``, thus, e.g. requires ``--privileged`` flag. Check also `examples <https://github.com/arcan1s/ahriman/tree/master/recipes/daemon>`__.
+
+Web service setup
+^^^^^^^^^^^^^^^^^
+
+For that you would need to have web container instance running forever; it can be achieved by the following command:
+
+.. code-block:: shell
+
+   docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -e AHRIMAN_UNIX_SOCKET=/var/lib/ahriman/ahriman/ahriman-web.sock -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+Note about ``AHRIMAN_PORT`` environment variable which is required in order to enable web service. An additional port bind by ``-p 8080:8080`` is required to pass docker port outside of container.
+
+The ``AHRIMAN_UNIX_SOCKET`` variable is not required, however, highly recommended as it can be used for interprocess communications. If you set this variable you would like to be sure that this path is available outside of container if you are going to use multiple docker instances.
+
+If you are using ``AHRIMAN_UNIX_SOCKET`` variable, for every next container run it has to be passed also, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -e AHRIMAN_UNIX_SOCKET=/var/lib/ahriman/ahriman/ahriman-web.sock -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+Otherwise, you would need to pass ``AHRIMAN_PORT`` and mount container network to the host system (``--net=host``), e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged --net=host -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+Simple server with authentication can be found in `examples <https://github.com/arcan1s/ahriman/tree/master/recipes/web>`__ too.
+
+Multi-repository web service
+""""""""""""""""""""""""""""
+
+Idea is pretty same as to just run web service. However, it is required to run setup commands for each repository, except for one which is specified by ``AHRIMAN_REPOSITORY`` and ``AHRIMAN_ARCHITECTURE`` variables.
+
+In order to create configuration for additional repositories, the ``AHRIMAN_POSTSETUP_COMMAND`` variable should be used, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -e AHRIMAN_UNIX_SOCKET=/var/lib/ahriman/ahriman/ahriman-web.sock -e AHRIMAN_POSTSETUP_COMMAND="ahriman --architecture x86_64 --repository aur-v2 service-setup --build-as-user ahriman --packager 'ahriman bot <ahriman@example.com>'" -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+The command above will also create configuration for the repository named ``aur-v2``.
+
+Note, however, that the command above is only required in case if the service is going to be used to run subprocesses. Otherwise, everything else (web interface, status, etc) will be handled as usual.
+
+Configuration `example <https://github.com/arcan1s/ahriman/tree/master/recipes/multirepo>`__.

docs/faq/examples.rst

@@ -0,0 +1,12 @@
+Use cases
+---------
+
+There is a collection of some specific recipes which can be found in `the repository <https://github.com/arcan1s/ahriman/tree/master/recipes>`__.
+
+Most of them can be run (``AHRIMAN_PASSWORD`` environment variable is required in the most setups) as simple as:
+
+.. code-block:: shell
+
+   AHRIMAN_PASSWORD=demo docker compose up
+
+Note, however, they are just an examples of specific configuration for specific cases and they are never intended to be used as is in real environment.

docs/faq/general.rst

@@ -0,0 +1,425 @@
+General topics
+--------------
+
+What is the purpose of the project
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This project has been created in order to maintain self-hosted Arch Linux user repository without manual intervention - checking for updates and building packages.
+
+How to install ahriman
+^^^^^^^^^^^^^^^^^^^^^^
+
+TL;DR
+
+.. code-block:: shell
+
+   yay -S ahriman-core
+   ahriman -a x86_64 -r aur service-setup --packager "ahriman bot <ahriman@example.com>"
+   systemctl enable --now ahriman@x86_64-aur.timer
+
+Long answer
+"""""""""""
+
+The idea is to install the package as usual, create working directory tree, create configuration for ``sudo`` and ``devtools``. Detailed description of the setup instruction can be found :doc:`here </setup>`.
+
+Run as daemon
+"""""""""""""
+
+The alternative way (though not recommended) is to run service instead of timer:
+
+.. code-block:: shell
+
+   systemctl enable --now ahriman-daemon@x86_64-aur
+
+How to validate settings
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is special command which can be used in order to validate current configuration:
+
+.. code-block:: shell
+
+   ahriman service-config-validate --exit-code
+
+This command will print found errors, based on `cerberus <https://docs.python-cerberus.org/>`__, e.g.:
+
+.. code-block:: shell
+
+   auth
+                   ssalt: unknown field
+                   target: none or more than one rule validate
+                           oneof definition 0: unallowed value mapping
+                           oneof definition 1: field 'salt' is required
+                           oneof definition 2: unallowed value mapping
+                           oneof definition 2: field 'salt' is required
+                           oneof definition 2: field 'client_id' is required
+                           oneof definition 2: field 'client_secret' is required
+   gitremote
+                   pull_url: unknown field
+
+If an additional flag ``--exit-code`` is supplied, the application will return non-zero exit code, which can be used partially in scripts.
+
+What does "architecture specific" mean / How to configure for different architectures
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Some sections can be configured per architecture. The service will merge architecture specific values into common settings. In order to specify settings for specific architecture you must point it in section name.
+
+For example, the section
+
+.. code-block:: ini
+
+   [build]
+   build_command = extra-x86_64-build
+
+states that default build command is ``extra-x86_64-build``. But if there is section
+
+.. code-block:: ini
+
+   [build:i686]
+   build_command = extra-i686-build
+
+the ``extra-i686-build`` command will be used for ``i686`` architecture. You can also override settings for different repositories and architectures; in this case section names will be ``build:aur`` (repository name only) and ``build:aur:i686`` (both repository name and architecture).
+
+How to generate build reports
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Normally you would probably like to generate only one report for the specific type, e.g. only one email report. In order to do so you will need to have the following configuration:
+
+.. code-block:: ini
+
+   [report]
+   target = email
+
+   [email]
+   ...
+
+or in case of multiple architectures and *different* reporting settings:
+
+.. code-block:: ini
+
+   [report]
+   target = email
+
+   [email:i686]
+   ...
+
+   [email:x86_64]
+   ...
+
+But for some cases you would like to have multiple different reports with the same type (e.g. sending different templates to different addresses). For these cases you will need to specify section name in target and type in section, e.g. the following configuration can be used:
+
+.. code-block:: ini
+
+   [report]
+   target = email_1 email_2
+
+   [email_1]
+   type = email
+   ...
+
+   [email_2]
+   type = email
+   ...
+
+How to add new package
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-add ahriman --now
+
+``--now`` flag is totally optional and just run ``repo-update`` subcommand after the registering the new package. Thus the extended flow is the following:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-add ahriman
+   sudo -u ahriman ahriman repo-update
+
+How to build package from local PKGBUILD
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+TL;DR
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-add /path/to/local/directory/with/PKGBUILD --now
+
+Before using this command you will need to create local directory and put ``PKGBUILD`` there. These packages will be stored locally and *will be ignored* during automatic update; in order to update the package you will need to run ``package-add`` command again.
+
+How to copy package from another repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is possible to copy package and its metadata between local repositories, optionally removing the source archive, e.g.:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman -r target-repository package-copy source-repository ahriman
+
+This feature in particular useful if for managing multiple repositories like ``[testing]`` and ``[extra]``.
+
+How to fetch PKGBUILDs from remote repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For that purpose you could use ``RemotePullTrigger`` trigger. To do so you will need to configure trigger as following:
+
+.. code-block:: ini
+
+   [remote-pull]
+   target = gitremote
+
+   [gitremote]
+   pull_url = https://github.com/username/repository
+
+During the next application run it will fetch repository from the specified URL and will try to find packages there which can be used as local sources.
+
+This feature can be also used to build packages which are not listed in AUR, the example of the feature use can be found `here <https://github.com/arcan1s/ahriman/tree/master/recipes/pull>`__.
+
+How to push updated PKGBUILDs to remote repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For that purpose you'd need to use another trigger called ``RemotePushTrigger``. Configure trigger as following:
+
+.. code-block:: ini
+
+   [remote-push]
+   target = gitremote
+
+   [gitremote]
+   push_url = https://github.com/username/repository
+
+Unlike ``RemotePullTrigger`` trigger, the ``RemotePushTrigger`` more likely will require authorization. It is highly recommended to use application tokens for that instead of using your password (e.g. for GitHub you can generate tokens `here <https://github.com/settings/tokens>`__ with scope ``public_repo``). Authorization can be supplied by using authorization part of the URL, e.g. ``https://key:token@github.com/username/repository``.
+
+How to change PKGBUILDs before build
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Well it is supported also. The recommended way is to patch specific function, e.g. by running
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman patch-add ahriman version
+
+This command will prompt for new value of the PKGBUILD variable ``version``. You can also write it to file and read from it:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman patch-add ahriman version version.patch
+
+The command also supports arrays, but in this case you need to specify full array, e.g.
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman patch-add ahriman depends
+
+   Post new function or variable value below. Press Ctrl-D to finish:
+   (python python-aiohttp)
+   ^D
+
+will set depends PKGBUILD variable (exactly) to array ``["python", "python-aiohttp"]``.
+
+Alternatively you can create full-diff patches, which are calculated by using ``git diff`` from current PKGBUILD master branch:
+
+#.
+   Clone sources from AUR.
+
+#.
+   Make changes you would like to (e.g. edit ``PKGBUILD``, add external patches).
+
+#.
+   Run command
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman patch-set-add /path/to/local/directory/with/PKGBUILD
+
+The last command will calculate diff from current tree to the ``HEAD`` and will store it locally. Patches will be applied on any package actions (e.g. it can be used for dependency management).
+
+It is also possible to create simple patch during package addition, e.g.:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-add ahriman --variable PKGEXT=.pkg.tar.xz
+
+The ``--variable`` argument accepts variables in shell like format: quotation and lists are supported as usual, but functions are not. This feature is useful in particular in order to override specific makepkg variables during build.
+
+How to build package from official repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is the same as adding any other package, but due to restrictions you must specify source explicitly, e.g.:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-add pacman --source repository
+
+This feature is heavily depends on local pacman cache. In order to use this feature it is recommended to either run ``pacman -Sy`` before the interaction or use internal application cache with ``--refresh`` flag.
+
+Package build fails because it cannot validate PGP signature of source files
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+TL;DR
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman service-key-import ...
+
+How to update VCS packages
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Normally the service handles VCS packages correctly. The version is updated in clean chroot, no additional actions are required.
+
+How to review changes before build
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In this scenario, the update process must be separated into several stages. First, it is required to check updates:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman repo-check
+
+During the check process, the service will generate changes from the last known commit and will send it to remote service. In order to verify source files changes, the web interface or special subcommand can be used:
+
+.. code-block:: shell
+
+   ahriman package-changes ahriman
+
+After validation, the operator can run update process with approved list of packages, e.g.:
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman repo-update ahriman
+
+How to remove package
+^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman package-remove ahriman
+
+Also, there is command ``repo-remove-unknown`` which checks packages in AUR and local storage and removes ones which have been removed.
+
+Remove commands also remove any package files (patches, caches etc).
+
+How to sign repository
+^^^^^^^^^^^^^^^^^^^^^^
+
+Repository sign feature is available in several configurations. The recommended way is just to sign repository database file by single key instead of trying to sign each package. However, the steps are pretty same, just configuration is a bit different. For more details about options kindly refer to :doc:`configuration reference </configuration>`.
+
+#.
+   First you would need to create the key on your local machine:
+
+   .. code-block:: shell
+
+      gpg --full-generate-key
+
+   This command will prompt you for several questions. Most of them may be left default, but you will need to fill real name and email address with some data. Because at the moment the service doesn't support passphrases, it must be left blank.
+
+#.
+   The command above will generate key and print its fingerprint, something like ``8BE91E5A773FB48AC05CC1EDBED105AED6246B39``. Copy it.
+
+#.
+   Export your private key by using the fingerprint above:
+
+   .. code-block:: shell
+
+      gpg --export-secret-keys -a 8BE91E5A773FB48AC05CC1EDBED105AED6246B39 > repository-key.gpg
+
+#.
+
+   Copy the specified key to the build machine (i.e. where the service is running).
+
+#.
+   Import the specified key to the service user:
+
+   .. code-block:: shell
+
+      sudo -u ahriman gpg --import repository-key.gpg
+
+   Don't forget to remove the key from filesystem after import.
+
+#.
+   Change trust level to ``ultimate``:
+
+   .. code-block:: shell
+
+      sudo -u ahriman gpg --edit-key 8BE91E5A773FB48AC05CC1EDBED105AED6246B39
+
+   The command above will drop you into gpg shell, in which you will need to type ``trust``, choose ``5 = I trust ultimately``, confirm and exit ``quit``.
+
+#.
+   Proceed with service configuration according to the :doc:`configuration </configuration>`:
+
+   .. code-block:: ini
+
+      [sign]
+      target = repository
+      key = 8BE91E5A773FB48AC05CC1EDBED105AED6246B39
+
+
+How to rebuild packages after library update
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+TL;DR
+
+.. code-block:: shell
+
+   sudo -u ahriman ahriman repo-rebuild --depends-on python
+
+You can even rebuild the whole repository (which is particular useful in case if you would like to change packager) if you do not supply ``--depends-on`` option. This action will automatically increment ``pkgrel`` value; in case if you don't want to, the ``--no-increment`` option has to be supplied.
+
+However, note that you do not need to rebuild repository in case if you just changed signing option, just use ``repo-sign`` command instead.
+
+Automated broken dependencies detection
+"""""""""""""""""""""""""""""""""""""""
+
+After the success build the application extracts all linked libraries and used directories and stores them in database. During the check process, the application extracts pacman databases and checks if file names have been changed (e.g. new python release caused ``/usr/lib/python3.x`` directory renaming to ``/usr/lib/python3.y`` or soname for a linked library has been changed). In case if broken dependencies have been detected, the package will be added to the rebuild queue.
+
+In order to disable this check completely, the ``--no-check-files`` flag can be used.
+
+In addition, there is possibility to control paths which will be used for checking, by using option ``${build:scan_paths}``, which supports regular expressions. Leaving ``${build:scan_paths}`` blank will effectively disable any check too.
+
+How to install built packages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Add the following lines to your ``pacman.conf``:
+
+.. code-block:: ini
+
+   [repository]
+   Server = file:///var/lib/ahriman/repository/$repo/$arch
+
+(You might need to add ``SigLevel`` option according to the pacman documentation.)
+
+How to serve repository
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Easy. For example, nginx configuration (without SSL) will look like:
+
+.. code-block::
+
+   server {
+       listen 80;
+       server_name repo.example.com;
+
+       location / {
+           autoindex on;
+           root /var/lib/ahriman/repository;
+       }
+   }
+
+Example of the status page configuration is the following (status service is using 8080 port):
+
+.. code-block::
+
+   server {
+       listen 80;
+       server_name builds.example.com;
+
+       location / {
+           proxy_set_header Host $host;
+           proxy_set_header X-Real-IP $remote_addr;
+           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+           proxy_set_header X-Forwarder-Proto $scheme;
+
+           proxy_pass http://127.0.0.1:8080;
+       }
+   }
+
+Some more examples can be found in configuration `recipes <https://github.com/arcan1s/ahriman/tree/master/recipes>`__.

docs/faq/index.rst

@@ -0,0 +1,17 @@
+FAQ
+===
+
+.. toctree::
+   :maxdepth: 2
+
+   general
+   docker
+   non-x86_64-setup
+   synchronization
+   reporting
+   distributed
+   maintenance-packages
+   web
+   backup
+   examples
+   misc

docs/faq/maintenance-packages.rst

@@ -0,0 +1,79 @@
+Maintenance packages
+--------------------
+
+Those features require extensions package to be installed before, e.g.:
+
+.. code-block:: shell
+
+   yay -S ahriman-triggers
+
+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 </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-keyring --source local --now
+
+   where ``aur`` is your repository name.
+
+This plugin might have some issues, in case of any of them, kindly create `new issue <https://github.com/arcan1s/ahriman/issues/new/choose>`__.
+
+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 </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-mirrorlist --source local --now
+
+   where ``aur`` is your repository name.

docs/faq/misc.rst

@@ -0,0 +1,107 @@
+Other topics
+------------
+
+How does it differ from %another-manager%?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Short answer - I do not know. Also for some references credits to `Alad <https://github.com/AladW>`__, he `did <https://wiki.archlinux.org/title/User:Alad/Local_repo_tools>`__ really good investigation of existing alternatives.
+
+`arch-repo-manager <https://github.com/Martchus/arch-repo-manager>`__
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Looks actually pretty good, in case if I would find it, I would probably didn't start this project; the most of features (like web interface or additional helpers) are already implemented or planned to be. However, this project seems to be at early alpha stage (as for Nov 2022), written in C++ (not pro or con) and misses documentation.
+
+`archrepo2 <https://github.com/lilydjwg/archrepo2>`__
+"""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Don't know, haven't tried it. But it lacks of documentation at least.
+
+* ``ahriman`` has web interface.
+* ``archrepo2`` doesn't have synchronization and reporting.
+* ``archrepo2`` actively uses direct shell calls and ``yaourt`` components.
+* ``archrepo2`` has constantly running process instead of timer process (it is not pro or con).
+
+`repoctl <https://github.com/cassava/repoctl>`__
+""""""""""""""""""""""""""""""""""""""""""""""""
+
+* ``ahriman`` has web interface.
+* ``repoctl`` does not have reporting feature.
+* ``repoctl`` does not support local packages and patches.
+* Some actions are not fully automated in ``repoctl`` (e.g. package update still requires manual intervention for the build itself).
+* ``repoctl`` has better AUR interaction features. With colors!
+* ``repoctl`` has much easier configuration and even completion.
+* ``repoctl`` is able to store old packages.
+* Ability to host repository from same command in ``repoctl`` vs external services (e.g. nginx) in ``ahriman``.
+
+`repod <https://gitlab.archlinux.org/archlinux/repod>`__
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Official tool provided by distribution, has clean logic, but it is just a helper for ``repo-add``, e.g. it doesn't work with AUR and all packages builds have to be handled separately.
+
+`repo-scripts <https://github.com/arcan1s/repo-scripts>`__
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Though originally I've created ahriman by trying to improve the project, it still lacks a lot of features:
+
+* ``ahriman`` has web interface.
+* ``ahriman`` has better reporting with template support.
+* ``ahriman`` has more synchronization features (there was only ``rsync`` based).
+* ``ahriman`` supports local packages and patches.
+* ``repo-scripts`` doesn't have dependency management.
+
+...and so on. ``repo-scripts`` also has bad architecture and bad quality code and uses out-of-dated ``yaourt`` and ``package-query``.
+
+`toolbox <https://github.com/chaotic-aur/toolbox>`__
+""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+It is automation tools for ``repoctl`` mentioned above. Except for using shell it looks pretty cool and also offers some additional features like patches, remote synchronization (isn't it?) and reporting.
+
+`AURCache <https://github.com/Lukas-Heiligenbrunner/AURCache>`__
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+That's really cool project if you are looking for simple service to build AUR packages. It provides very informative dashboard and easy to configure and use. However, it doesn't provide direct way to control build process (e.g. it is neither trivial to build packages for architectures which are not supported by default nor to change build flags).
+
+Also this application relies on docker setup (e.g. builders are only available as special docker containers). In addition, it uses ``paru`` to build packages instead of ``devtools``.
+
+How to check service logs
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default, the service writes logs to ``journald`` which can be accessed by using ``journalctl`` command (logs are written to the journal of the user under which command is run). In order to retrieve logs for the process you can use the following command:
+
+.. code-block:: shell
+
+   sudo journalctl SYSLOG_IDENTIFIER=ahriman
+
+You can also ask to forward logs to ``stderr``, just set ``--log-handler`` flag, e.g.:
+
+.. code-block:: shell
+
+   ahriman --log-handler console ...
+
+You can even configure logging as you wish, but kindly refer to python ``logging`` module `configuration <https://docs.python.org/3/library/logging.config.html>`__.
+
+The application uses java concept to log messages, e.g. class ``Application`` imported from ``ahriman.application.application`` package will have logger called ``ahriman.application.application.Application``. In order to e.g. change logger name for whole application package it is possible to change values for ``ahriman.application`` package; thus editing ``ahriman`` logger configuration will change logging for whole application (unless there are overrides for another logger).
+
+Html customization
+^^^^^^^^^^^^^^^^^^
+
+It is possible to customize html templates. In order to do so, create files somewhere (refer to Jinja2 documentation and the service source code for available parameters) and prepend ``templates`` with value pointing to this directory.
+
+In addition, default html templates supports style customization out-of-box. In order to customize style, just put file named ``user-style.jinja2`` to the templates directory.
+
+Web API extension
+^^^^^^^^^^^^^^^^^
+
+The application loads web views dynamically, so it is possible relatively easy extend its API. In order to do so:
+
+#. Create view class which is derived from ``ahriman.web.views.base.BaseView`` class.
+#. Create implementation for this class.
+#. Put file into ``ahriman.web.views`` package.
+#. Restart application.
+
+For more details about implementation and possibilities, kindly refer to module documentation and source code and `aiohttp documentation <https://docs.aiohttp.org/en/stable/>`__.
+
+I did not find my question
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`Create an issue <https://github.com/arcan1s/ahriman/issues>`__ with type **Question**.

docs/faq/non-x86_64-setup.rst

@@ -0,0 +1,99 @@
+Non-x86_64 architecture setup
+-----------------------------
+
+The following section describes how to setup ahriman with architecture different from x86_64, as example i686. For most cases you have base repository available, e.g. archlinux32 repositories for i686 architecture; in case if base repository is not available, steps are a bit different, however, idea remains the same.
+
+The example of setup with docker compose can be found `here <https://github.com/arcan1s/ahriman/tree/master/recipes/i686>`__.
+
+Physical server setup
+^^^^^^^^^^^^^^^^^^^^^
+
+In this example we are going to use files and packages which are provided by official repositories of the used architecture. Note, that versions might be different, thus you need to find correct versions on the distribution web site, e.g. `archlinux32 packages <https://www.archlinux32.org/packages/>`__.
+
+#.
+   First, considering having base Arch Linux system, we need to install keyring for the specified repositories, e.g.:
+
+   .. code-block:: shell
+
+      wget https://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20230705-1.0-any.pkg.tar.zst
+      pacman -U archlinux32-keyring-20230705-1.0-any.pkg.tar.zst
+
+#.
+   In order to run ``devtools`` scripts for custom architecture they also need specific ``makepkg`` configuration, it can be retrieved by installing the ``devtools`` package of the distribution, e.g.:
+
+   .. code-block:: shell
+
+      wget https://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.2-any.pkg.tar.zst
+      pacman -U devtools-20221208-1.2-any.pkg.tar.zst
+
+   Alternatively, you can create your own ``makepkg`` configuration and save it as ``/usr/share/devtools/makepkg.conf.d/i686.conf``.
+
+#.
+   Setup repository as usual:
+
+   .. code-block:: shell
+
+      ahriman -a i686 service-setup --mirror 'https://de.mirror.archlinux32.org/$arch/$repo'--no-multilib ...
+
+   In addition to usual options, you need to specify the following options:
+
+   * ``--mirror`` - link to the mirrors which will be used instead of official repositories.
+   * ``--no-multilib`` - in the example we are using i686 architecture for which multilib repository doesn't exist.
+
+#.
+   That's all Folks!
+
+Docker container setup
+^^^^^^^^^^^^^^^^^^^^^^
+
+There are two possible ways to achieve same setup, by using docker container. The first one is just mount required files inside container and run it as usual (with specific environment variables). Another one is to create own container based on official one:
+
+#.
+   Clone official container as base:
+
+   .. code-block:: dockerfile
+
+      FROM arcan1s/ahriman:latest
+
+#.
+   Init pacman keys. This command is required in order to populate distribution keys:
+
+   .. code-block:: dockerfile
+
+      RUN pacman-key --init
+
+#.
+   Install packages as it was described above:
+
+   .. code-block:: dockerfile
+
+      RUN pacman --noconfirm -Sy wget
+      RUN wget https://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.2-any.pkg.tar.zst && pacman --noconfirm -U devtools-20221208-1.2-any.pkg.tar.zst
+      RUN wget https://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20230705-1.0-any.pkg.tar.zst && pacman --noconfirm -U archlinux32-keyring-20230705-1.0-any.pkg.tar.zst
+
+#.
+   At that point you should have full ``Dockerfile`` like:
+
+   .. code-block:: dockerfile
+
+      FROM arcan1s/ahriman:latest
+
+      RUN pacman-key --init
+
+      RUN pacman --noconfirm -Sy wget
+      RUN wget https://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.2-any.pkg.tar.zst && pacman --noconfirm -U devtools-20221208-1.2-any.pkg.tar.zst
+      RUN wget https://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20230705-1.0-any.pkg.tar.zst && pacman --noconfirm -U archlinux32-keyring-20230705-1.0-any.pkg.tar.zst
+
+#.
+   After that you can build you own container, e.g.:
+
+   .. code-block:: shell
+
+      docker build --tag ahriman-i686:latest
+
+#.
+   Now you can run locally built container as usual with passing environment variables for setup command:
+
+   .. code-block:: shell
+
+      docker run --privileged -p 8080:8080 -e AHRIMAN_ARCHITECTURE=i686 -e AHRIMAN_PACMAN_MIRROR='https://de.mirror.archlinux32.org/$arch/$repo' -e AHRIMAN_MULTILIB= ahriman-i686:latest

docs/faq/reporting.rst

@@ -0,0 +1,119 @@
+Reporting
+---------
+
+How to report by email
+^^^^^^^^^^^^^^^^^^^^^^
+
+#.
+   Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S --asdeps python-jinja
+
+#.
+   Configure the service:
+
+   .. code-block:: ini
+
+      [report]
+      target = email
+
+      [email]
+      host = smtp.example.com
+      link_path = http://example.com/aur/x86_64
+      password = ...
+      port = 465
+      receivers = me@example.com
+      sender = me@example.com
+      user = me@example.com
+
+How to generate index page
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#.
+   Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S --asdeps python-jinja
+
+#.
+   Configure the service:
+
+   .. code-block:: ini
+
+      [report]
+      target = html
+
+      [html]
+      path = ${repository:root}/repository/aur/x86_64/index.html
+      link_path = http://example.com/aur/x86_64
+
+Having this configuration, the generated ``index.html`` will be also automatically synced to remote services (e.g. S3).
+
+How to generate RSS feed for index page
+"""""""""""""""""""""""""""""""""""""""
+
+In addition to previous steps, the following configuration is required:
+
+.. code-block:: ini
+
+   [report]
+   target = html rss
+
+   [html]
+   rss_url = ${html:link_path}/rss.xml
+
+   [rss]
+   link_path = ${html:link_path}
+   path = ${repository:root}/repository/ahriman-demo/x86_64/rss.xml
+   rss_url = ${html:link_path}/rss.xml
+
+With the appended configuration, the service fill also generate ``rss.xml``, link it to generated ``index.html`` and put it together.
+
+How to post build report to telegram
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#.
+   It still requires additional dependencies:
+
+   .. code-block:: shell
+
+      yay -S --asdeps python-jinja
+
+#.
+   Register bot in telegram. You can do it by starting chat with `@BotFather <https://t.me/botfather>`__. For more details please refer to `official documentation <https://core.telegram.org/bots>`__.
+
+#.
+   Optionally (if you want to post message in chat):
+
+   #. Create telegram channel.
+   #. Invite your bot into the channel.
+   #. Make your channel public
+
+#.
+   Get chat id if you want to use by numerical id or just use id prefixed with ``@`` (e.g. ``@ahriman``). If you are not using chat the chat id is your user id. If you don't want to make channel public you can use `this guide <https://stackoverflow.com/a/33862907>`__.
+
+#.
+   Configure the service:
+
+   .. code-block:: ini
+
+      [report]
+      target = telegram
+
+      [telegram]
+      api_key = aaAAbbBBccCC
+      chat_id = @ahriman
+      link_path = http://example.com/aur/x86_64
+
+   ``${api_key}`` is the one sent by `@BotFather <https://t.me/botfather>`__, ``${chat_id}`` is the value retrieved from previous step.
+
+If you did everything fine you should receive the message with the next update. Quick credentials check can be done by using the following command:
+
+.. code-block:: shell
+
+   curl 'https://api.telegram.org/bot${api_key}/sendMessage?chat_id=${chat_id}&text=hello'
+
+(replace ``${chat_id}`` and ``${api_key}`` with the values from configuration).

docs/faq/synchronization.rst

@@ -0,0 +1,131 @@
+Remote synchronization
+----------------------
+
+How to sync repository to another server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are several choices:
+
+#.
+   Easy and cheap, just share your local files through the internet, e.g. for ``nginx``:
+
+   .. code-block::
+
+       server {
+           location / {
+               autoindex on;
+               root /var/lib/ahriman/repository/;
+           }
+       }
+
+#.
+   You can also upload your packages using ``rsync`` to any available server. In order to use it you would need to configure ahriman first:
+
+   .. code-block:: ini
+
+       [upload]
+       target = rsync
+
+       [rsync]
+       remote = 192.168.0.1:/srv/repo
+
+   After that just add ``/srv/repo`` to the ``pacman.conf`` as usual. You can also upload to S3 (``Server = https://s3.eu-central-1.amazonaws.com/repository/aur/x86_64``) or to GitHub (``Server = https://github.com/ahriman/repository/releases/download/aur-x86_64``).
+
+How to sync to S3
+^^^^^^^^^^^^^^^^^
+
+#.
+   Install dependencies:
+
+   .. code-block:: shell
+
+      pacman -S python-boto3
+
+#.
+   Create a bucket (e.g. ``repository``).
+
+#.
+   Create an user with write access to the bucket:
+
+   .. code-block::
+
+       {
+           "Version": "2012-10-17",
+           "Statement": [
+               {
+                   "Sid": "ListObjectsInBucket",
+                   "Effect": "Allow",
+                   "Action": [
+                       "s3:ListBucket"
+                   ],
+                   "Resource": [
+                       "arn:aws:s3:::repository"
+                   ]
+               },
+               {
+                   "Sid": "AllObjectActions",
+                   "Effect": "Allow",
+                   "Action": "s3:*Object",
+                   "Resource": [
+                       "arn:aws:s3:::repository/*"
+                   ]
+               }
+           ]
+       }
+
+#.
+   Create an API key for the user and store it.
+
+#.
+   Configure the service as following:
+
+   .. code-block:: ini
+
+       [upload]
+       target = s3
+
+       [s3]
+       access_key = ...
+       bucket = repository
+       region = eu-central-1
+       secret_key = ...
+
+S3 with SSL
+"""""""""""
+
+In order to configure S3 on custom domain with SSL (and some other features, like redirects), the CloudFront should be used.
+
+#. Configure S3 as described above.
+#. In bucket properties, enable static website hosting with hosting type "Host a static website".
+#. Go to AWS Certificate Manager and create public certificate on your domain. Validate domain as suggested.
+#. Go to CloudFront and create distribution. The following settings are required:
+
+   * Origin domain choose S3 bucket.
+   * Tick use website endpoint.
+   * Disable caching.
+   * Select issued certificate.
+
+#. Point DNS record to CloudFront address.
+
+How to sync to GitHub releases
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#.
+   Create a repository.
+
+#.
+   `Create API key <https://github.com/settings/tokens>`__ with scope ``public_repo``.
+
+#.
+   Configure the service as following:
+
+   .. code-block:: ini
+
+       [upload]
+       target = github
+
+       [github]
+       owner = ahriman
+       password = ...
+       repository = repository
+       username = ahriman

docs/faq/web.rst

@@ -0,0 +1,145 @@
+Web service
+-----------
+
+How to setup web service
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install web service:
+
+   .. code-block:: shell
+
+      yay -S ahriman-web
+
+#. 
+   Configure service:
+
+   .. code-block:: ini
+
+      [web]
+      port = 8080
+
+#. 
+   Start the web service ``systemctl enable --now ahriman-web``.
+
+How to enable basic authorization
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies 😊:
+
+   .. code-block:: shell
+
+      yay -S --asdeps python-aiohttp-security python-aiohttp-session python-cryptography
+
+#. 
+   Configure the service to enable authorization:
+
+   .. code-block:: ini
+
+      [auth]
+      target = configuration
+      salt = somerandomstring
+
+   The ``${auth:salt}`` parameter is optional, but recommended, and can be set to any (random) string.
+
+#.
+   In order to provide access for reporting from application instances you can (the recommended way) use unix sockets by the following configuration (note, that it requires ``python-requests-unixsocket2`` package to be installed):
+
+   .. code-block:: ini
+
+      [web]
+      unix_socket = /run/ahriman/ahriman-web.sock
+
+   This socket path must be available for web service instance and must be available for all application instances (e.g. in case if you are using docker container - see above - you need to make sure that the socket is passed to the root filesystem).
+
+   By the way, unix socket variable will be automatically set in case if ``--web-unix-socket`` argument is supplied to the ``service-setup`` subcommand.
+
+   Alternatively, you need to create user for the service:
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman user-add -r full api
+
+   This command will ask for the password, just type it in stdin; **do not** leave the field blank, user will not be able to authorize, and finally configure the application:
+
+   .. code-block:: ini
+
+      [status]
+      username = api
+      password = pa55w0rd
+
+#.
+   Create end-user with password:
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman user-add -r full my-first-user
+
+#.
+   Restart web service ``systemctl restart ahriman-web``.
+
+Using PAM authentication
+""""""""""""""""""""""""
+
+There is also ability to allow system users to log in. To do so, the following configuration have to be set:
+
+.. code-block:: ini
+
+   [auth]
+   target = pam
+   full_access_group = wheel
+
+With this setup, every user (except root) will be able to log in by using system password. If user belongs to the ``wheel`` group, the full access will be automatically granted. It is also possible to manually add, block user or change user rights via usual user management process.
+
+How to enable OAuth authorization
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Create OAuth web application, download its ``${auth:client_id}`` and ``${auth:client_secret}``.
+
+#.
+   Guess what? Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S --asdeps python-aiohttp-security python-aiohttp-session python-cryptography python-aioauth-client
+
+#. 
+   Configure the service:
+
+   .. code-block:: ini
+
+      [auth]
+      target = oauth
+      client_id = ...
+      client_secret = ...
+
+      [web]
+      address = https://example.com
+
+   Configure ``${auth:oauth_provider}`` and ``${auth:oauth_scopes}`` in case if you would like to use different from Google provider. Scope must grant access to user email. ``${web:address}`` is required to make callback URL available from internet.
+
+#. 
+   If you are not going to use unix socket, you also need to create service user (remember to set ``${auth:salt}`` option before if required):
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman user-add --as-service -r full api
+
+#. 
+   Create end-user:
+
+   .. code-block:: shell
+
+      sudo -u ahriman ahriman user-add -r full my-first-user
+
+   When it will ask for the password leave it blank.
+
+#.
+   Restart web service ``systemctl restart ahriman-web``.
+
+How to implement own interface
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can write your own interface by using API which is provided by the web service. Full autogenerated API documentation is available at ``http://localhost:8080/api-docs``.