Release 2.8.0

manually

.bandit-test.yml

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

.bandit.yml

@@ -0,0 +1 @@
+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

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature summary
+
+Brief description of the feature required
+
+### Cause of the feature request
+
+A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
+
+### Proposed changes and/or features
+
+A clear and concise description of what you want to happen.

.github/ISSUE_TEMPLATE/04-discussion.md

@@ -0,0 +1,12 @@
+---
+name: Question
+about: Create an issue to get help with project
+title: ''
+labels: question
+assignees: ''
+
+---
+
+## Describe your question below
+
+A clear and concise description of your issue for which you would like to get help.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Summary
+
+Brief description of the pull request. Try to provide clear explanation for major changes.
+
+Please make sure that branch called either `feature/feature-name` for feature-related pull requests or `bug/bug-name` for bug-related ones.
+
+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

.github/workflows/docker-image.yml

@@ -0,0 +1,42 @@
+name: docker image
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+      - '!*rc*'
+
+jobs:
+  docker-image:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: extract docker metadata
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            arcan1s/ahriman
+          tags: |
+            type=ref,event=tag
+            type=edge
+
+      - name: setup QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: setup docker buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: login to docker hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: build an image and push
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  make-release:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: extract version
+        id: version
+        run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+
+      - 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
+        env:
+          VERSION: ${{ steps.version.outputs.VERSION }}
+
+      - name: release
+        uses: softprops/action-gh-release@v1
+        with:
+          body: |
+            ${{ steps.changelog.outputs.compareurl }}
+            ${{ steps.changelog.outputs.changelog }}
+          files: ahriman-*-src.tar.xz
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/run-setup.yml

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

.github/workflows/run-tests.yml

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

.github/workflows/setup.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+# Install the package and run main install commands
+
+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
+# refresh the image
+pacman --noconfirm -Syu
+# main dependencies
+pacman --noconfirm -Sy base-devel devtools git pyalpm python-cerberus python-inflection python-passlib python-requests python-setuptools python-srcinfo sudo
+# make dependencies
+pacman --noconfirm -Sy python-build python-installer python-wheel
+# optional dependencies
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # VCS support
+    pacman --noconfirm -Sy breezy darcs mercurial subversion
+    # web server
+    pacman --noconfirm -Sy python-aioauth-client python-aiohttp python-aiohttp-apispec-git python-aiohttp-cors 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
+fi
+
+# create fresh tarball
+make VERSION=1.0.0 archlinux  # well, it does not really matter which version we will put here
+# run makepkg
+mv ahriman-*-src.tar.xz 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
+# create machine-id which is required by build tools
+systemd-machine-id-setup
+
+# 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
+[[ -z $MINIMAL_INSTALL ]] && WEB_ARGS=("--web-port" "8080")
+ahriman -a x86_64 service-setup --packager "ahriman bot <ahriman@example.com>" --repository "github" "${WEB_ARGS[@]}"
+# validate configuration
+ahriman -a x86_64 service-config-validate --exit-code
+# enable services
+systemctl enable ahriman-web@x86_64
+systemctl enable ahriman@x86_64.timer
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # run web service (detached)
+    sudo -u ahriman -- ahriman -a x86_64 web &
+    WEB_PID=$!
+    sleep 15s  # wait for the web service activation
+fi
+# add the first package
+# the build itself does not really work in the container
+sudo -u ahriman -- ahriman package-add --now yay
+# check if package was actually installed
+test -n "$(find "/var/lib/ahriman/repository/x86_64" -name "yay*pkg*")"
+# run package check
+sudo -u ahriman -- ahriman repo-update
+# stop web service lol
+[[ -z $WEB_PID ]] || kill $WEB_PID

.github/workflows/tests.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Install dependencies and run test in container
+
+set -ex
+
+# install dependencies
+pacman --noconfirm -Syu base-devel python-pip python-setuptools python-tox
+
+# run test and check targets
+make check tests

.gitignore

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

.pylintrc

@@ -22,7 +22,7 @@ ignore-patterns=
 
 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 # number of processors available to use.
-jobs=1
+jobs=0
 
 # Control the amount of potential inferred values when inferring a single
 # object. This can help the performance when dealing with large functions or
@@ -60,17 +60,7 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=print-statement,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
-        raw-checker-failed,
+disable=raw-checker-failed,
         bad-inline-option,
         locally-disabled,
         file-ignored,
@@ -78,67 +68,6 @@ disable=print-statement,
         useless-suppression,
         deprecated-pragma,
         use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape,
         missing-module-docstring,
         line-too-long,
         no-name-in-module,
@@ -149,12 +78,12 @@ disable=print-statement,
         too-few-public-methods,
         too-many-instance-attributes,
         broad-except,
-        logging-fstring-interpolation,
         too-many-ancestors,
         fixme,
         too-many-arguments,
         duplicate-code,
-        cyclic-import
+        cyclic-import,
+        confusing-with-statement,
 
 
 # Enable the message, report, category or checker with the given id(s). You can
@@ -220,7 +149,7 @@ indent-string='    '
 max-line-length=100
 
 # Maximum number of lines in a module.
-max-module-lines=1000
+max-module-lines=400
 
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
@@ -604,5 +533,5 @@ valid-metaclass-classmethod-first-arg=cls
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception

.readthedocs.yaml

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

AUTHORS

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

CONFIGURING.md

@@ -1,85 +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 `build_x86_64` for the `x86_64` architecture and `build` for any other (architecture specific group has higher priority).
-
-## `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.
-
-## `build_*` groups
-
-Build related configuration. Group name must refer to architecture, e.g. it should be `build_x86_64` for x86_64 architecture.
-
-* `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 must refer to architecture, e.g. it should be `sign_x86_64` for x86_64 architecture.
-
-* `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, optional. Allowed values are `html`.
-
-### `html_*` groups
-
-Group name must refer to architecture, e.g. it should be `html_x86_64` for x86_64 architecture.
-
-* `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, optional. Allowed values are `rsync`, `s3`.
-
-### `rsync_*` groups
-
-Group name must refer to architecture, e.g. it should be `rsync_x86_64` for x86_64 architecture. Requires `rsync` package to be installed. Do not forget to configure ssh for user `ahriman`.
-
-* `remote` - remote server to rsync (e.g. `1.2.3.4:5678:path/to/sync`), string, required.
-
-### `s3_*` groups
-
-Group name must refer to architecture, e.g. it should be `s3_x86_64` for x86_64 architecture. Requires `aws-cli` package to be installed. Do not forget to configure it for user `ahriman`.
-
-* `bucket` - bucket name (e.g. `s3://bucket/path`), string, required.
-
-## `web_*` groups
-
-Web server settings. If any of `host`/`port` is not set, web integration will be disabled. Group name must refer to architecture, e.g. it should be `web_x86_64` for x86_64 architecture.
-
-* `host` - host to bind, string, optional.
-* `port` - port to bind, int, optional.
-* `templates` - path to templates directory, string, required.

CONTRIBUTING.md

@@ -0,0 +1,208 @@
+# 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 `make check` or running `autopep8` command directly.
+
+### Code style
+
+Again, the most checks can be performed by `make check` 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 section is empty, e.g. no notes or there are no args, it should be omitted:
+
+    ```python
+    def foo(argument: str, *, flag: bool = False) -> int:
+        """
+        do foo. With very very very long
+        docstring
+  
+        Note:
+            Very important note about this function
+  
+        Args:
+            argument(str): an argument. This argument has
+                long description also
+            flag(bool, optional): a flag (Default value = False)
+  
+        Returns:
+            int: result
+  
+        Raises:
+            RuntimeException: 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 ``BaseClazz``
+  
+        Attributes:
+            CLAZZ_ATTRIBUTE(int): (class attribute) a brand-new class attribute
+            instance_attribute(str): an instance attribute
+  
+        Examples:
+            Very informative class usage example, e.g.::
+  
+                >>> from module import Clazz
+                >>> clazz = Clazz()
+        """
+  
+        CLAZZ_ATTRIBUTE = 42
+  
+        def __init__(self, *args: Any, **kwargs: Any) -> None:
+            """
+            default constructor
+  
+            Args:
+                *args(Any): positional arguments
+                **kwargs(Any): keyword arguments 
+            """
+            self.instance_attribute = ""
+    ```
+
+* Type annotations are the must, even for local functions.
+* 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: ...
+
+        @classmethod
+        def class_method(cls: Type[Clazz]) -> Clazz: ...
+
+        @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 exception is `__init__` method (`__post__init__` for dataclasses) 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.
+
+* 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 code must follow the exception safety, unless it is explicitly asked by end user. It means that most exceptions must be handled and printed to log, no other actions must be done (e.g. raising another exception).
+* 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.version` 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. Schema testing mostly should be implemented in related view class tests. Recommended example for documentation (excluding comments):
+
+    ```python
+    import aiohttp_apispec
+
+    from marshmallow import Schema, fields  
+
+    from ahriman.web.schemas.auth_schema import AuthSchema
+    from ahriman.web.schemas.error_schema import ErrorSchema
+    from ahriman.web.schemas.package_name_schema import PackageNameSchema
+    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 = ...
+
+        @aiohttp_apispec.docs(
+            tags=["Tag"],
+            summary="Do foo",
+            description="Extended description of the method which does foo",
+            responses={
+                200: {"description": "Success response", "schema": ResponseSchema},
+                204: {"description": "Success response"},  # example without json schema response
+                400: {"description": "Bad data is supplied", "schema": ErrorSchema},  # exception raised by this method
+                401: {"description": "Authorization required", "schema": ErrorSchema},  # should be always presented
+                403: {"description": "Access is forbidden", "schema": ErrorSchema},  # should be always presented
+                500: {"description": "Internal server error", "schema": ErrorSchema},  # should be always presented
+            },
+            security=[{"token": [POST_PERMISSION]}],
+        )
+        @aiohttp_apispec.cookies_schema(AuthSchema)  # should be always presented
+        @aiohttp_apispec.match_info_schema(PackageNameSchema)
+        @aiohttp_apispec.json_schema(RequestSchema(many=True))
+        async def post(self) -> None: ...
+    ```
+
+### 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.

Dockerfile

@@ -0,0 +1,57 @@
+FROM archlinux:base
+
+# 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="syslog"
+ENV AHRIMAN_PACKAGER="ahriman bot <ahriman@example.com>"
+ENV AHRIMAN_PACMAN_MIRROR=""
+ENV AHRIMAN_PORT=""
+ENV AHRIMAN_REPOSITORY="aur-clone"
+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"
+## install minimal required packages
+RUN pacman --noconfirm -Syu binutils fakeroot git make sudo
+## create build user
+RUN useradd -m -d "/home/build" -s "/usr/bin/nologin" build && \
+    echo "build ALL=(ALL) NOPASSWD: ALL" > "/etc/sudoers.d/build"
+COPY "docker/install-aur-package.sh" "/usr/local/bin/install-aur-package"
+## install package dependencies
+## darcs is not installed by reasons, because it requires a lot haskell packages which dramatically increase image size
+RUN pacman --noconfirm -Sy devtools git pyalpm python-cerberus python-inflection python-passlib python-requests python-setuptools python-srcinfo && \
+    pacman --noconfirm -Sy python-build python-installer python-wheel && \
+    pacman --noconfirm -Sy breezy mercurial python-aiohttp python-aiohttp-cors python-boto3 python-cryptography python-jinja python-requests-unixsocket rsync subversion && \
+    runuser -u build -- install-aur-package python-aioauth-client python-aiohttp-apispec-git python-aiohttp-jinja2  \
+                                            python-aiohttp-debugtoolbar python-aiohttp-session python-aiohttp-security
+
+# cleanup unused
+RUN find "/var/cache/pacman/pkg" -type f -delete
+
+# install ahriman
+## copy tree
+COPY --chown=build . "/home/build/ahriman"
+## create package archive and install it
+RUN cd "/home/build/ahriman" && \
+    make VERSION=$(python -c "from src.ahriman.version import __version__; print(__version__)") archlinux && \
+    cp ./*-src.tar.xz "package/archlinux" && \
+    cd "package/archlinux" && \
+    runuser -u build -- makepkg --noconfirm --install --skipchecksums && \
+    cd / && rm -r "/home/build/ahriman"
+
+VOLUME ["/var/lib/ahriman"]
+
+# minimal runtime ahriman setup
+COPY "docker/entrypoint.sh" "/usr/local/bin/entrypoint"
+ENTRYPOINT ["entrypoint"]
+# default command
+CMD ["repo-update", "--refresh"]

Makefile

@@ -1,9 +1,9 @@
-.PHONY: archive archive_directory archlinux check clean directory push version
+.PHONY: archive archlinux check clean directory html push specification tests version
 .DEFAULT_GOAL := archlinux
 
 PROJECT := ahriman
 
-FILES := COPYING CONFIGURING.md README.md package src setup.py
+FILES := AUTHORS CONTRIBUTING.md COPYING Makefile README.md SECURITY.md docs package src setup.py tox.ini web.png
 TARGET_FILES := $(addprefix $(PROJECT)/, $(FILES))
 IGNORE_FILES := package/archlinux src/.mypy_cache
 
@@ -16,35 +16,44 @@ archive: archive_directory
 
 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 {} +
+	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 "/sha512sums=('[0-9A-Fa-f]*/s/[^'][^)]*/sha512sums=('$$(sha512sum $(PROJECT)-$(VERSION)-src.tar.xz | awk '{print $$1}')'/" package/archlinux/PKGBUILD
-	sed -i "s/pkgver=[0-9.]*/pkgver=$(VERSION)/" package/archlinux/PKGBUILD
+	sed -i "s/pkgver=.*/pkgver=$(VERSION)/" package/archlinux/PKGBUILD
 
-check:
-	cd src && mypy --implicit-reexport --strict -p $(PROJECT)
-	cd src && find $(PROJECT) -name '*.py' -execdir autopep8 --max-line-length 120 -aa -i {} +
-	cd src && pylint --rcfile=../.pylintrc $(PROJECT)
+check: clean
+	tox -e check
 
 clean:
-	find . -type f -name '$(PROJECT)-*-src.tar.xz' -delete
+	find . -type f -name "$(PROJECT)-*-src.tar.xz" -delete
 	rm -rf "$(PROJECT)"
 
 directory: clean
 	mkdir "$(PROJECT)"
 
-push: archlinux
-	git add package/archlinux/PKGBUILD src/ahriman/version.py
+html: specification
+	rm -rf docs/html
+	tox -e docs-html
+
+push: specification archlinux
+	git add package/archlinux/PKGBUILD src/ahriman/version.py docs/ahriman-architecture.svg docs/ahriman.1 docs/completions/
 	git commit -m "Release $(VERSION)"
-	git push
 	git tag "$(VERSION)"
+	git push
 	git push --tags
 
+specification:
+	# make sure that old files are removed
+	find docs -type f -name "$(PROJECT)*.rst" -delete
+	tox -e docs
+
+tests: clean
+	tox -e tests
+
 version:
 ifndef VERSION
 	$(error VERSION is required, but not set)
 endif
-	sed -i "/__version__ = '[0-9.]*/s/[^'][^)]*/__version__ = '$(VERSION)'/" src/ahriman/version.py
+	sed -i 's/^__version__ = .*/__version__ = "$(VERSION)"/' src/ahriman/version.py

README.md

@@ -1,68 +1,41 @@
-# ArcHlinux 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)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/arcan1s/ahriman?label=docker%20image)](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/?badge=latest)
 
 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 report generation (html)
-* Dependency manager
-* Repository status interface
+* Install-configure-forget manager for the very own repository.
+* Multi-architecture support.
+* Dependency manager.
+* VCS packages support.
+* Official repository support.
+* Ability to patch AUR packages and even create package from local PKGBUILDs.
+* Sign support with gpg (repository, package, per package settings).
+* 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
 
-* Install package as usual.
-* Change settings if required, see [CONFIGURING](CONFIGURING.md) for more details.
-* Create `/var/lib/ahriman/.makepkg.conf` with `makepkg.conf` overrides if required (at least you might want to set `PACKAGER`):
+For installation details kindly refer to the [documentation](https://ahriman.readthedocs.io/en/latest/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/latest/command-line.html)).
 
-    ```shell
-    echo 'PACKAGES="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
-    ```
+## Configuration
 
-* Configure build tools (it is required for correct dependency management system):
+Every available option is described in the [documentation](https://ahriman.readthedocs.io/en/latest/configuration.html).
 
-    * create build command, e.g. `ln -s /usr/bin/archbuild /usr/local/bin/ahriman-x86_64-build` (you can choose any name for command, basically it should be `{name}-{arch}-build`);
-    * create configuration file, e.g. `cp /usr/share/devtools/pacman-{extra,ahriman}.conf` (same as previous `pacman-{name}.conf`);
-    * change configuration file, add your own repository, add multilib repository etc. Hint: you can use `Include` option as well;
-    * set `build_command` option to point to your command;
-    * configure `/etc/sudoers.d/ahriman` to allow running command without a password.
+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.
 
-    ```shell
-    ln -s /usr/bin/archbuild /usr/local/bin/ahriman-x86_64-build
-    cp /usr/share/devtools/pacman-{extra,ahriman}.conf
+## [FAQ](https://ahriman.readthedocs.io/en/latest/faq.html)
 
-    echo '[multilib]' | tee -a /usr/share/devtools/pacman-ahriman.conf
-    echo 'Include = /etc/pacman.d/mirrorlist' | tee -a /usr/share/devtools/pacman-ahriman.conf
+## Live demos
 
-    echo '[aur-clone]' | tee -a /usr/share/devtools/pacman-ahriman.conf
-    echo 'SigLevel = Optional TrustAll' | tee -a /usr/share/devtools/pacman-ahriman.conf
-    echo 'Server = file:///var/lib/ahriman/repository/$arch' | tee -a /usr/share/devtools/pacman-ahriman.conf
-
-    echo '[build]' | tee -a /etc/ahriman.ini.d/build.ini
-    echo 'build_command = ahriman-x86_64-build' | tee -a /etc/ahriman.ini.d/build.ini
-
-    echo 'Cmnd_Alias CARCHBUILD_CMD = /usr/local/bin/ahriman-x86_64-build *' | tee -a /etc/sudoers.d/ahriman
-    echo 'ahriman ALL=(ALL) NOPASSWD: CARCHBUILD_CMD' | tee -a /etc/sudoers.d/ahriman
-    chmod 400 /etc/sudoers.d/ahriman
-    ```
-
-* Start and enable `ahriman@.timer` via `systemctl`:
-
-    ```shell
-    systemctl enable --now ahriman@x86_64.timer
-    ```
-
-* Start and enable status page:
-
-    ```shell
-    systemctl enable --now ahriman-web@x86_64
-    ```
-
-* Add packages by using `ahriman add {package}` command:
-
-    ```shell
-    sudo -u ahriman ahriman -a x86_64 add yay
-    ```
+* [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](http://repo.arcanis.me/x86_64/index.html).
+* [Telegram feed](https://t.me/arcanisrepo).

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/entrypoint.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+set -e
+[ -n "$AHRIMAN_DEBUG" ] && set -x
+
+# configuration tune
+cat <<EOF > "/etc/ahriman.ini.d/00-docker.ini"
+[repository]
+root = $AHRIMAN_REPOSITORY_ROOT
+
+[settings]
+database = $AHRIMAN_REPOSITORY_ROOT/ahriman.db
+
+[web]
+host = $AHRIMAN_HOST
+
+EOF
+sed -i "s|handlers = syslog_handler|handlers = ${AHRIMAN_OUTPUT}_handler|g" "/etc/ahriman.ini.d/logging.ini"
+
+AHRIMAN_DEFAULT_ARGS=("--architecture" "$AHRIMAN_ARCHITECTURE")
+if [[ "$AHRIMAN_OUTPUT" == "syslog" ]]; then
+    if [ ! -e "/dev/log" ]; then
+        # by default ahriman uses syslog which is not available inside container
+        # to make noise less we force quiet mode in case if /dev/log was not mounted
+        AHRIMAN_DEFAULT_ARGS+=("--quiet")
+    fi
+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")
+AHRIMAN_SETUP_ARGS+=("--repository" "$AHRIMAN_REPOSITORY")
+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_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
+ahriman "${AHRIMAN_DEFAULT_ARGS[@]}" service-setup "${AHRIMAN_SETUP_ARGS[@]}"
+
+# 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
+
+# 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 --command="$*" &> /dev/null; then
+    AHRIMAN_EXECUTABLE=("sudo" "-u" "$AHRIMAN_USER" "--" "ahriman")
+else
+    AHRIMAN_EXECUTABLE=("ahriman")
+fi
+exec "${AHRIMAN_EXECUTABLE[@]}" "${AHRIMAN_DEFAULT_ARGS[@]}" "$@"

docker/install-aur-package.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+for PACKAGE in "$@"; do
+    BUILD_DIR="$(mktemp -d)"
+    git clone https://aur.archlinux.org/"$PACKAGE".git "$BUILD_DIR"
+    cd "$BUILD_DIR"
+    makepkg --noconfirm --install --rmdeps --syncdeps
+    cd /
+    rm -r "$BUILD_DIR"
+done

docs/advanced-usage.rst

@@ -0,0 +1,42 @@
+Advanced usage
+==============
+
+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
+
+   architecture = "x86_64"
+   configuration = Configuration.from_path(Path("/etc/ahriman.ini"), architecture)
+   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
+
+   repository = Repository(architecture, configuration, database, report=True, unsafe=False)
+
+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/ahriman.1

@@ -0,0 +1,770 @@
+.TH AHRIMAN "1" "2023\-04\-09" "ahriman" "Generated Python Manual"
+.SH NAME
+ahriman
+.SH SYNOPSIS
+.B ahriman
+[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--report | --no-report] [-q] [--unsafe] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,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,patch-set-add,repo-backup,repo-check,check,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,user-add,user-list,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. For several subcommands it 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\-\-report\fR, \fB\-\-no\-report\fR
+force enable or disable reporting to web service (default: True)
+
+.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
+
+.SH
+COMMAND
+.TP
+\fBahriman\fR \fI\,aur\-search\/\fR
+search for package
+.TP
+\fBahriman\fR \fI\,help\/\fR
+show help message
+.TP
+\fBahriman\fR \fI\,help\-commands\-unsafe\/\fR
+list unsafe commands
+.TP
+\fBahriman\fR \fI\,help\-updates\/\fR
+check for service updates
+.TP
+\fBahriman\fR \fI\,help\-version\/\fR
+application version
+.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 for PKGBUILD function
+.TP
+\fBahriman\fR \fI\,patch\-list\/\fR
+list patch sets
+.TP
+\fBahriman\fR \fI\,patch\-remove\/\fR
+remove patch set
+.TP
+\fBahriman\fR \fI\,patch\-set\-add\/\fR
+add patch set
+.TP
+\fBahriman\fR \fI\,repo\-backup\/\fR
+backup repository data
+.TP
+\fBahriman\fR \fI\,repo\-check\/\fR
+check for updates
+.TP
+\fBahriman\fR \fI\,repo\-daemon\/\fR
+run application as daemon
+.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\-restore\/\fR
+restore repository data
+.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\-tree\/\fR
+dump repository tree
+.TP
+\fBahriman\fR \fI\,repo\-triggers\/\fR
+run triggers
+.TP
+\fBahriman\fR \fI\,repo\-update\/\fR
+update packages
+.TP
+\fBahriman\fR \fI\,service\-clean\/\fR
+clean local caches
+.TP
+\fBahriman\fR \fI\,service\-config\/\fR
+dump configuration
+.TP
+\fBahriman\fR \fI\,service\-config\-validate\/\fR
+validate system configuration
+.TP
+\fBahriman\fR \fI\,service\-key\-import\/\fR
+import PGP key
+.TP
+\fBahriman\fR \fI\,service\-setup\/\fR
+initial service configuration
+.TP
+\fBahriman\fR \fI\,service\-shell\/\fR
+invoke python shell
+.TP
+\fBahriman\fR \fI\,user\-add\/\fR
+create or update user
+.TP
+\fBahriman\fR \fI\,user\-list\/\fR
+user known users and their access
+.TP
+\fBahriman\fR \fI\,user\-remove\/\fR
+remove user
+.TP
+\fBahriman\fR \fI\,web\/\fR
+web server
+
+.SH COMMAND \fI\,'ahriman aur\-search'\/\fR
+usage: ahriman aur\-search [\-h] [\-e] [\-\-info | \-\-no\-info]
+                          [\-\-sort\-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,submitter,url,url_path,version}]
+                          search [search ...]
+
+search for package in AUR using API
+
+.TP
+\fBsearch\fR
+search terms, can be specified multiple times, the result will match all terms
+
+.SH OPTIONS \fI\,'ahriman aur\-search'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-info\fR, \fB\-\-no\-info\fR
+show additional package information (default: False)
+
+.TP
+\fB\-\-sort\-by\fR \fI\,{description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,submitter,url,url_path,version}\/\fR
+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 COMMAND \fI\,'ahriman help'\/\fR
+usage: ahriman help [\-h] [command]
+
+show help message for application or command and exit
+
+.TP
+\fBcommand\fR
+show help message for specific command
+
+.SH COMMAND \fI\,'ahriman help\-commands\-unsafe'\/\fR
+usage: ahriman help\-commands\-unsafe [\-h] [\-\-command COMMAND]
+
+list unsafe commands as defined in default args
+
+.SH OPTIONS \fI\,'ahriman help\-commands\-unsafe'\/\fR
+.TP
+\fB\-\-command\fR \fI\,COMMAND\/\fR
+instead of showing commands, just test command line for unsafe subcommand and return 0 in case if command is safe and 1
+otherwise
+
+.SH COMMAND \fI\,'ahriman help\-updates'\/\fR
+usage: ahriman help\-updates [\-h] [\-e]
+
+request AUR for current version and compare with current service version
+
+.SH OPTIONS \fI\,'ahriman help\-updates'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit code if updates available
+
+.SH COMMAND \fI\,'ahriman help\-version'\/\fR
+usage: ahriman help\-version [\-h]
+
+print application and its dependencies versions
+
+.SH COMMAND \fI\,'ahriman package\-add'\/\fR
+usage: ahriman package\-add [\-h] [\-\-dependencies | \-\-no\-dependencies] [\-e] [\-n] [\-y]
+                           [\-s {auto,archive,aur,directory,local,remote,repository}]
+                           package [package ...]
+
+add existing or new package to the build queue
+
+.TP
+\fBpackage\fR
+package source (base name, path to local files, remote URL)
+
+.SH OPTIONS \fI\,'ahriman package\-add'\/\fR
+.TP
+\fB\-\-dependencies\fR, \fB\-\-no\-dependencies\fR
+process missing package dependencies (default: True)
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-n\fR, \fB\-\-now\fR
+run update function after
+
+.TP
+\fB\-y\fR, \fB\-\-refresh\fR
+download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date
+
+.TP
+\fB\-s\fR \fI\,{auto,archive,aur,directory,local,remote,repository}\/\fR, \fB\-\-source\fR \fI\,{auto,archive,aur,directory,local,remote,repository}\/\fR
+explicitly specify the package source for this command
+
+.SH COMMAND \fI\,'ahriman package\-remove'\/\fR
+usage: ahriman package\-remove [\-h] package [package ...]
+
+remove package from the repository
+
+.TP
+\fBpackage\fR
+package name or base
+
+.SH COMMAND \fI\,'ahriman package\-status'\/\fR
+usage: ahriman package\-status [\-h] [\-\-ahriman] [\-e] [\-\-info | \-\-no\-info] [\-s {unknown,pending,building,failed,success}]
+                              [package ...]
+
+request status of the package
+
+.TP
+\fBpackage\fR
+filter status by package base
+
+.SH OPTIONS \fI\,'ahriman package\-status'\/\fR
+.TP
+\fB\-\-ahriman\fR
+get service status itself
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-info\fR, \fB\-\-no\-info\fR
+show additional package information (default: False)
+
+.TP
+\fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR
+filter packages by status
+
+.SH COMMAND \fI\,'ahriman package\-status\-remove'\/\fR
+usage: ahriman package\-status\-remove [\-h] package [package ...]
+
+remove the package from the status page
+
+.TP
+\fBpackage\fR
+remove specified packages from status page
+
+.SH COMMAND \fI\,'ahriman package\-status\-update'\/\fR
+usage: ahriman package\-status\-update [\-h] [\-s {unknown,pending,building,failed,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
+
+.SH OPTIONS \fI\,'ahriman package\-status\-update'\/\fR
+.TP
+\fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR
+new package build status
+
+.SH COMMAND \fI\,'ahriman patch\-add'\/\fR
+usage: ahriman patch\-add [\-h] package variable [patch]
+
+create or update patched PKGBUILD function or variable
+
+.TP
+\fBpackage\fR
+package base
+
+.TP
+\fBvariable\fR
+PKGBUILD variable or function name. If variable is a function, it must end with ()
+
+.TP
+\fBpatch\fR
+path to file which contains function or variable value. If not set, the value will be read from stdin
+
+.SH COMMAND \fI\,'ahriman patch\-list'\/\fR
+usage: ahriman patch\-list [\-h] [\-e] [\-v VARIABLE] [package]
+
+list available patches for the package
+
+.TP
+\fBpackage\fR
+package base
+
+.SH OPTIONS \fI\,'ahriman patch\-list'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-v\fR \fI\,VARIABLE\/\fR, \fB\-\-variable\fR \fI\,VARIABLE\/\fR
+if set, show only patches for specified PKGBUILD variables
+
+.SH COMMAND \fI\,'ahriman patch\-remove'\/\fR
+usage: ahriman patch\-remove [\-h] [\-v VARIABLE] package
+
+remove patches for the package
+
+.TP
+\fBpackage\fR
+package base
+
+.SH OPTIONS \fI\,'ahriman patch\-remove'\/\fR
+.TP
+\fB\-v\fR \fI\,VARIABLE\/\fR, \fB\-\-variable\fR \fI\,VARIABLE\/\fR
+should be used for single\-function patches in case if you wold like to remove only specified PKGBUILD variables. In case
+if not set, it will remove all patches related to the package
+
+.SH COMMAND \fI\,'ahriman patch\-set\-add'\/\fR
+usage: ahriman patch\-set\-add [\-h] [\-t TRACK] package
+
+create or update source patches
+
+.TP
+\fBpackage\fR
+path to directory with changed files for patch addition/update
+
+.SH OPTIONS \fI\,'ahriman patch\-set\-add'\/\fR
+.TP
+\fB\-t\fR \fI\,TRACK\/\fR, \fB\-\-track\fR \fI\,TRACK\/\fR
+files which has to be tracked
+
+.SH COMMAND \fI\,'ahriman repo\-backup'\/\fR
+usage: ahriman repo\-backup [\-h] path
+
+backup repository settings and database
+
+.TP
+\fBpath\fR
+path of the output archive
+
+.SH COMMAND \fI\,'ahriman repo\-check'\/\fR
+usage: ahriman repo\-check [\-h] [\-e] [\-\-vcs | \-\-no\-vcs] [\-y] [package ...]
+
+check for packages updates. Same as repo\-update \-\-dry\-run \-\-no\-manual
+
+.TP
+\fBpackage\fR
+filter check by package base
+
+.SH OPTIONS \fI\,'ahriman repo\-check'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR
+fetch actual version of VCS packages (default: True)
+
+.TP
+\fB\-y\fR, \fB\-\-refresh\fR
+download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date
+
+.SH COMMAND \fI\,'ahriman repo\-daemon'\/\fR
+usage: ahriman repo\-daemon [\-h] [\-i INTERVAL] [\-\-aur | \-\-no\-aur] [\-\-dependencies | \-\-no\-dependencies]
+                           [\-\-local | \-\-no\-local] [\-\-manual | \-\-no\-manual] [\-\-vcs | \-\-no\-vcs] [\-y]
+
+start process which periodically will run update process
+
+.SH OPTIONS \fI\,'ahriman repo\-daemon'\/\fR
+.TP
+\fB\-i\fR \fI\,INTERVAL\/\fR, \fB\-\-interval\fR \fI\,INTERVAL\/\fR
+interval between runs in seconds
+
+.TP
+\fB\-\-aur\fR, \fB\-\-no\-aur\fR
+enable or disable checking for AUR updates (default: True)
+
+.TP
+\fB\-\-dependencies\fR, \fB\-\-no\-dependencies\fR
+process missing package dependencies (default: True)
+
+.TP
+\fB\-\-local\fR, \fB\-\-no\-local\fR
+enable or disable checking of local packages for updates (default: True)
+
+.TP
+\fB\-\-manual\fR, \fB\-\-no\-manual\fR
+include or exclude manual updates (default: True)
+
+.TP
+\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR
+fetch actual version of VCS packages (default: True)
+
+.TP
+\fB\-y\fR, \fB\-\-refresh\fR
+download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date
+
+.SH COMMAND \fI\,'ahriman repo\-rebuild'\/\fR
+usage: ahriman repo\-rebuild [\-h] [\-\-depends\-on DEPENDS_ON] [\-\-dry\-run] [\-\-from\-database] [\-e]
+
+force rebuild whole repository
+
+.SH OPTIONS \fI\,'ahriman repo\-rebuild'\/\fR
+.TP
+\fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR
+only rebuild packages that depend on specified packages
+
+.TP
+\fB\-\-dry\-run\fR
+just perform check for packages without rebuild process itself
+
+.TP
+\fB\-\-from\-database\fR
+read packages from database instead of filesystem. This feature in particular is required in case if you would like to
+restore repository from another repository instance. Note, however, that in order to restore packages you need to have
+original ahriman instance run with web service and have run repo\-update at least once.
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.SH COMMAND \fI\,'ahriman repo\-remove\-unknown'\/\fR
+usage: ahriman repo\-remove\-unknown [\-h] [\-\-dry\-run]
+
+remove packages which are missing in AUR and do not have local PKGBUILDs
+
+.SH OPTIONS \fI\,'ahriman repo\-remove\-unknown'\/\fR
+.TP
+\fB\-\-dry\-run\fR
+just perform check for packages without removal
+
+.SH COMMAND \fI\,'ahriman repo\-report'\/\fR
+usage: ahriman repo\-report [\-h]
+
+generate repository report according to current settings
+
+.SH COMMAND \fI\,'ahriman repo\-restore'\/\fR
+usage: ahriman repo\-restore [\-h] [\-o OUTPUT] path
+
+restore settings and database
+
+.TP
+\fBpath\fR
+path of the input archive
+
+.SH OPTIONS \fI\,'ahriman repo\-restore'\/\fR
+.TP
+\fB\-o\fR \fI\,OUTPUT\/\fR, \fB\-\-output\fR \fI\,OUTPUT\/\fR
+root path of the extracted files
+
+.SH COMMAND \fI\,'ahriman repo\-sign'\/\fR
+usage: ahriman repo\-sign [\-h] [package ...]
+
+(re\-)sign packages and repository database according to current settings
+
+.TP
+\fBpackage\fR
+sign only specified packages
+
+.SH COMMAND \fI\,'ahriman repo\-status\-update'\/\fR
+usage: ahriman repo\-status\-update [\-h] [\-s {unknown,pending,building,failed,success}]
+
+update repository status on the status page
+
+.SH OPTIONS \fI\,'ahriman repo\-status\-update'\/\fR
+.TP
+\fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR
+new status
+
+.SH COMMAND \fI\,'ahriman repo\-sync'\/\fR
+usage: ahriman repo\-sync [\-h]
+
+sync repository files to remote server according to current settings
+
+.SH COMMAND \fI\,'ahriman repo\-tree'\/\fR
+usage: ahriman repo\-tree [\-h]
+
+dump repository tree based on packages dependencies
+
+.SH COMMAND \fI\,'ahriman repo\-triggers'\/\fR
+usage: ahriman repo\-triggers [\-h] [trigger ...]
+
+run triggers on empty build result as configured by settings
+
+.TP
+\fBtrigger\fR
+instead of running all triggers as set by configuration, just process specified ones in order of mention
+
+.SH COMMAND \fI\,'ahriman repo\-update'\/\fR
+usage: ahriman repo\-update [\-h] [\-\-aur | \-\-no\-aur] [\-\-dependencies | \-\-no\-dependencies] [\-\-dry\-run] [\-e]
+                           [\-\-local | \-\-no\-local] [\-\-manual | \-\-no\-manual] [\-\-vcs | \-\-no\-vcs] [\-y]
+                           [package ...]
+
+check for packages updates and run build process if requested
+
+.TP
+\fBpackage\fR
+filter check by package base
+
+.SH OPTIONS \fI\,'ahriman repo\-update'\/\fR
+.TP
+\fB\-\-aur\fR, \fB\-\-no\-aur\fR
+enable or disable checking for AUR updates (default: True)
+
+.TP
+\fB\-\-dependencies\fR, \fB\-\-no\-dependencies\fR
+process missing package dependencies (default: True)
+
+.TP
+\fB\-\-dry\-run\fR
+just perform check for updates, same as check command
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-local\fR, \fB\-\-no\-local\fR
+enable or disable checking of local packages for updates (default: True)
+
+.TP
+\fB\-\-manual\fR, \fB\-\-no\-manual\fR
+include or exclude manual updates (default: True)
+
+.TP
+\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR
+fetch actual version of VCS packages (default: True)
+
+.TP
+\fB\-y\fR, \fB\-\-refresh\fR
+download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date
+
+.SH COMMAND \fI\,'ahriman service\-clean'\/\fR
+usage: ahriman service\-clean [\-h] [\-\-cache | \-\-no\-cache] [\-\-chroot | \-\-no\-chroot] [\-\-manual | \-\-no\-manual]
+                             [\-\-packages | \-\-no\-packages] [\-\-pacman | \-\-no\-pacman]
+
+remove local caches
+
+.SH OPTIONS \fI\,'ahriman service\-clean'\/\fR
+.TP
+\fB\-\-cache\fR, \fB\-\-no\-cache\fR
+clear directory with package caches (default: False)
+
+.TP
+\fB\-\-chroot\fR, \fB\-\-no\-chroot\fR
+clear build chroot (default: False)
+
+.TP
+\fB\-\-manual\fR, \fB\-\-no\-manual\fR
+clear manually added packages queue (default: False)
+
+.TP
+\fB\-\-packages\fR, \fB\-\-no\-packages\fR
+clear directory with built packages (default: False)
+
+.TP
+\fB\-\-pacman\fR, \fB\-\-no\-pacman\fR
+clear directory with pacman local database cache (default: False)
+
+.SH COMMAND \fI\,'ahriman service\-config'\/\fR
+usage: ahriman service\-config [\-h] [\-\-secure | \-\-no\-secure]
+
+dump configuration for the specified architecture
+
+.SH OPTIONS \fI\,'ahriman service\-config'\/\fR
+.TP
+\fB\-\-secure\fR, \fB\-\-no\-secure\fR
+hide passwords and secrets from output (default: True)
+
+.SH COMMAND \fI\,'ahriman service\-config\-validate'\/\fR
+usage: ahriman service\-config\-validate [\-h] [\-e]
+
+validate configuration and print found errors
+
+.SH OPTIONS \fI\,'ahriman service\-config\-validate'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if configuration is invalid
+
+.SH COMMAND \fI\,'ahriman service\-key\-import'\/\fR
+usage: ahriman service\-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
+
+.SH OPTIONS \fI\,'ahriman service\-key\-import'\/\fR
+.TP
+\fB\-\-key\-server\fR \fI\,KEY_SERVER\/\fR
+key server for key import
+
+.SH COMMAND \fI\,'ahriman service\-setup'\/\fR
+usage: ahriman service\-setup [\-h] [\-\-build\-as\-user BUILD_AS_USER] [\-\-build\-command BUILD_COMMAND]
+                             [\-\-from\-configuration FROM_CONFIGURATION] [\-\-makeflags\-jobs | \-\-no\-makeflags\-jobs]
+                             [\-\-mirror MIRROR] [\-\-multilib | \-\-no\-multilib] \-\-packager PACKAGER \-\-repository REPOSITORY
+                             [\-\-sign\-key SIGN_KEY] [\-\-sign\-target {disabled,packages,repository}] [\-\-web\-port WEB_PORT]
+                             [\-\-web\-unix\-socket WEB_UNIX_SOCKET]
+
+create initial service configuration, requires root
+
+.SH OPTIONS \fI\,'ahriman service\-setup'\/\fR
+.TP
+\fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR
+force makepkg user to the specific one
+
+.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\-\-makeflags\-jobs\fR, \fB\-\-no\-makeflags\-jobs\fR
+append MAKEFLAGS variable with parallelism set to number of cores (default: True)
+
+.TP
+\fB\-\-mirror\fR \fI\,MIRROR\/\fR
+use the specified explicitly mirror instead of including mirrorlist
+
+.TP
+\fB\-\-multilib\fR, \fB\-\-no\-multilib\fR
+add or do not multilib repository (default: True)
+
+.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 \fI\,{disabled,packages,repository}\/\fR
+sign options
+
+.TP
+\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
+port of the web service
+
+.TP
+\fB\-\-web\-unix\-socket\fR \fI\,WEB_UNIX_SOCKET\/\fR
+path to unix socket used for interprocess communications
+
+.SH COMMAND \fI\,'ahriman service\-shell'\/\fR
+usage: ahriman service\-shell [\-h] [code]
+
+drop into python shell while having created application
+
+.TP
+\fBcode\fR
+instead of dropping into shell, just execute the specified code
+
+.SH COMMAND \fI\,'ahriman user\-add'\/\fR
+usage: ahriman user\-add [\-h] [\-p PASSWORD] [\-r {unauthorized,read,reporter,full}] [\-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
+
+.SH OPTIONS \fI\,'ahriman user\-add'\/\fR
+.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 \fI\,{unauthorized,read,reporter,full}\/\fR, \fB\-\-role\fR \fI\,{unauthorized,read,reporter,full}\/\fR
+user access level
+
+.TP
+\fB\-s\fR, \fB\-\-secure\fR
+set file permissions to user\-only
+
+.SH COMMAND \fI\,'ahriman user\-list'\/\fR
+usage: ahriman user\-list [\-h] [\-e] [\-r {unauthorized,read,reporter,full}] [username]
+
+list users from the user mapping and their roles
+
+.TP
+\fBusername\fR
+filter users by username
+
+.SH OPTIONS \fI\,'ahriman user\-list'\/\fR
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-r\fR \fI\,{unauthorized,read,reporter,full}\/\fR, \fB\-\-role\fR \fI\,{unauthorized,read,reporter,full}\/\fR
+filter users by role
+
+.SH COMMAND \fI\,'ahriman user\-remove'\/\fR
+usage: ahriman user\-remove [\-h] username
+
+remove user from the user mapping and update the configuration
+
+.TP
+\fBusername\fR
+username for web service
+
+.SH COMMAND \fI\,'ahriman web'\/\fR
+usage: ahriman web [\-h]
+
+start web server
+
+.SH COMMENTS
+Argument list can also be read from file by using @ prefix.
+
+.SH AUTHORS
+.nf
+ahriman team
+.fi
+.nf
+
+.fi
+
+.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,45 @@
+ahriman.application.application package
+=======================================
+
+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:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.handlers.rst

@@ -0,0 +1,237 @@
+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.clean module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.clean
+   :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.restore module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.restore
+   :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.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.triggers module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.triggers
+   :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,38 @@
+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.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,37 @@
+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.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,45 @@
+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:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.build_tools.rst

@@ -0,0 +1,29 @@
+ahriman.core.build\_tools package
+=================================
+
+Submodules
+----------
+
+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,37 @@
+ahriman.core.configuration package
+==================================
+
+Submodules
+----------
+
+ahriman.core.configuration.configuration module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.configuration.configuration
+   :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.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,69 @@
+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:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.migrations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.operations.rst

@@ -0,0 +1,61 @@
+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.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.formatters.rst

@@ -0,0 +1,117 @@
+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.configuration\_printer module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_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.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.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.log.rst

@@ -0,0 +1,45 @@
+ahriman.core.log package
+========================
+
+Submodules
+----------
+
+ahriman.core.log.filtered\_access\_logger module
+------------------------------------------------
+
+.. automodule:: ahriman.core.log.filtered_access_logger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.http\_log\_handler module
+------------------------------------------
+
+.. automodule:: ahriman.core.log.http_log_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 module
+---------------------------
+
+.. automodule:: ahriman.core.log.log
+   :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,69 @@
+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.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.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,53 @@
+ahriman.core.repository package
+===============================
+
+Submodules
+----------
+
+ahriman.core.repository.cleaner module
+--------------------------------------
+
+.. automodule:: ahriman.core.repository.cleaner
+   :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.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,66 @@
+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.formatters
+   ahriman.core.gitremote
+   ahriman.core.log
+   ahriman.core.report
+   ahriman.core.repository
+   ahriman.core.sign
+   ahriman.core.status
+   ahriman.core.triggers
+   ahriman.core.upload
+
+Submodules
+----------
+
+ahriman.core.exceptions module
+------------------------------
+
+.. automodule:: ahriman.core.exceptions
+   :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.util module
+------------------------
+
+.. automodule:: ahriman.core.util
+   :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,37 @@
+ahriman.core.status package
+===========================
+
+Submodules
+----------
+
+ahriman.core.status.client module
+---------------------------------
+
+.. automodule:: ahriman.core.status.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.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,61 @@
+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.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,205 @@
+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.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.internal\_status module
+--------------------------------------
+
+.. automodule:: ahriman.models.internal_status
+   :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.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.pkgbuild\_patch module
+-------------------------------------
+
+.. automodule:: ahriman.models.pkgbuild_patch
+   :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\_paths module
+---------------------------------------
+
+.. automodule:: ahriman.models.repository_paths
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.result module
+----------------------------
+
+.. automodule:: ahriman.models.result
+   :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:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.models
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.rst

@@ -0,0 +1,32 @@
+ahriman package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application
+   ahriman.core
+   ahriman.models
+   ahriman.web
+
+Submodules
+----------
+
+ahriman.version module
+----------------------
+
+.. automodule:: ahriman.version
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman
+   :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,38 @@
+ahriman.web package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.middlewares
+   ahriman.web.views
+
+Submodules
+----------
+
+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.views.rst

@@ -0,0 +1,39 @@
+ahriman.web.views package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.service
+   ahriman.web.views.status
+   ahriman.web.views.user
+
+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:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.service.rst

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

docs/ahriman.web.views.status.rst

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

docs/ahriman.web.views.user.rst

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

docs/architecture.rst

@@ -0,0 +1,321 @@
+Architecture
+============
+
+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:
+
+.. image:: ahriman-architecture.svg
+   :target: _images/ahriman-architecture.svg
+   :alt: architecture
+
+``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`` class.
+
+``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.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).
+* ``ahriman.core.auth`` package provides classes for authorization methods used by web mostly. Base class is ``ahriman.core.auth.Auth`` which must be called by ``load`` method.
+* ``ahriman.core.build_tools`` is a package which provides wrapper for ``devtools`` commands.
+* ``ahriman.core.database`` is everything including data and schema migrations for database.
+* ``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.log`` is a log utils package. It includes logger loader class, custom HTTP based logger and access logger for HTTP services with additional filters.
+* ``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.triggers`` package contains base trigger classes. Classes from this package must be imported in order to implement user extensions. In fact, ``ahriman.core.report`` and ``ahriman.core.upload`` 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.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 provide 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 from 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.
+* 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.
+
+Application is designed to run from ``systemd`` services and provides parametrized by architecture 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. ``pacth-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 service doesn't guarantee that they will remain unchanged.
+
+Database
+--------
+
+The service uses SQLite database in order to store some internal info.
+
+Database instance
+^^^^^^^^^^^^^^^^^
+
+All methods related to 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 migration 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 also contain data migrations. Though the recommended way is to migrate data directly from SQL requests, 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]``, ``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
+-----------
+
+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 is 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:
+
+#. 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.
+   #. 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.
+
+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.
+
+Enumerations
+^^^^^^^^^^^^
+
+All enumerations are derived from ``str`` and ``enum.Enum``. Integer enumerations are not allowed, because most of operations require conversions from string variable. Derivation from string class 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 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 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 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 furher 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.
+
+In order to configure users there are special commands.
+
+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. 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 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).
+* Additional web features also require ``aiohttp-apispec`` (autogenerated documentation), ``aiohttp_cors`` (CORS support, required by documentation)
+* 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.
+* 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-unixsocket`` 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 both form and JSON data, but the last one is recommended. 
+
+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.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.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 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/command-line.rst

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

docs/completions/bash/_ahriman

@@ -0,0 +1,569 @@
+# AUTOMATICALLY GENERATED by `shtab`
+
+_shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' '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' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web')
+
+_shtab_ahriman_option_strings=('-h' '--help' '-a' '--architecture' '-c' '--configuration' '--force' '-l' '--lock' '--report' '--no-report' '-q' '--quiet' '--unsafe' '-V' '--version')
+_shtab_ahriman_aur_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by')
+_shtab_ahriman_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by')
+_shtab_ahriman_help_option_strings=('-h' '--help')
+_shtab_ahriman_help_commands_unsafe_option_strings=('-h' '--help' '--command')
+_shtab_ahriman_help_updates_option_strings=('-h' '--help' '-e' '--exit-code')
+_shtab_ahriman_help_version_option_strings=('-h' '--help')
+_shtab_ahriman_version_option_strings=('-h' '--help')
+_shtab_ahriman_package_add_option_strings=('-h' '--help' '--dependencies' '--no-dependencies' '-e' '--exit-code' '-n' '--now' '-y' '--refresh' '-s' '--source')
+_shtab_ahriman_add_option_strings=('-h' '--help' '--dependencies' '--no-dependencies' '-e' '--exit-code' '-n' '--now' '-y' '--refresh' '-s' '--source')
+_shtab_ahriman_package_update_option_strings=('-h' '--help' '--dependencies' '--no-dependencies' '-e' '--exit-code' '-n' '--now' '-y' '--refresh' '-s' '--source')
+_shtab_ahriman_package_remove_option_strings=('-h' '--help')
+_shtab_ahriman_remove_option_strings=('-h' '--help')
+_shtab_ahriman_package_status_option_strings=('-h' '--help' '--ahriman' '-e' '--exit-code' '--info' '--no-info' '-s' '--status')
+_shtab_ahriman_status_option_strings=('-h' '--help' '--ahriman' '-e' '--exit-code' '--info' '--no-info' '-s' '--status')
+_shtab_ahriman_package_status_remove_option_strings=('-h' '--help')
+_shtab_ahriman_package_status_update_option_strings=('-h' '--help' '-s' '--status')
+_shtab_ahriman_status_update_option_strings=('-h' '--help' '-s' '--status')
+_shtab_ahriman_patch_add_option_strings=('-h' '--help')
+_shtab_ahriman_patch_list_option_strings=('-h' '--help' '-e' '--exit-code' '-v' '--variable')
+_shtab_ahriman_patch_remove_option_strings=('-h' '--help' '-v' '--variable')
+_shtab_ahriman_patch_set_add_option_strings=('-h' '--help' '-t' '--track')
+_shtab_ahriman_repo_backup_option_strings=('-h' '--help')
+_shtab_ahriman_repo_check_option_strings=('-h' '--help' '-e' '--exit-code' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_check_option_strings=('-h' '--help' '-e' '--exit-code' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_repo_daemon_option_strings=('-h' '--help' '-i' '--interval' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_daemon_option_strings=('-h' '--help' '-i' '--interval' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_repo_rebuild_option_strings=('-h' '--help' '--depends-on' '--dry-run' '--from-database' '-e' '--exit-code')
+_shtab_ahriman_rebuild_option_strings=('-h' '--help' '--depends-on' '--dry-run' '--from-database' '-e' '--exit-code')
+_shtab_ahriman_repo_remove_unknown_option_strings=('-h' '--help' '--dry-run')
+_shtab_ahriman_remove_unknown_option_strings=('-h' '--help' '--dry-run')
+_shtab_ahriman_repo_report_option_strings=('-h' '--help')
+_shtab_ahriman_report_option_strings=('-h' '--help')
+_shtab_ahriman_repo_restore_option_strings=('-h' '--help' '-o' '--output')
+_shtab_ahriman_repo_sign_option_strings=('-h' '--help')
+_shtab_ahriman_sign_option_strings=('-h' '--help')
+_shtab_ahriman_repo_status_update_option_strings=('-h' '--help' '-s' '--status')
+_shtab_ahriman_repo_sync_option_strings=('-h' '--help')
+_shtab_ahriman_sync_option_strings=('-h' '--help')
+_shtab_ahriman_repo_tree_option_strings=('-h' '--help')
+_shtab_ahriman_repo_triggers_option_strings=('-h' '--help')
+_shtab_ahriman_repo_update_option_strings=('-h' '--help' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--dry-run' '-e' '--exit-code' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_update_option_strings=('-h' '--help' '--aur' '--no-aur' '--dependencies' '--no-dependencies' '--dry-run' '-e' '--exit-code' '--local' '--no-local' '--manual' '--no-manual' '--vcs' '--no-vcs' '-y' '--refresh')
+_shtab_ahriman_service_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman')
+_shtab_ahriman_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman')
+_shtab_ahriman_repo_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman')
+_shtab_ahriman_service_config_option_strings=('-h' '--help' '--secure' '--no-secure')
+_shtab_ahriman_config_option_strings=('-h' '--help' '--secure' '--no-secure')
+_shtab_ahriman_repo_config_option_strings=('-h' '--help' '--secure' '--no-secure')
+_shtab_ahriman_service_config_validate_option_strings=('-h' '--help' '-e' '--exit-code')
+_shtab_ahriman_config_validate_option_strings=('-h' '--help' '-e' '--exit-code')
+_shtab_ahriman_repo_config_validate_option_strings=('-h' '--help' '-e' '--exit-code')
+_shtab_ahriman_service_key_import_option_strings=('-h' '--help' '--key-server')
+_shtab_ahriman_key_import_option_strings=('-h' '--help' '--key-server')
+_shtab_ahriman_service_setup_option_strings=('-h' '--help' '--build-as-user' '--build-command' '--from-configuration' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--repository' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket')
+_shtab_ahriman_init_option_strings=('-h' '--help' '--build-as-user' '--build-command' '--from-configuration' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--repository' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket')
+_shtab_ahriman_repo_init_option_strings=('-h' '--help' '--build-as-user' '--build-command' '--from-configuration' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--repository' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket')
+_shtab_ahriman_repo_setup_option_strings=('-h' '--help' '--build-as-user' '--build-command' '--from-configuration' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--repository' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket')
+_shtab_ahriman_setup_option_strings=('-h' '--help' '--build-as-user' '--build-command' '--from-configuration' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--repository' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket')
+_shtab_ahriman_service_shell_option_strings=('-h' '--help')
+_shtab_ahriman_shell_option_strings=('-h' '--help')
+_shtab_ahriman_user_add_option_strings=('-h' '--help' '-p' '--password' '-r' '--role' '-s' '--secure')
+_shtab_ahriman_user_list_option_strings=('-h' '--help' '-e' '--exit-code' '-r' '--role')
+_shtab_ahriman_user_remove_option_strings=('-h' '--help')
+_shtab_ahriman_web_option_strings=('-h' '--help')
+
+
+
+_shtab_ahriman_pos_0_choices=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' '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' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'user-add' 'user-list' 'user-remove' 'web')
+_shtab_ahriman_aur_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version')
+_shtab_ahriman_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version')
+_shtab_ahriman_package_add__s_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_package_add___source_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_add__s_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_add___source_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_package_update__s_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_package_update___source_choices=('auto' 'archive' 'aur' 'directory' 'local' 'remote' 'repository')
+_shtab_ahriman_package_status__s_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_package_status___status_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_status__s_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_status___status_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_package_status_update__s_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_package_status_update___status_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_status_update__s_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_status_update___status_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_repo_status_update__s_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_repo_status_update___status_choices=('unknown' 'pending' 'building' 'failed' 'success')
+_shtab_ahriman_service_setup___sign_target_choices=('disabled' 'packages' 'repository')
+_shtab_ahriman_init___sign_target_choices=('disabled' 'packages' 'repository')
+_shtab_ahriman_repo_init___sign_target_choices=('disabled' 'packages' 'repository')
+_shtab_ahriman_repo_setup___sign_target_choices=('disabled' 'packages' 'repository')
+_shtab_ahriman_setup___sign_target_choices=('disabled' 'packages' 'repository')
+_shtab_ahriman_user_add__r_choices=('unauthorized' 'read' 'reporter' 'full')
+_shtab_ahriman_user_add___role_choices=('unauthorized' 'read' 'reporter' 'full')
+_shtab_ahriman_user_list__r_choices=('unauthorized' 'read' 'reporter' 'full')
+_shtab_ahriman_user_list___role_choices=('unauthorized' 'read' 'reporter' 'full')
+
+_shtab_ahriman_pos_0_nargs=A...
+_shtab_ahriman__h_nargs=0
+_shtab_ahriman___help_nargs=0
+_shtab_ahriman___force_nargs=0
+_shtab_ahriman___report_nargs=0
+_shtab_ahriman___no_report_nargs=0
+_shtab_ahriman__q_nargs=0
+_shtab_ahriman___quiet_nargs=0
+_shtab_ahriman___unsafe_nargs=0
+_shtab_ahriman__V_nargs=0
+_shtab_ahriman___version_nargs=0
+_shtab_ahriman_aur_search_pos_0_nargs=+
+_shtab_ahriman_aur_search__h_nargs=0
+_shtab_ahriman_aur_search___help_nargs=0
+_shtab_ahriman_aur_search__e_nargs=0
+_shtab_ahriman_aur_search___exit_code_nargs=0
+_shtab_ahriman_aur_search___info_nargs=0
+_shtab_ahriman_aur_search___no_info_nargs=0
+_shtab_ahriman_search_pos_0_nargs=+
+_shtab_ahriman_search__h_nargs=0
+_shtab_ahriman_search___help_nargs=0
+_shtab_ahriman_search__e_nargs=0
+_shtab_ahriman_search___exit_code_nargs=0
+_shtab_ahriman_search___info_nargs=0
+_shtab_ahriman_search___no_info_nargs=0
+_shtab_ahriman_help__h_nargs=0
+_shtab_ahriman_help___help_nargs=0
+_shtab_ahriman_help_commands_unsafe__h_nargs=0
+_shtab_ahriman_help_commands_unsafe___help_nargs=0
+_shtab_ahriman_help_updates__h_nargs=0
+_shtab_ahriman_help_updates___help_nargs=0
+_shtab_ahriman_help_updates__e_nargs=0
+_shtab_ahriman_help_updates___exit_code_nargs=0
+_shtab_ahriman_help_version__h_nargs=0
+_shtab_ahriman_help_version___help_nargs=0
+_shtab_ahriman_version__h_nargs=0
+_shtab_ahriman_version___help_nargs=0
+_shtab_ahriman_package_add_pos_0_nargs=+
+_shtab_ahriman_package_add__h_nargs=0
+_shtab_ahriman_package_add___help_nargs=0
+_shtab_ahriman_package_add___dependencies_nargs=0
+_shtab_ahriman_package_add___no_dependencies_nargs=0
+_shtab_ahriman_package_add__e_nargs=0
+_shtab_ahriman_package_add___exit_code_nargs=0
+_shtab_ahriman_package_add__n_nargs=0
+_shtab_ahriman_package_add___now_nargs=0
+_shtab_ahriman_package_add__y_nargs=0
+_shtab_ahriman_package_add___refresh_nargs=0
+_shtab_ahriman_add_pos_0_nargs=+
+_shtab_ahriman_add__h_nargs=0
+_shtab_ahriman_add___help_nargs=0
+_shtab_ahriman_add___dependencies_nargs=0
+_shtab_ahriman_add___no_dependencies_nargs=0
+_shtab_ahriman_add__e_nargs=0
+_shtab_ahriman_add___exit_code_nargs=0
+_shtab_ahriman_add__n_nargs=0
+_shtab_ahriman_add___now_nargs=0
+_shtab_ahriman_add__y_nargs=0
+_shtab_ahriman_add___refresh_nargs=0
+_shtab_ahriman_package_update_pos_0_nargs=+
+_shtab_ahriman_package_update__h_nargs=0
+_shtab_ahriman_package_update___help_nargs=0
+_shtab_ahriman_package_update___dependencies_nargs=0
+_shtab_ahriman_package_update___no_dependencies_nargs=0
+_shtab_ahriman_package_update__e_nargs=0
+_shtab_ahriman_package_update___exit_code_nargs=0
+_shtab_ahriman_package_update__n_nargs=0
+_shtab_ahriman_package_update___now_nargs=0
+_shtab_ahriman_package_update__y_nargs=0
+_shtab_ahriman_package_update___refresh_nargs=0
+_shtab_ahriman_package_remove_pos_0_nargs=+
+_shtab_ahriman_package_remove__h_nargs=0
+_shtab_ahriman_package_remove___help_nargs=0
+_shtab_ahriman_remove_pos_0_nargs=+
+_shtab_ahriman_remove__h_nargs=0
+_shtab_ahriman_remove___help_nargs=0
+_shtab_ahriman_package_status_pos_0_nargs=*
+_shtab_ahriman_package_status__h_nargs=0
+_shtab_ahriman_package_status___help_nargs=0
+_shtab_ahriman_package_status___ahriman_nargs=0
+_shtab_ahriman_package_status__e_nargs=0
+_shtab_ahriman_package_status___exit_code_nargs=0
+_shtab_ahriman_package_status___info_nargs=0
+_shtab_ahriman_package_status___no_info_nargs=0
+_shtab_ahriman_status_pos_0_nargs=*
+_shtab_ahriman_status__h_nargs=0
+_shtab_ahriman_status___help_nargs=0
+_shtab_ahriman_status___ahriman_nargs=0
+_shtab_ahriman_status__e_nargs=0
+_shtab_ahriman_status___exit_code_nargs=0
+_shtab_ahriman_status___info_nargs=0
+_shtab_ahriman_status___no_info_nargs=0
+_shtab_ahriman_package_status_remove_pos_0_nargs=+
+_shtab_ahriman_package_status_remove__h_nargs=0
+_shtab_ahriman_package_status_remove___help_nargs=0
+_shtab_ahriman_package_status_update_pos_0_nargs=*
+_shtab_ahriman_package_status_update__h_nargs=0
+_shtab_ahriman_package_status_update___help_nargs=0
+_shtab_ahriman_status_update_pos_0_nargs=*
+_shtab_ahriman_status_update__h_nargs=0
+_shtab_ahriman_status_update___help_nargs=0
+_shtab_ahriman_patch_add__h_nargs=0
+_shtab_ahriman_patch_add___help_nargs=0
+_shtab_ahriman_patch_list__h_nargs=0
+_shtab_ahriman_patch_list___help_nargs=0
+_shtab_ahriman_patch_list__e_nargs=0
+_shtab_ahriman_patch_list___exit_code_nargs=0
+_shtab_ahriman_patch_remove__h_nargs=0
+_shtab_ahriman_patch_remove___help_nargs=0
+_shtab_ahriman_patch_set_add__h_nargs=0
+_shtab_ahriman_patch_set_add___help_nargs=0
+_shtab_ahriman_repo_backup__h_nargs=0
+_shtab_ahriman_repo_backup___help_nargs=0
+_shtab_ahriman_repo_check_pos_0_nargs=*
+_shtab_ahriman_repo_check__h_nargs=0
+_shtab_ahriman_repo_check___help_nargs=0
+_shtab_ahriman_repo_check__e_nargs=0
+_shtab_ahriman_repo_check___exit_code_nargs=0
+_shtab_ahriman_repo_check___vcs_nargs=0
+_shtab_ahriman_repo_check___no_vcs_nargs=0
+_shtab_ahriman_repo_check__y_nargs=0
+_shtab_ahriman_repo_check___refresh_nargs=0
+_shtab_ahriman_check_pos_0_nargs=*
+_shtab_ahriman_check__h_nargs=0
+_shtab_ahriman_check___help_nargs=0
+_shtab_ahriman_check__e_nargs=0
+_shtab_ahriman_check___exit_code_nargs=0
+_shtab_ahriman_check___vcs_nargs=0
+_shtab_ahriman_check___no_vcs_nargs=0
+_shtab_ahriman_check__y_nargs=0
+_shtab_ahriman_check___refresh_nargs=0
+_shtab_ahriman_repo_daemon__h_nargs=0
+_shtab_ahriman_repo_daemon___help_nargs=0
+_shtab_ahriman_repo_daemon___aur_nargs=0
+_shtab_ahriman_repo_daemon___no_aur_nargs=0
+_shtab_ahriman_repo_daemon___dependencies_nargs=0
+_shtab_ahriman_repo_daemon___no_dependencies_nargs=0
+_shtab_ahriman_repo_daemon___local_nargs=0
+_shtab_ahriman_repo_daemon___no_local_nargs=0
+_shtab_ahriman_repo_daemon___manual_nargs=0
+_shtab_ahriman_repo_daemon___no_manual_nargs=0
+_shtab_ahriman_repo_daemon___vcs_nargs=0
+_shtab_ahriman_repo_daemon___no_vcs_nargs=0
+_shtab_ahriman_repo_daemon__y_nargs=0
+_shtab_ahriman_repo_daemon___refresh_nargs=0
+_shtab_ahriman_daemon__h_nargs=0
+_shtab_ahriman_daemon___help_nargs=0
+_shtab_ahriman_daemon___aur_nargs=0
+_shtab_ahriman_daemon___no_aur_nargs=0
+_shtab_ahriman_daemon___dependencies_nargs=0
+_shtab_ahriman_daemon___no_dependencies_nargs=0
+_shtab_ahriman_daemon___local_nargs=0
+_shtab_ahriman_daemon___no_local_nargs=0
+_shtab_ahriman_daemon___manual_nargs=0
+_shtab_ahriman_daemon___no_manual_nargs=0
+_shtab_ahriman_daemon___vcs_nargs=0
+_shtab_ahriman_daemon___no_vcs_nargs=0
+_shtab_ahriman_daemon__y_nargs=0
+_shtab_ahriman_daemon___refresh_nargs=0
+_shtab_ahriman_repo_rebuild__h_nargs=0
+_shtab_ahriman_repo_rebuild___help_nargs=0
+_shtab_ahriman_repo_rebuild___dry_run_nargs=0
+_shtab_ahriman_repo_rebuild___from_database_nargs=0
+_shtab_ahriman_repo_rebuild__e_nargs=0
+_shtab_ahriman_repo_rebuild___exit_code_nargs=0
+_shtab_ahriman_rebuild__h_nargs=0
+_shtab_ahriman_rebuild___help_nargs=0
+_shtab_ahriman_rebuild___dry_run_nargs=0
+_shtab_ahriman_rebuild___from_database_nargs=0
+_shtab_ahriman_rebuild__e_nargs=0
+_shtab_ahriman_rebuild___exit_code_nargs=0
+_shtab_ahriman_repo_remove_unknown__h_nargs=0
+_shtab_ahriman_repo_remove_unknown___help_nargs=0
+_shtab_ahriman_repo_remove_unknown___dry_run_nargs=0
+_shtab_ahriman_remove_unknown__h_nargs=0
+_shtab_ahriman_remove_unknown___help_nargs=0
+_shtab_ahriman_remove_unknown___dry_run_nargs=0
+_shtab_ahriman_repo_report__h_nargs=0
+_shtab_ahriman_repo_report___help_nargs=0
+_shtab_ahriman_report__h_nargs=0
+_shtab_ahriman_report___help_nargs=0
+_shtab_ahriman_repo_restore__h_nargs=0
+_shtab_ahriman_repo_restore___help_nargs=0
+_shtab_ahriman_repo_sign_pos_0_nargs=*
+_shtab_ahriman_repo_sign__h_nargs=0
+_shtab_ahriman_repo_sign___help_nargs=0
+_shtab_ahriman_sign_pos_0_nargs=*
+_shtab_ahriman_sign__h_nargs=0
+_shtab_ahriman_sign___help_nargs=0
+_shtab_ahriman_repo_status_update__h_nargs=0
+_shtab_ahriman_repo_status_update___help_nargs=0
+_shtab_ahriman_repo_sync__h_nargs=0
+_shtab_ahriman_repo_sync___help_nargs=0
+_shtab_ahriman_sync__h_nargs=0
+_shtab_ahriman_sync___help_nargs=0
+_shtab_ahriman_repo_tree__h_nargs=0
+_shtab_ahriman_repo_tree___help_nargs=0
+_shtab_ahriman_repo_triggers_pos_0_nargs=*
+_shtab_ahriman_repo_triggers__h_nargs=0
+_shtab_ahriman_repo_triggers___help_nargs=0
+_shtab_ahriman_repo_update_pos_0_nargs=*
+_shtab_ahriman_repo_update__h_nargs=0
+_shtab_ahriman_repo_update___help_nargs=0
+_shtab_ahriman_repo_update___aur_nargs=0
+_shtab_ahriman_repo_update___no_aur_nargs=0
+_shtab_ahriman_repo_update___dependencies_nargs=0
+_shtab_ahriman_repo_update___no_dependencies_nargs=0
+_shtab_ahriman_repo_update___dry_run_nargs=0
+_shtab_ahriman_repo_update__e_nargs=0
+_shtab_ahriman_repo_update___exit_code_nargs=0
+_shtab_ahriman_repo_update___local_nargs=0
+_shtab_ahriman_repo_update___no_local_nargs=0
+_shtab_ahriman_repo_update___manual_nargs=0
+_shtab_ahriman_repo_update___no_manual_nargs=0
+_shtab_ahriman_repo_update___vcs_nargs=0
+_shtab_ahriman_repo_update___no_vcs_nargs=0
+_shtab_ahriman_repo_update__y_nargs=0
+_shtab_ahriman_repo_update___refresh_nargs=0
+_shtab_ahriman_update_pos_0_nargs=*
+_shtab_ahriman_update__h_nargs=0
+_shtab_ahriman_update___help_nargs=0
+_shtab_ahriman_update___aur_nargs=0
+_shtab_ahriman_update___no_aur_nargs=0
+_shtab_ahriman_update___dependencies_nargs=0
+_shtab_ahriman_update___no_dependencies_nargs=0
+_shtab_ahriman_update___dry_run_nargs=0
+_shtab_ahriman_update__e_nargs=0
+_shtab_ahriman_update___exit_code_nargs=0
+_shtab_ahriman_update___local_nargs=0
+_shtab_ahriman_update___no_local_nargs=0
+_shtab_ahriman_update___manual_nargs=0
+_shtab_ahriman_update___no_manual_nargs=0
+_shtab_ahriman_update___vcs_nargs=0
+_shtab_ahriman_update___no_vcs_nargs=0
+_shtab_ahriman_update__y_nargs=0
+_shtab_ahriman_update___refresh_nargs=0
+_shtab_ahriman_service_clean__h_nargs=0
+_shtab_ahriman_service_clean___help_nargs=0
+_shtab_ahriman_service_clean___cache_nargs=0
+_shtab_ahriman_service_clean___no_cache_nargs=0
+_shtab_ahriman_service_clean___chroot_nargs=0
+_shtab_ahriman_service_clean___no_chroot_nargs=0
+_shtab_ahriman_service_clean___manual_nargs=0
+_shtab_ahriman_service_clean___no_manual_nargs=0
+_shtab_ahriman_service_clean___packages_nargs=0
+_shtab_ahriman_service_clean___no_packages_nargs=0
+_shtab_ahriman_service_clean___pacman_nargs=0
+_shtab_ahriman_service_clean___no_pacman_nargs=0
+_shtab_ahriman_clean__h_nargs=0
+_shtab_ahriman_clean___help_nargs=0
+_shtab_ahriman_clean___cache_nargs=0
+_shtab_ahriman_clean___no_cache_nargs=0
+_shtab_ahriman_clean___chroot_nargs=0
+_shtab_ahriman_clean___no_chroot_nargs=0
+_shtab_ahriman_clean___manual_nargs=0
+_shtab_ahriman_clean___no_manual_nargs=0
+_shtab_ahriman_clean___packages_nargs=0
+_shtab_ahriman_clean___no_packages_nargs=0
+_shtab_ahriman_clean___pacman_nargs=0
+_shtab_ahriman_clean___no_pacman_nargs=0
+_shtab_ahriman_repo_clean__h_nargs=0
+_shtab_ahriman_repo_clean___help_nargs=0
+_shtab_ahriman_repo_clean___cache_nargs=0
+_shtab_ahriman_repo_clean___no_cache_nargs=0
+_shtab_ahriman_repo_clean___chroot_nargs=0
+_shtab_ahriman_repo_clean___no_chroot_nargs=0
+_shtab_ahriman_repo_clean___manual_nargs=0
+_shtab_ahriman_repo_clean___no_manual_nargs=0
+_shtab_ahriman_repo_clean___packages_nargs=0
+_shtab_ahriman_repo_clean___no_packages_nargs=0
+_shtab_ahriman_repo_clean___pacman_nargs=0
+_shtab_ahriman_repo_clean___no_pacman_nargs=0
+_shtab_ahriman_service_config__h_nargs=0
+_shtab_ahriman_service_config___help_nargs=0
+_shtab_ahriman_service_config___secure_nargs=0
+_shtab_ahriman_service_config___no_secure_nargs=0
+_shtab_ahriman_config__h_nargs=0
+_shtab_ahriman_config___help_nargs=0
+_shtab_ahriman_config___secure_nargs=0
+_shtab_ahriman_config___no_secure_nargs=0
+_shtab_ahriman_repo_config__h_nargs=0
+_shtab_ahriman_repo_config___help_nargs=0
+_shtab_ahriman_repo_config___secure_nargs=0
+_shtab_ahriman_repo_config___no_secure_nargs=0
+_shtab_ahriman_service_config_validate__h_nargs=0
+_shtab_ahriman_service_config_validate___help_nargs=0
+_shtab_ahriman_service_config_validate__e_nargs=0
+_shtab_ahriman_service_config_validate___exit_code_nargs=0
+_shtab_ahriman_config_validate__h_nargs=0
+_shtab_ahriman_config_validate___help_nargs=0
+_shtab_ahriman_config_validate__e_nargs=0
+_shtab_ahriman_config_validate___exit_code_nargs=0
+_shtab_ahriman_repo_config_validate__h_nargs=0
+_shtab_ahriman_repo_config_validate___help_nargs=0
+_shtab_ahriman_repo_config_validate__e_nargs=0
+_shtab_ahriman_repo_config_validate___exit_code_nargs=0
+_shtab_ahriman_service_key_import__h_nargs=0
+_shtab_ahriman_service_key_import___help_nargs=0
+_shtab_ahriman_key_import__h_nargs=0
+_shtab_ahriman_key_import___help_nargs=0
+_shtab_ahriman_service_setup__h_nargs=0
+_shtab_ahriman_service_setup___help_nargs=0
+_shtab_ahriman_service_setup___makeflags_jobs_nargs=0
+_shtab_ahriman_service_setup___no_makeflags_jobs_nargs=0
+_shtab_ahriman_service_setup___multilib_nargs=0
+_shtab_ahriman_service_setup___no_multilib_nargs=0
+_shtab_ahriman_init__h_nargs=0
+_shtab_ahriman_init___help_nargs=0
+_shtab_ahriman_init___makeflags_jobs_nargs=0
+_shtab_ahriman_init___no_makeflags_jobs_nargs=0
+_shtab_ahriman_init___multilib_nargs=0
+_shtab_ahriman_init___no_multilib_nargs=0
+_shtab_ahriman_repo_init__h_nargs=0
+_shtab_ahriman_repo_init___help_nargs=0
+_shtab_ahriman_repo_init___makeflags_jobs_nargs=0
+_shtab_ahriman_repo_init___no_makeflags_jobs_nargs=0
+_shtab_ahriman_repo_init___multilib_nargs=0
+_shtab_ahriman_repo_init___no_multilib_nargs=0
+_shtab_ahriman_repo_setup__h_nargs=0
+_shtab_ahriman_repo_setup___help_nargs=0
+_shtab_ahriman_repo_setup___makeflags_jobs_nargs=0
+_shtab_ahriman_repo_setup___no_makeflags_jobs_nargs=0
+_shtab_ahriman_repo_setup___multilib_nargs=0
+_shtab_ahriman_repo_setup___no_multilib_nargs=0
+_shtab_ahriman_setup__h_nargs=0
+_shtab_ahriman_setup___help_nargs=0
+_shtab_ahriman_setup___makeflags_jobs_nargs=0
+_shtab_ahriman_setup___no_makeflags_jobs_nargs=0
+_shtab_ahriman_setup___multilib_nargs=0
+_shtab_ahriman_setup___no_multilib_nargs=0
+_shtab_ahriman_service_shell__h_nargs=0
+_shtab_ahriman_service_shell___help_nargs=0
+_shtab_ahriman_service_shell__v_nargs=0
+_shtab_ahriman_service_shell___verbose_nargs=0
+_shtab_ahriman_shell__h_nargs=0
+_shtab_ahriman_shell___help_nargs=0
+_shtab_ahriman_shell__v_nargs=0
+_shtab_ahriman_shell___verbose_nargs=0
+_shtab_ahriman_user_add__h_nargs=0
+_shtab_ahriman_user_add___help_nargs=0
+_shtab_ahriman_user_add__s_nargs=0
+_shtab_ahriman_user_add___secure_nargs=0
+_shtab_ahriman_user_list__h_nargs=0
+_shtab_ahriman_user_list___help_nargs=0
+_shtab_ahriman_user_list__e_nargs=0
+_shtab_ahriman_user_list___exit_code_nargs=0
+_shtab_ahriman_user_remove__h_nargs=0
+_shtab_ahriman_user_remove___help_nargs=0
+_shtab_ahriman_web__h_nargs=0
+_shtab_ahriman_web___help_nargs=0
+
+
+# $1=COMP_WORDS[1]
+_shtab_compgen_files() {
+  compgen -f -- $1  # files
+}
+
+# $1=COMP_WORDS[1]
+_shtab_compgen_dirs() {
+  compgen -d -- $1  # recurse into subdirs
+}
+
+# $1=COMP_WORDS[1]
+_shtab_replace_nonword() {
+  echo "${1//[^[:word:]]/_}"
+}
+
+# set default values (called for the initial parser & any subparsers)
+_set_parser_defaults() {
+  local subparsers_var="${prefix}_subparsers[@]"
+  sub_parsers=${!subparsers_var}
+
+  local current_option_strings_var="${prefix}_option_strings[@]"
+  current_option_strings=${!current_option_strings_var}
+
+  completed_positional_actions=0
+
+  _set_new_action "pos_${completed_positional_actions}" true
+}
+
+# $1=action identifier
+# $2=positional action (bool)
+# set all identifiers for an action's parameters
+_set_new_action() {
+  current_action="${prefix}_$(_shtab_replace_nonword $1)"
+
+  local current_action_compgen_var=${current_action}_COMPGEN
+  current_action_compgen="${!current_action_compgen_var}"
+
+  local current_action_choices_var="${current_action}_choices[@]"
+  current_action_choices="${!current_action_choices_var}"
+
+  local current_action_nargs_var="${current_action}_nargs"
+  if [ -n "${!current_action_nargs_var}" ]; then
+    current_action_nargs="${!current_action_nargs_var}"
+  else
+    current_action_nargs=1
+  fi
+
+  current_action_args_start_index=$(( $word_index + 1 ))
+
+  current_action_is_positional=$2
+}
+
+# Notes:
+# `COMPREPLY`: what will be rendered after completion is triggered
+# `completing_word`: currently typed word to generate completions for
+# `${!var}`: evaluates the content of `var` and expand its content as a variable
+#     hello="world"
+#     x="hello"
+#     ${!x} -> ${hello} -> "world"
+_shtab_ahriman() {
+  local completing_word="${COMP_WORDS[COMP_CWORD]}"
+  COMPREPLY=()
+
+  prefix=_shtab_ahriman
+  word_index=0
+  _set_parser_defaults
+  word_index=1
+
+  # determine what arguments are appropriate for the current state
+  # of the arg parser
+  while [ $word_index -ne $COMP_CWORD ]; do
+    local this_word="${COMP_WORDS[$word_index]}"
+
+    if [[ -n $sub_parsers && " ${sub_parsers[@]} " =~ " ${this_word} " ]]; then
+      # valid subcommand: add it to the prefix & reset the current action
+      prefix="${prefix}_$(_shtab_replace_nonword $this_word)"
+      _set_parser_defaults
+    fi
+
+    if [[ " ${current_option_strings[@]} " =~ " ${this_word} " ]]; then
+      # a new action should be acquired (due to recognised option string or
+      # no more input expected from current action);
+      # the next positional action can fill in here
+      _set_new_action $this_word false
+    fi
+
+    if [[ "$current_action_nargs" != "*" ]] && \
+       [[ "$current_action_nargs" != "+" ]] && \
+       [[ "$current_action_nargs" != *"..." ]] && \
+       (( $word_index + 1 - $current_action_args_start_index >= \
+          $current_action_nargs )); then
+      $current_action_is_positional && let "completed_positional_actions += 1"
+      _set_new_action "pos_${completed_positional_actions}" true
+    fi
+
+    let "word_index+=1"
+  done
+
+  # Generate the completions
+
+  if [[ "${completing_word}" == -* ]]; then
+    # optional argument started: use option strings
+    COMPREPLY=( $(compgen -W "${current_option_strings[*]}" -- "${completing_word}") )
+  else
+    # use choices & compgen
+    local IFS=$'\n' # items may contain spaces, so delimit using newline
+    COMPREPLY=( $([ -n "${current_action_compgen}" ] \
+                  && "${current_action_compgen}" "${completing_word}") )
+    unset IFS
+    COMPREPLY+=( $(compgen -W "${current_action_choices[*]}" -- "${completing_word}") )
+  fi
+
+  return 0
+}
+
+complete -o filenames -F _shtab_ahriman ahriman

docs/completions/zsh/_ahriman

@@ -0,0 +1,638 @@
+#compdef ahriman
+
+# AUTOMATICALLY GENERATED by `shtab`
+
+
+_shtab_ahriman_commands() {
+  local _commands=(
+    "add:add existing or new package to the build queue"
+    "aur-search:search for package in AUR using API"
+    "check:check for packages updates. Same as repo-update --dry-run --no-manual"
+    "clean:remove local caches"
+    "config:dump configuration for the specified architecture"
+    "config-validate:validate configuration and print found errors"
+    "daemon:start process which periodically will run update process"
+    "help:show help message for application or command and exit"
+    "help-commands-unsafe:list unsafe commands as defined in default args"
+    "help-updates:request AUR for current version and compare with current service version"
+    "help-version:print application and its dependencies versions"
+    "init:create initial service configuration, requires root"
+    "key-import:import PGP key from public sources to the repository user"
+    "package-add:add existing or new package to the build queue"
+    "package-remove:remove package from the repository"
+    "package-status:request status of the package"
+    "package-status-remove:remove the package from the status page"
+    "package-status-update:update package status on the status page"
+    "package-update:add existing or new package to the build queue"
+    "patch-add:create or update patched PKGBUILD function or variable"
+    "patch-list:list available patches for the package"
+    "patch-remove:remove patches for the package"
+    "patch-set-add:create or update source patches"
+    "rebuild:force rebuild whole repository"
+    "remove:remove package from the repository"
+    "remove-unknown:remove packages which are missing in AUR and do not have local PKGBUILDs"
+    "repo-backup:backup repository settings and database"
+    "repo-check:check for packages updates. Same as repo-update --dry-run --no-manual"
+    "repo-clean:remove local caches"
+    "repo-config:dump configuration for the specified architecture"
+    "repo-config-validate:validate configuration and print found errors"
+    "repo-daemon:start process which periodically will run update process"
+    "repo-init:create initial service configuration, requires root"
+    "repo-rebuild:force rebuild whole repository"
+    "repo-remove-unknown:remove packages which are missing in AUR and do not have local PKGBUILDs"
+    "repo-report:generate repository report according to current settings"
+    "repo-restore:restore settings and database"
+    "repo-setup:create initial service configuration, requires root"
+    "repo-sign:(re-)sign packages and repository database according to current settings"
+    "repo-status-update:update repository status on the status page"
+    "repo-sync:sync repository files to remote server according to current settings"
+    "repo-tree:dump repository tree based on packages dependencies"
+    "repo-triggers:run triggers on empty build result as configured by settings"
+    "repo-update:check for packages updates and run build process if requested"
+    "report:generate repository report according to current settings"
+    "search:search for package in AUR using API"
+    "service-clean:remove local caches"
+    "service-config:dump configuration for the specified architecture"
+    "service-config-validate:validate configuration and print found errors"
+    "service-key-import:import PGP key from public sources to the repository user"
+    "service-setup:create initial service configuration, requires root"
+    "service-shell:drop into python shell while having created application"
+    "setup:create initial service configuration, requires root"
+    "shell:drop into python shell while having created application"
+    "sign:(re-)sign packages and repository database according to current settings"
+    "status:request status of the package"
+    "status-update:update package status on the status page"
+    "sync:sync repository files to remote server according to current settings"
+    "update:check for packages updates and run build process if requested"
+    "user-add:update user for web services with the given password and role. In case if password was not entered it will be asked interactively"
+    "user-list:list users from the user mapping and their roles"
+    "user-remove:remove user from the user mapping and update the configuration"
+    "version:print application and its dependencies versions"
+    "web:start web server"
+  )
+  _describe 'ahriman commands' _commands
+}
+
+_shtab_ahriman_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "*"{-a,--architecture}"[target architectures. For several subcommands it can be used multiple times]:architecture:"
+  {-c,--configuration}"[configuration path]:configuration:"
+  "--force[force run, remove file lock]"
+  {-l,--lock}"[lock file]:lock:"
+  {--report,--no-report}"[force enable or disable reporting to web service (default\: \%(default)s)]:report:"
+  {-q,--quiet}"[force disable any logging]"
+  "--unsafe[allow to run ahriman as non-ahriman user. Some actions might be unavailable]"
+  "(- : *)"{-V,--version}"[show program\'s version number and exit]"
+)
+
+_shtab_ahriman_add_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {-n,--now}"[run update function after]"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  {-s,--source}"[explicitly specify the package source for this command]:source:(auto archive aur directory local remote repository)"
+  "(*):package source (base name, path to local files, remote URL):"
+)
+
+_shtab_ahriman_aur_search_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--info,--no-info}"[show additional package information (default\: \%(default)s)]:info:"
+  "--sort-by[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]:sort_by:(description first_submitted id last_modified maintainer name num_votes out_of_date package_base package_base_id popularity repository submitter url url_path version)"
+  "(*):search terms, can be specified multiple times, the result will match all terms:"
+)
+
+_shtab_ahriman_check_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  "(*)::filter check by package base:"
+)
+
+_shtab_ahriman_clean_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--cache,--no-cache}"[clear directory with package caches (default\: \%(default)s)]:cache:"
+  {--chroot,--no-chroot}"[clear build chroot (default\: \%(default)s)]:chroot:"
+  {--manual,--no-manual}"[clear manually added packages queue (default\: \%(default)s)]:manual:"
+  {--packages,--no-packages}"[clear directory with built packages (default\: \%(default)s)]:packages:"
+  {--pacman,--no-pacman}"[clear directory with pacman local database cache (default\: \%(default)s)]:pacman:"
+)
+
+_shtab_ahriman_config_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--secure,--no-secure}"[hide passwords and secrets from output (default\: \%(default)s)]:secure:"
+)
+
+_shtab_ahriman_config_validate_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if configuration is invalid]"
+)
+
+_shtab_ahriman_daemon_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-i,--interval}"[interval between runs in seconds]:interval:"
+  {--aur,--no-aur}"[enable or disable checking for AUR updates (default\: \%(default)s)]:aur:"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  {--local,--no-local}"[enable or disable checking of local packages for updates (default\: \%(default)s)]:local:"
+  {--manual,--no-manual}"[include or exclude manual updates (default\: \%(default)s)]:manual:"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+)
+
+_shtab_ahriman_help_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":show help message for specific command:"
+)
+
+_shtab_ahriman_help_commands_unsafe_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--command[instead of showing commands, just test command line for unsafe subcommand and return 0 in case if command is safe and 1 otherwise]:command:"
+)
+
+_shtab_ahriman_help_updates_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit code if updates available]"
+)
+
+_shtab_ahriman_help_version_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_init_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--build-as-user[force makepkg user to the specific one]:build_as_user:"
+  "--build-command[build command prefix]:build_command:"
+  "--from-configuration[path to default devtools pacman configuration]:from_configuration:"
+  {--makeflags-jobs,--no-makeflags-jobs}"[append MAKEFLAGS variable with parallelism set to number of cores (default\: \%(default)s)]:makeflags_jobs:"
+  "--mirror[use the specified explicitly mirror instead of including mirrorlist]:mirror:"
+  {--multilib,--no-multilib}"[add or do not multilib repository (default\: \%(default)s)]:multilib:"
+  "--packager[packager name and email]:packager:"
+  "--repository[repository name]:repository:"
+  "--sign-key[sign key id]:sign_key:"
+  "*--sign-target[sign options]:sign_target:(disabled packages repository)"
+  "--web-port[port of the web service]:web_port:"
+  "--web-unix-socket[path to unix socket used for interprocess communications]:web_unix_socket:"
+)
+
+_shtab_ahriman_key_import_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--key-server[key server for key import]:key_server:"
+  ":PGP key to import from public server:"
+)
+
+_shtab_ahriman_package_add_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {-n,--now}"[run update function after]"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  {-s,--source}"[explicitly specify the package source for this command]:source:(auto archive aur directory local remote repository)"
+  "(*):package source (base name, path to local files, remote URL):"
+)
+
+_shtab_ahriman_package_remove_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*):package name or base:"
+)
+
+_shtab_ahriman_package_status_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--ahriman[get service status itself]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--info,--no-info}"[show additional package information (default\: \%(default)s)]:info:"
+  {-s,--status}"[filter packages by status]:status:(unknown pending building failed success)"
+  "(*)::filter status by package base:"
+)
+
+_shtab_ahriman_package_status_remove_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*):remove specified packages from status page:"
+)
+
+_shtab_ahriman_package_status_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-s,--status}"[new package build status]:status:(unknown pending building failed success)"
+  "(*)::set status for specified packages. If no packages supplied, service status will be updated:"
+)
+
+_shtab_ahriman_package_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {-n,--now}"[run update function after]"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  {-s,--source}"[explicitly specify the package source for this command]:source:(auto archive aur directory local remote repository)"
+  "(*):package source (base name, path to local files, remote URL):"
+)
+
+_shtab_ahriman_patch_add_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":package base:"
+  ":PKGBUILD variable or function name. If variable is a function, it must end with ():"
+  ":path to file which contains function or variable value. If not set, the value will be read from stdin:"
+)
+
+_shtab_ahriman_patch_list_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  "*"{-v,--variable}"[if set, show only patches for specified PKGBUILD variables]:variable:"
+  ":package base:"
+)
+
+_shtab_ahriman_patch_remove_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "*"{-v,--variable}"[should be used for single-function patches in case if you wold like to remove only specified PKGBUILD variables. In case if not set, it will remove all patches related to the package]:variable:"
+  ":package base:"
+)
+
+_shtab_ahriman_patch_set_add_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "*"{-t,--track}"[files which has to be tracked]:track:"
+  ":path to directory with changed files for patch addition\/update:"
+)
+
+_shtab_ahriman_rebuild_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "*--depends-on[only rebuild packages that depend on specified packages]:depends_on:"
+  "--dry-run[just perform check for packages without rebuild process itself]"
+  "--from-database[read packages from database instead of filesystem. This feature in particular is required in case if you would like to restore repository from another repository instance. Note, however, that in order to restore packages you need to have original ahriman instance run with web service and have run repo-update at least once.]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+)
+
+_shtab_ahriman_remove_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*):package name or base:"
+)
+
+_shtab_ahriman_remove_unknown_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--dry-run[just perform check for packages without removal]"
+)
+
+_shtab_ahriman_repo_backup_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":path of the output archive:"
+)
+
+_shtab_ahriman_repo_check_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  "(*)::filter check by package base:"
+)
+
+_shtab_ahriman_repo_clean_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--cache,--no-cache}"[clear directory with package caches (default\: \%(default)s)]:cache:"
+  {--chroot,--no-chroot}"[clear build chroot (default\: \%(default)s)]:chroot:"
+  {--manual,--no-manual}"[clear manually added packages queue (default\: \%(default)s)]:manual:"
+  {--packages,--no-packages}"[clear directory with built packages (default\: \%(default)s)]:packages:"
+  {--pacman,--no-pacman}"[clear directory with pacman local database cache (default\: \%(default)s)]:pacman:"
+)
+
+_shtab_ahriman_repo_config_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--secure,--no-secure}"[hide passwords and secrets from output (default\: \%(default)s)]:secure:"
+)
+
+_shtab_ahriman_repo_config_validate_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if configuration is invalid]"
+)
+
+_shtab_ahriman_repo_daemon_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-i,--interval}"[interval between runs in seconds]:interval:"
+  {--aur,--no-aur}"[enable or disable checking for AUR updates (default\: \%(default)s)]:aur:"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  {--local,--no-local}"[enable or disable checking of local packages for updates (default\: \%(default)s)]:local:"
+  {--manual,--no-manual}"[include or exclude manual updates (default\: \%(default)s)]:manual:"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+)
+
+_shtab_ahriman_repo_init_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--build-as-user[force makepkg user to the specific one]:build_as_user:"
+  "--build-command[build command prefix]:build_command:"
+  "--from-configuration[path to default devtools pacman configuration]:from_configuration:"
+  {--makeflags-jobs,--no-makeflags-jobs}"[append MAKEFLAGS variable with parallelism set to number of cores (default\: \%(default)s)]:makeflags_jobs:"
+  "--mirror[use the specified explicitly mirror instead of including mirrorlist]:mirror:"
+  {--multilib,--no-multilib}"[add or do not multilib repository (default\: \%(default)s)]:multilib:"
+  "--packager[packager name and email]:packager:"
+  "--repository[repository name]:repository:"
+  "--sign-key[sign key id]:sign_key:"
+  "*--sign-target[sign options]:sign_target:(disabled packages repository)"
+  "--web-port[port of the web service]:web_port:"
+  "--web-unix-socket[path to unix socket used for interprocess communications]:web_unix_socket:"
+)
+
+_shtab_ahriman_repo_rebuild_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "*--depends-on[only rebuild packages that depend on specified packages]:depends_on:"
+  "--dry-run[just perform check for packages without rebuild process itself]"
+  "--from-database[read packages from database instead of filesystem. This feature in particular is required in case if you would like to restore repository from another repository instance. Note, however, that in order to restore packages you need to have original ahriman instance run with web service and have run repo-update at least once.]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+)
+
+_shtab_ahriman_repo_remove_unknown_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--dry-run[just perform check for packages without removal]"
+)
+
+_shtab_ahriman_repo_report_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_repo_restore_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-o,--output}"[root path of the extracted files]:output:"
+  ":path of the input archive:"
+)
+
+_shtab_ahriman_repo_setup_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--build-as-user[force makepkg user to the specific one]:build_as_user:"
+  "--build-command[build command prefix]:build_command:"
+  "--from-configuration[path to default devtools pacman configuration]:from_configuration:"
+  {--makeflags-jobs,--no-makeflags-jobs}"[append MAKEFLAGS variable with parallelism set to number of cores (default\: \%(default)s)]:makeflags_jobs:"
+  "--mirror[use the specified explicitly mirror instead of including mirrorlist]:mirror:"
+  {--multilib,--no-multilib}"[add or do not multilib repository (default\: \%(default)s)]:multilib:"
+  "--packager[packager name and email]:packager:"
+  "--repository[repository name]:repository:"
+  "--sign-key[sign key id]:sign_key:"
+  "*--sign-target[sign options]:sign_target:(disabled packages repository)"
+  "--web-port[port of the web service]:web_port:"
+  "--web-unix-socket[path to unix socket used for interprocess communications]:web_unix_socket:"
+)
+
+_shtab_ahriman_repo_sign_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*)::sign only specified packages:"
+)
+
+_shtab_ahriman_repo_status_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-s,--status}"[new status]:status:(unknown pending building failed success)"
+)
+
+_shtab_ahriman_repo_sync_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_repo_tree_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_repo_triggers_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*)::instead of running all triggers as set by configuration, just process specified ones in order of mention:"
+)
+
+_shtab_ahriman_repo_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--aur,--no-aur}"[enable or disable checking for AUR updates (default\: \%(default)s)]:aur:"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  "--dry-run[just perform check for updates, same as check command]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--local,--no-local}"[enable or disable checking of local packages for updates (default\: \%(default)s)]:local:"
+  {--manual,--no-manual}"[include or exclude manual updates (default\: \%(default)s)]:manual:"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  "(*)::filter check by package base:"
+)
+
+_shtab_ahriman_report_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_search_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--info,--no-info}"[show additional package information (default\: \%(default)s)]:info:"
+  "--sort-by[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]:sort_by:(description first_submitted id last_modified maintainer name num_votes out_of_date package_base package_base_id popularity repository submitter url url_path version)"
+  "(*):search terms, can be specified multiple times, the result will match all terms:"
+)
+
+_shtab_ahriman_service_clean_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--cache,--no-cache}"[clear directory with package caches (default\: \%(default)s)]:cache:"
+  {--chroot,--no-chroot}"[clear build chroot (default\: \%(default)s)]:chroot:"
+  {--manual,--no-manual}"[clear manually added packages queue (default\: \%(default)s)]:manual:"
+  {--packages,--no-packages}"[clear directory with built packages (default\: \%(default)s)]:packages:"
+  {--pacman,--no-pacman}"[clear directory with pacman local database cache (default\: \%(default)s)]:pacman:"
+)
+
+_shtab_ahriman_service_config_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--secure,--no-secure}"[hide passwords and secrets from output (default\: \%(default)s)]:secure:"
+)
+
+_shtab_ahriman_service_config_validate_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if configuration is invalid]"
+)
+
+_shtab_ahriman_service_key_import_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--key-server[key server for key import]:key_server:"
+  ":PGP key to import from public server:"
+)
+
+_shtab_ahriman_service_setup_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--build-as-user[force makepkg user to the specific one]:build_as_user:"
+  "--build-command[build command prefix]:build_command:"
+  "--from-configuration[path to default devtools pacman configuration]:from_configuration:"
+  {--makeflags-jobs,--no-makeflags-jobs}"[append MAKEFLAGS variable with parallelism set to number of cores (default\: \%(default)s)]:makeflags_jobs:"
+  "--mirror[use the specified explicitly mirror instead of including mirrorlist]:mirror:"
+  {--multilib,--no-multilib}"[add or do not multilib repository (default\: \%(default)s)]:multilib:"
+  "--packager[packager name and email]:packager:"
+  "--repository[repository name]:repository:"
+  "--sign-key[sign key id]:sign_key:"
+  "*--sign-target[sign options]:sign_target:(disabled packages repository)"
+  "--web-port[port of the web service]:web_port:"
+  "--web-unix-socket[path to unix socket used for interprocess communications]:web_unix_socket:"
+)
+
+_shtab_ahriman_service_shell_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":instead of dropping into shell, just execute the specified code:"
+)
+
+_shtab_ahriman_setup_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--build-as-user[force makepkg user to the specific one]:build_as_user:"
+  "--build-command[build command prefix]:build_command:"
+  "--from-configuration[path to default devtools pacman configuration]:from_configuration:"
+  {--makeflags-jobs,--no-makeflags-jobs}"[append MAKEFLAGS variable with parallelism set to number of cores (default\: \%(default)s)]:makeflags_jobs:"
+  "--mirror[use the specified explicitly mirror instead of including mirrorlist]:mirror:"
+  {--multilib,--no-multilib}"[add or do not multilib repository (default\: \%(default)s)]:multilib:"
+  "--packager[packager name and email]:packager:"
+  "--repository[repository name]:repository:"
+  "--sign-key[sign key id]:sign_key:"
+  "*--sign-target[sign options]:sign_target:(disabled packages repository)"
+  "--web-port[port of the web service]:web_port:"
+  "--web-unix-socket[path to unix socket used for interprocess communications]:web_unix_socket:"
+)
+
+_shtab_ahriman_shell_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":instead of dropping into shell, just execute the specified code:"
+)
+
+_shtab_ahriman_sign_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "(*)::sign only specified packages:"
+)
+
+_shtab_ahriman_status_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  "--ahriman[get service status itself]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--info,--no-info}"[show additional package information (default\: \%(default)s)]:info:"
+  {-s,--status}"[filter packages by status]:status:(unknown pending building failed success)"
+  "(*)::filter status by package base:"
+)
+
+_shtab_ahriman_status_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-s,--status}"[new package build status]:status:(unknown pending building failed success)"
+  "(*)::set status for specified packages. If no packages supplied, service status will be updated:"
+)
+
+_shtab_ahriman_sync_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_update_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {--aur,--no-aur}"[enable or disable checking for AUR updates (default\: \%(default)s)]:aur:"
+  {--dependencies,--no-dependencies}"[process missing package dependencies (default\: \%(default)s)]:dependencies:"
+  "--dry-run[just perform check for updates, same as check command]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {--local,--no-local}"[enable or disable checking of local packages for updates (default\: \%(default)s)]:local:"
+  {--manual,--no-manual}"[include or exclude manual updates (default\: \%(default)s)]:manual:"
+  {--vcs,--no-vcs}"[fetch actual version of VCS packages (default\: \%(default)s)]:vcs:"
+  "*"{-y,--refresh}"[download fresh package databases from the mirror before actions, -yy to force refresh even if up to date]"
+  "(*)::filter check by package base:"
+)
+
+_shtab_ahriman_user_add_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-p,--password}"[user password. Blank password will be treated as empty password, which is in particular must be used for OAuth2 authorization type.]:password:"
+  {-r,--role}"[user access level]:role:(unauthorized read reporter full)"
+  {-s,--secure}"[set file permissions to user-only]"
+  ":username for web service:"
+)
+
+_shtab_ahriman_user_list_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  {-e,--exit-code}"[return non-zero exit status if result is empty]"
+  {-r,--role}"[filter users by role]:role:(unauthorized read reporter full)"
+  ":filter users by username:"
+)
+
+_shtab_ahriman_user_remove_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+  ":username for web service:"
+)
+
+_shtab_ahriman_version_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+_shtab_ahriman_web_options=(
+  "(- : *)"{-h,--help}"[show this help message and exit]"
+)
+
+
+_shtab_ahriman() {
+  local context state line curcontext="$curcontext" one_or_more='(-)*' remainder='(*)'
+
+  if ((${_shtab_ahriman_options[(I)${(q)one_or_more}*]} + ${_shtab_ahriman_options[(I)${(q)remainder}*]} == 0)); then  # noqa: E501
+    _shtab_ahriman_options+=(': :_shtab_ahriman_commands' '*::: :->ahriman')
+  fi
+  _arguments -C $_shtab_ahriman_options
+
+  case $state in
+    ahriman)
+      words=($line[1] "${words[@]}")
+      (( CURRENT += 1 ))
+      curcontext="${curcontext%:*:*}:_shtab_ahriman-$line[1]:"
+      case $line[1] in
+        add) _arguments -C $_shtab_ahriman_add_options ;;
+        aur-search) _arguments -C $_shtab_ahriman_aur_search_options ;;
+        check) _arguments -C $_shtab_ahriman_check_options ;;
+        clean) _arguments -C $_shtab_ahriman_clean_options ;;
+        config) _arguments -C $_shtab_ahriman_config_options ;;
+        config-validate) _arguments -C $_shtab_ahriman_config_validate_options ;;
+        daemon) _arguments -C $_shtab_ahriman_daemon_options ;;
+        help) _arguments -C $_shtab_ahriman_help_options ;;
+        help-commands-unsafe) _arguments -C $_shtab_ahriman_help_commands_unsafe_options ;;
+        help-updates) _arguments -C $_shtab_ahriman_help_updates_options ;;
+        help-version) _arguments -C $_shtab_ahriman_help_version_options ;;
+        init) _arguments -C $_shtab_ahriman_init_options ;;
+        key-import) _arguments -C $_shtab_ahriman_key_import_options ;;
+        package-add) _arguments -C $_shtab_ahriman_package_add_options ;;
+        package-remove) _arguments -C $_shtab_ahriman_package_remove_options ;;
+        package-status) _arguments -C $_shtab_ahriman_package_status_options ;;
+        package-status-remove) _arguments -C $_shtab_ahriman_package_status_remove_options ;;
+        package-status-update) _arguments -C $_shtab_ahriman_package_status_update_options ;;
+        package-update) _arguments -C $_shtab_ahriman_package_update_options ;;
+        patch-add) _arguments -C $_shtab_ahriman_patch_add_options ;;
+        patch-list) _arguments -C $_shtab_ahriman_patch_list_options ;;
+        patch-remove) _arguments -C $_shtab_ahriman_patch_remove_options ;;
+        patch-set-add) _arguments -C $_shtab_ahriman_patch_set_add_options ;;
+        rebuild) _arguments -C $_shtab_ahriman_rebuild_options ;;
+        remove) _arguments -C $_shtab_ahriman_remove_options ;;
+        remove-unknown) _arguments -C $_shtab_ahriman_remove_unknown_options ;;
+        repo-backup) _arguments -C $_shtab_ahriman_repo_backup_options ;;
+        repo-check) _arguments -C $_shtab_ahriman_repo_check_options ;;
+        repo-clean) _arguments -C $_shtab_ahriman_repo_clean_options ;;
+        repo-config) _arguments -C $_shtab_ahriman_repo_config_options ;;
+        repo-config-validate) _arguments -C $_shtab_ahriman_repo_config_validate_options ;;
+        repo-daemon) _arguments -C $_shtab_ahriman_repo_daemon_options ;;
+        repo-init) _arguments -C $_shtab_ahriman_repo_init_options ;;
+        repo-rebuild) _arguments -C $_shtab_ahriman_repo_rebuild_options ;;
+        repo-remove-unknown) _arguments -C $_shtab_ahriman_repo_remove_unknown_options ;;
+        repo-report) _arguments -C $_shtab_ahriman_repo_report_options ;;
+        repo-restore) _arguments -C $_shtab_ahriman_repo_restore_options ;;
+        repo-setup) _arguments -C $_shtab_ahriman_repo_setup_options ;;
+        repo-sign) _arguments -C $_shtab_ahriman_repo_sign_options ;;
+        repo-status-update) _arguments -C $_shtab_ahriman_repo_status_update_options ;;
+        repo-sync) _arguments -C $_shtab_ahriman_repo_sync_options ;;
+        repo-tree) _arguments -C $_shtab_ahriman_repo_tree_options ;;
+        repo-triggers) _arguments -C $_shtab_ahriman_repo_triggers_options ;;
+        repo-update) _arguments -C $_shtab_ahriman_repo_update_options ;;
+        report) _arguments -C $_shtab_ahriman_report_options ;;
+        search) _arguments -C $_shtab_ahriman_search_options ;;
+        service-clean) _arguments -C $_shtab_ahriman_service_clean_options ;;
+        service-config) _arguments -C $_shtab_ahriman_service_config_options ;;
+        service-config-validate) _arguments -C $_shtab_ahriman_service_config_validate_options ;;
+        service-key-import) _arguments -C $_shtab_ahriman_service_key_import_options ;;
+        service-setup) _arguments -C $_shtab_ahriman_service_setup_options ;;
+        service-shell) _arguments -C $_shtab_ahriman_service_shell_options ;;
+        setup) _arguments -C $_shtab_ahriman_setup_options ;;
+        shell) _arguments -C $_shtab_ahriman_shell_options ;;
+        sign) _arguments -C $_shtab_ahriman_sign_options ;;
+        status) _arguments -C $_shtab_ahriman_status_options ;;
+        status-update) _arguments -C $_shtab_ahriman_status_update_options ;;
+        sync) _arguments -C $_shtab_ahriman_sync_options ;;
+        update) _arguments -C $_shtab_ahriman_update_options ;;
+        user-add) _arguments -C $_shtab_ahriman_user_add_options ;;
+        user-list) _arguments -C $_shtab_ahriman_user_list_options ;;
+        user-remove) _arguments -C $_shtab_ahriman_user_remove_options ;;
+        version) _arguments -C $_shtab_ahriman_version_options ;;
+        web) _arguments -C $_shtab_ahriman_web_options ;;
+      esac
+  esac
+}
+
+
+
+typeset -A opt_args
+_shtab_ahriman "$@"

docs/conf.py

@@ -0,0 +1,97 @@
+# 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 os
+import sys
+
+from pathlib import Path
+from unittest import mock
+
+from ahriman.version import __version__
+
+
+basedir = Path(__file__).resolve().parent.parent / "src"
+sys.path.insert(0, str(basedir))
+
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+for module in (
+        "pyalpm",
+):
+    if module in sys.modules:
+        continue
+    sys.modules[module] = mock.Mock()
+
+
+# -- Project information -----------------------------------------------------
+
+project = "ahriman"
+copyright = "2021-2023, 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.napoleon",
+    "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 = "default" if on_rtd else "alabaster"
+
+# 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 = []
+
+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_default_options = {
+    "no-undoc-members": True,
+}

docs/configuration.rst

@@ -0,0 +1,266 @@
+Configuration
+=============
+
+Some groups can be specified for each architecture 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.
+
+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 rise an exception.
+
+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``.
+
+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 -a x86_64 service-config-validate
+
+It will check current settings on common errors and compare configuration with known schema.
+
+``settings`` group
+------------------
+
+Base configuration settings.
+
+* ``include`` - path to directory with configuration files overrides, string, required.
+* ``database`` - path to SQLite database, string, required.
+* ``logging`` - path to logging configuration, string, required. Check ``logging.ini`` for reference.
+* ``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.
+
+``alpm`` group
+--------------
+
+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 syncronization, 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, space separated list of strings, required.
+* ``root`` - root for alpm library, string, 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).
+
+``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``.
+* ``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 url-safe base64-encoded bytes 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 expired during restart.
+* ``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.
+* ``salt`` - password hash salt, string, required in case if authorization enabled (automatically generated by ``user-add`` subcommand).
+
+Authorized users are stored inside internal database, if any of external provides 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.
+* ``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.
+* ``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 mention.
+* ``vcs_allowed_age`` - maximal age in seconds of the VCS packages before their version will be updated with its remote source, int, optional, default ``604800``.
+
+``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.
+
+``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.
+* ``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.
+* ``username`` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.
+
+``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_author`` - git commit author, string, optional. In case if not set, the git will generate author for you. Note, however, that in this case it will disclosure your hostname.
+* ``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.
+* ``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.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``path`` - path to html report file, string, required.
+* ``template_path`` - path to Jinja2 template, string, 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.
+* ``template_path`` - path to Jinja2 template, string, required.
+* ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``, ``HTML``, ``Markdown``, string, optional, default ``HTML``.
+* ``timeout`` - HTTP request timeout in seconds, int, 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, int, optional, default is ``30``.
+* ``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.

docs/faq.rst

@@ -0,0 +1,996 @@
+
+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 to install ahriman
+^^^^^^^^^^^^^^^^^^^^^^
+
+TL;DR
+
+.. code-block:: shell
+
+   yay -S ahriman
+   ahriman -a x86_64 service-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 :doc:`here <setup>`.
+
+How to validate settings
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is special command which can be used in order to validate current configuration:
+
+.. code-block:: shell
+
+   ahriman -a x86_64 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.
+
+How to generate build reports
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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:
+
+.. 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 do I 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, 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.
+
+
+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.
+
+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
+
+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).
+
+How to build package from official repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+So 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 -s 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 configure timer for this.
+
+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, however it requires additional dependencies:
+
+.. code-block:: shell
+
+   pacman -S breezy darcs mercurial subversion
+
+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 differ. 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 hash, something like ``8BE91E5A773FB48AC05CC1EDBED105AED6246B39``. Copy it.
+
+#.
+   Export your private key by using the hash 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.
+
+However, note that you do not need to rebuild repository in case if you just changed signing option, just use ``repo-sign`` command instead. 
+
+How to install built packages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Add the following lines to your ``pacman.conf``:
+
+.. code-block:: ini
+
+   [repository]
+   Server = file:///var/lib/ahriman/repository/x86_64
+
+(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;
+       }
+   }
+
+Docker image
+------------
+
+We provide official images which can be found under ``arcan1s/ahriman`` repository. 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
+
+``--privileged`` flag is required to make mount possible inside container. 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 docker FAQ.
+
+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`` (the default) 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_REPOSITORY`` - repository name, default is ``aur-clone``.
+* ``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 ``/tmp``.
+* ``AHRIMAN_USER`` - ahriman user, usually must not be overwritten, default is ``ahriman``.
+* ``AHRIMAN_VALIDATE_CONFIGURATION`` - if set 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.
+
+Web service setup
+^^^^^^^^^^^^^^^^^
+
+Well 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
+
+
+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.
+
+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:
+
+   .. code-block:: shell
+
+      wget http://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20220927-1.0-any.pkg.tar.zst
+      pacman -U archlinux32-keyring-20220927-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:
+
+   .. code-block:: shell
+
+      wget http://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.0-any.pkg.tar.zst
+      pacman -U devtools-20221208-1.0-any.pkg.tar.zst
+
+   Alternatively, you can create your own ``makepkg`` configuration and save it as ``/usr/share/devtools/makepkg-i686.conf``.
+
+#.
+   Setup repository as usual:
+
+   .. code-block:: shell
+
+      ahriman -a i686 service-setup --mirror 'http://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.
+
+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 http://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.0-any.pkg.tar.zst && pacman --noconfirm -U devtools-20221208-1.0-any.pkg.tar.zst
+      RUN wget http://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20220927-1.0-any.pkg.tar.zst && pacman --noconfirm -U archlinux32-keyring-20220927-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 http://pool.mirror.archlinux32.org/i686/extra/devtools-20221208-1.0-any.pkg.tar.zst && pacman --noconfirm -U devtools-20221208-1.0-any.pkg.tar.zst
+      RUN wget http://pool.mirror.archlinux32.org/i686/core/archlinux32-keyring-20220927-1.0-any.pkg.tar.zst && pacman --noconfirm -U archlinux32-keyring-20220927-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='http://de.mirror.archlinux32.org/$arch/$repo' -e AHRIMAN_MULTILIB= ahriman-i686:latest
+
+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 /x86_64 {
+               root /var/lib/ahriman/repository/x86_64;
+               autoindex on;
+           }
+       }
+
+#. 
+   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 (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 to sync to S3
+^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies:
+
+   .. code-block:: shell
+
+      pacman -S python-boto3
+
+#. 
+   Create a bucket.
+
+#. 
+   Create 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 = ...
+
+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
+
+Reporting
+---------
+
+How to report by email
+^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S python-jinja
+
+#. 
+   Configure the service:
+
+   .. code-block:: 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
+
+How to generate index page for S3
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S python-jinja
+
+#. 
+   Configure the service:
+
+   .. code-block:: 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
+
+How to post build report to telegram
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   It still requires additional dependencies:
+
+   .. code-block:: shell
+
+      yay -S python-jinja
+
+#. 
+   Register bot in telegram. You can do it by talking 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/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${CHAT_ID}/sendMessage?chat_id=${API_KEY}&text=hello'
+
+(replace ``${CHAT_ID}`` and ``${API_KEY}`` with the values from configuration).
+
+Web service
+-----------
+
+How to setup web service
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S python-aiohttp python-aiohttp-jinja2
+
+#. 
+   Configure service:
+
+   .. code-block:: ini
+
+      [web]
+      port = 8080
+
+#. 
+   Start the web service ``systemctl enable --now ahriman-web@x86_64``.
+
+How to enable basic authorization
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Install dependencies 😊:
+
+   .. code-block:: shell
+
+      yay -S python-aiohttp-security python-aiohttp-session python-cryptography
+
+#. 
+   Configure the service to enable authorization:
+
+   .. code-block:: ini
+
+      [auth]
+      target = configuration
+
+#.
+   In order to provide access for reporting from application instances you can (recommended way) use unix sockets by configuring the following (note, that it requires ``python-requests-unixsocket`` package to be installed):
+
+   .. code-block:: ini
+
+      [web]
+      unix_socket = /var/lib/ahriman/ahriman-web.sock
+
+   This socket path must be available for web service instance and must be available for application instances (e.g. in case if you are using docker container, see above, you need to be 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 ``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
+
+      [web]
+      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@x86_64``.
+
+How to enable OAuth authorization
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 
+   Create OAuth web application, download its ``client_id`` and ``client_secret``.
+#. 
+   Guess what? Install dependencies:
+
+   .. code-block:: shell
+
+      yay -S 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 ``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.
+
+#. 
+   Create service user:
+
+   .. 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@x86_64``.
+
+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``.
+
+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
+
+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, 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 code 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``.
+
+`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.
+
+How 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.:
+
+.. code-block:: 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 <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 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/index.rst

@@ -0,0 +1,39 @@
+Welcome to ahriman's documentation!
+===================================
+
+Wrapper for managing custom repository inspired by `repo-scripts <https://github.com/arcan1s/repo-scripts>`_.
+
+Features
+--------
+
+* Install-configure-forget manager for the very own repository.
+* Multi-architecture support.
+* Dependency manager.
+* VCS packages support.
+* Official repository support.
+* Ability to patch AUR packages and even create package from local PKGBUILDs.
+* Sign support with gpg (repository, package, per package settings).
+* 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.
+
+Live demos
+----------
+
+* `Build status page <https://ahriman-demo.arcanis.me>`_. You can login as ``demo`` user by using ``demo`` password. Note, however, you will not be able to run tasks.
+* `Repository index <http://repo.arcanis.me/x86_64/index.html>`_.
+* `Telegram feed <https://t.me/arcanisrepo>`_.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   setup
+   configuration
+   command-line
+   faq
+   architecture
+   advanced-usage
+   triggers
+   modules

docs/modules.rst

@@ -0,0 +1,7 @@
+Modules
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman

docs/setup.rst

@@ -0,0 +1,93 @@
+Initial setup
+=============
+
+#. 
+   Install package as usual.
+#. 
+   Change settings if required, see :doc:`configuration reference <configuration>` for more details.
+#.
+   Perform initial setup:
+
+   .. code-block:: shell
+
+      sudo ahriman -a x86_64 service-setup ...
+
+   ``service-setup`` literally does the following steps:
+
+   #.
+      Create ``/var/lib/ahriman/.makepkg.conf`` with ``makepkg.conf`` overrides if required (at least you might want to set ``PACKAGER``):
+
+      .. code-block:: shell
+
+          echo 'PACKAGER="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
+
+   #.
+      Configure build tools (it is required for correct dependency management system):
+
+      #. 
+         Create build command (you can choose any name for command, basically it should be ``{name}-{arch}-build``):
+
+         .. code-block:: shell
+
+            ln -s /usr/bin/archbuild /usr/local/bin/ahriman-x86_64-build
+
+      #. 
+         Create configuration file (same as previous ``pacman-{name}.conf``):
+
+         .. code-block:: shell
+
+            cp /usr/share/devtools/pacman-{extra,ahriman}.conf
+
+      #. 
+         Change configuration file, add your own repository, add multilib repository etc:
+
+         .. code-block:: shell
+
+            echo '[multilib]' | tee -a /usr/share/devtools/pacman-ahriman.conf
+            echo 'Include = /etc/pacman.d/mirrorlist' | tee -a /usr/share/devtools/pacman-ahriman.conf
+
+            echo '[aur-clone]' | tee -a /usr/share/devtools/pacman-ahriman.conf
+            echo 'SigLevel = Optional TrustAll' | tee -a /usr/share/devtools/pacman-ahriman.conf
+            echo 'Server = file:///var/lib/ahriman/repository/$arch' | tee -a /usr/share/devtools/pacman-ahriman.conf
+
+      #. 
+         Set ``build_command`` option to point to your command:
+
+         .. code-block:: shell
+
+            echo '[build]' | tee -a /etc/ahriman.ini.d/build.ini
+            echo 'build_command = ahriman-x86_64-build' | tee -a /etc/ahriman.ini.d/build.ini
+
+      #.
+         Configure ``/etc/sudoers.d/ahriman`` to allow running command without a password:
+
+         .. code-block:: shell
+
+            echo 'Cmnd_Alias CARCHBUILD_CMD = /usr/local/bin/ahriman-x86_64-build *' | tee -a /etc/sudoers.d/ahriman
+            echo 'ahriman ALL=(ALL) NOPASSWD: CARCHBUILD_CMD' | tee -a /etc/sudoers.d/ahriman
+            chmod 400 /etc/sudoers.d/ahriman
+
+      This command supports several arguments, kindly refer to its help message.
+
+#. 
+   Start and enable ``ahriman@.timer`` via ``systemctl``:
+
+   .. code-block:: shell
+
+       systemctl enable --now ahriman@x86_64.timer
+
+#. 
+   Start and enable status page:
+
+   .. code-block:: shell
+
+       systemctl enable --now ahriman-web@x86_64
+
+#. 
+   Add packages by using ``ahriman package-add {package}`` command:
+
+   .. code-block:: shell
+
+       sudo -u ahriman ahriman -a x86_64 package-add ahriman --now --refresh
+
+   The ``--refresh`` flag is required in order to handle local database update.

docs/triggers.rst

@@ -0,0 +1,132 @@
+Triggers
+========
+
+The package provides ability to write custom extensions which will be run on (the most) actions, e.g. after updates. By default ahriman provides three types of extensions - reporting, files uploading and PKGBUILD syncronization. Each extension must derive from the ``ahriman.core.triggers.Trigger`` class and should implement at least one of the abstract methods:
+
+* ``on_result`` - trigger action which will be called after build process, the build result and the list of repository packages will be supplied as arguments.
+* ``on_start`` - trigger action which will be called right before the start of the application process.
+* ``on_stop`` - action which will be called right before the exit.
+
+Note, it isn't required to implement all of those methods (or even one of them), however, it is highly recommended to avoid trigger actions in ``__init__`` method as it will be run on any application start (e.g. even if you are just searching in AUR).
+
+Built-in triggers
+-----------------
+
+For the configuration details and settings explanation kindly refer to the :doc:`documentation <configuration>`.
+
+``ahriman.core.gitremote.RemotePullTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger will be called before any action (``on_start``) and pulls remote PKGBUILD repository locally; after that it copies found PKGBUILDs from the cloned repository to the local cache. It is useful in case if you have patched PGKBUILDs (or even missing in AUR) which you would like to use for package building and, technically, just simplifies the local package building.
+
+In order to update those packages you would need to clone your repository separately, make changes in PKGBUILD (e.g. bump version and update checksums), commit them and push back. On the next ahriman's repository update, it will pull changes you committed and will perform package update.
+
+``ahriman.core.gitremote.RemotePushTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger will be called right after build process (``on_result``). It will pick PKGBUILDs for the updated packages, pull them (together with any other files) and commit and push changes to remote repository. No real use cases, but the most of user repositories do it.
+
+``ahriman.core.report.ReportTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Trigger which can be used for reporting. It implements ``on_result`` method and thus being called on each build update and generates report (e.g. html, telegram etc) according to the current settings.
+
+``ahriman.core.upload.UploadTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger takes build result (``on_result``) and performs syncing of the local packages to the remote mirror (e.g. S3 or just by rsync).
+
+Context variables
+-----------------
+
+By default, only configuration and architecture are passed to triggers. However, some triggers might want to have access to other high-level wrappers. In order to provide such ability and avoid (double) initialization, the service provides a global context variables, which can be accessed from ``ahriman.core`` package:
+
+.. code-block:: python
+
+   from ahriman.core import context
+
+   ctx = context.get()
+
+Just because context is wrapped inside ``contexvars.ContextVar``, you need to explicitly extract variable by ``get()`` method. Later you can extract any variable if it is set, e.g.:
+
+.. code-block:: python
+
+   from ahriman.core.database import SQLite
+   from ahriman.models.context_key import ContextKey
+
+   database = ctx.get(ContextKey("database", SQLite))
+
+In order to provide typed API, all variables are stored together with their type. The ``get(ContextKey)`` method will throw ``KeyError`` in case if key is missing. Alternatively you can set your own variable inside context:
+
+.. code-block:: python
+
+   ctx.set(ContextKey("answer", int), 42)
+   context.set(ctx)
+
+Note, however, that there are several limitations:
+
+* Context variables are immutable, thus you cannot override value if the key already presented.
+* The ``return_type`` of ``ContextKey`` should match the value type, otherwise exception will be thrown.
+
+The ``context`` also implements collection methods such as ``__iter__`` and ``__len__``.
+
+Trigger example
+---------------
+
+Lets consider example of reporting trigger (e.g. `slack <https://slack.com/>`_, which provides easy HTTP API for integration triggers).gre
+
+In order to post message to slack we will need a specific trigger url (something like ``https://hooks.slack.com/services/company_id/trigger_id``), channel (e.g. ``#archrepo``) and username (``repo-bot``).
+
+As it has been mentioned, our trigger must derive from specific class:
+
+.. code-block:: python
+
+   from ahriman.core.triggers import Trigger
+
+   class SlackReporter(Trigger):
+
+       def __init__(self, architecture, configuration):
+           Trigger.__init__(self, architecture, configuration)
+           self.slack_url = configuration.get("slack", "url")
+           self.channel = configuration.get("slack", "channel")
+           self.username = configuration.get("slack", "username")
+
+By now we have class with all required variables. Lets implement run method. Slack API requires positing data with specific payload by HTTP, thus:
+
+.. code-block:: python
+
+   import json
+   import requests
+
+   def notify(result, slack_url, channel, username):
+       text = f"""Build has been completed with packages: {", ".join([package.name for package in result.success])}"""
+       payload = {"channel": channel, "username": username, "text": text}
+       response = requests.post(slack_url, data={"payload": json.dumps(payload)})
+       response.raise_for_status()
+
+Obviously you can implement the specified method in class, but for guide purpose it has been done as separated method. Now we can merge this method into the class:
+
+.. code-block:: python
+
+   class SlackReporter(Trigger):
+
+       def __init__(self, architecture, configuration):
+           Trigger.__init__(self, architecture, configuration)
+           self.slack_url = configuration.get("slack", "url")
+           self.channel = configuration.get("slack", "channel")
+           self.username = configuration.get("slack", "username")
+
+       def on_result(self, result, packages):
+           notify(result, self.slack_url, self.channel, self.username)
+
+Setup the trigger
+^^^^^^^^^^^^^^^^^
+
+First, put the trigger in any path it can be exported, e.g. by packing the resource into python package (which will lead to import path as ``package.slack_reporter.SlackReporter``) or just put file somewhere it can be accessed by application (e.g. ``/usr/local/lib/slack_reporter.py.SlackReporter``).
+
+After that run application as usual and receive notification in your slack channel.
+
+Trigger configuration schema
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Triggers can expose their configuration schema. It can be achieved by implementing ``CONFIGURATION_SCHEMA`` class variable according to `cerberus <https://docs.python-cerberus.org/>`_ documentation. For more details and examples, please refer to built-in triggers implementations.

package/archlinux/PKGBUILD

@@ -1,45 +1,57 @@
 # Maintainer: Evgeniy Alekseev
 
 pkgname='ahriman'
-pkgver=0.15.0
+pkgver=2.8.0
 pkgrel=1
-pkgdesc="ArcHlinux ReposItory MANager"
+pkgdesc="ArcH linux ReposItory MANager"
 arch=('any')
 url="https://github.com/arcan1s/ahriman"
 license=('GPL3')
-depends=('devtools' 'git' 'pyalpm' 'python-aur' 'python-srcinfo')
-makedepends=('python-pip')
-optdepends=('aws-cli: sync to s3'
-            'breezy: -bzr packages support'
+depends=('devtools' 'git' 'pyalpm' 'python-cerberus' 'python-inflection' 'python-passlib' 'python-requests' 'python-setuptools' 'python-srcinfo')
+makedepends=('python-build' 'python-installer' 'python-wheel')
+optdepends=('breezy: -bzr packages support'
             'darcs: -darcs packages support'
-            'gnupg: package and repository sign'
             'mercurial: -hg packages support'
+            'python-aioauth-client: web server with OAuth2 authorization'
             'python-aiohttp: web server'
+            'python-aiohttp-apispec>=3.0.0: web server'
+            'python-aiohttp-cors: web server'
+            'python-aiohttp-debugtoolbar: web server with enabled debug panel'
             'python-aiohttp-jinja2: web server'
+            'python-aiohttp-security: web server with authorization'
+            'python-aiohttp-session: web server with authorization'
+            'python-boto3: sync to s3'
+            'python-cryptography: web server with authorization'
+            'python-requests-unixsocket: client report to web server by unix socket'
             'python-jinja: html report generation'
-            'python-requests: web server'
             'rsync: sync by using rsync'
             'subversion: -svn packages support')
 source=("https://github.com/arcan1s/ahriman/releases/download/$pkgver/$pkgname-$pkgver-src.tar.xz"
         'ahriman.sysusers'
         'ahriman.tmpfiles')
-sha512sums=('a1db44390ce1785da3d535e3cfd2242d8d56070228eb9b3c1d5629163b65941d60753c481c0fdc69e475e534a828ceea39568dc6711abeee092616dac08e31a9'
-            '13718afec2c6786a18f0b223ef8e58dccf0688bca4cdbe203f14071f5031ed20120eb0ce38b52c76cfd6e8b6581a9c9eaa2743eb11abbaca637451a84c33f075'
-            '55b20f6da3d66e7bbf2add5d95a3b60632df121717d25a993e56e737d14f51fe063eb6f1b38bd81cc32e05db01c0c1d80aaa720c45cde87f238d8b46cdb8cbc4')
 backup=('etc/ahriman.ini'
         'etc/ahriman.ini.d/logging.ini')
 
 build() {
   cd "$pkgname"
 
-  python setup.py build
+  python -m build --wheel --no-isolation
 }
 
 package() {
   cd "$pkgname"
 
-  python setup.py install --root="$pkgdir"
+  python -m installer --destdir="$pkgdir" "dist/$pkgname-$pkgver-py3-none-any.whl"
+
+  # python-installer actually thinks that you cannot just copy files to root
+  # thus we need to copy them manually
+  install -Dm644 "$pkgdir/usr/share/$pkgname/settings/ahriman.ini" "$pkgdir/etc/ahriman.ini"
+  install -Dm644 "$pkgdir/usr/share/$pkgname/settings/ahriman.ini.d/logging.ini" "$pkgdir/etc/ahriman.ini.d/logging.ini"
 
   install -Dm644 "$srcdir/$pkgname.sysusers" "$pkgdir/usr/lib/sysusers.d/$pkgname.conf"
   install -Dm644 "$srcdir/$pkgname.tmpfiles" "$pkgdir/usr/lib/tmpfiles.d/$pkgname.conf"
 }
+
+sha512sums=('112b0d8aac68e5330bbdd2b86a59c8a9af8ab7a7c636489623c8460bb90f1318585851edd2a97a8ce20e2d2ad93b847b522685df707c190aa39d23ab908fa8ef'
+            '53d37efec812afebf86281716259f9ea78a307b83897166c72777251c3eebcb587ecee375d907514781fb2a5c808cbb24ef9f3f244f12740155d0603bf213131'
+            '62b2eccc352d33853ef243c9cddd63663014aa97b87242f1b5bc5099a7dbd69ff3821f24ffc58e1b7f2387bd4e9e9712cc4c67f661b1724ad99cdf09b3717794')

package/archlinux/ahriman.sysusers

@@ -1 +1 @@
-u ahriman 643 "ArcHlinux ReposItory MANager" /var/lib/ahriman
+u ahriman 643 "ArcH linux ReposItory MANager" /var/lib/ahriman

package/archlinux/ahriman.tmpfiles

@@ -1,2 +1,2 @@
-d /var/lib/ahriman 0775 ahriman log
+d /var/lib/ahriman 0755 ahriman ahriman
 d /var/log/ahriman 0755 ahriman ahriman

package/etc/ahriman.ini

@@ -1,47 +0,0 @@
-[settings]
-include = /etc/ahriman.ini.d
-logging = /etc/ahriman.ini.d/logging.ini
-
-[alpm]
-aur_url = https://aur.archlinux.org
-database = /var/lib/pacman
-repositories = core extra community multilib
-root = /
-
-[build]
-archbuild_flags =
-build_command = extra-x86_64-build
-ignore_packages =
-makechrootpkg_flags =
-makepkg_flags = --skippgpcheck
-
-[repository]
-name = aur-clone
-root = /var/lib/ahriman
-
-[sign]
-target =
-key =
-
-[report]
-target =
-
-[html]
-path =
-homepage =
-link_path =
-template_path = /usr/share/ahriman/repo-index.jinja2
-
-[upload]
-target =
-
-[rsync]
-remote =
-
-[s3]
-bucket =
-
-[web]
-host =
-port =
-templates = /usr/share/ahriman

package/etc/ahriman.ini.d/logging.ini

@@ -1,59 +0,0 @@
-[loggers]
-keys = root,builder,build_details,http
-
-[handlers]
-keys = console_handler,build_file_handler,file_handler,http_handler
-
-[formatters]
-keys = generic_format
-
-[handler_console_handler]
-class = StreamHandler
-level = DEBUG
-formatter = generic_format
-args = (sys.stderr,)
-
-[handler_file_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/ahriman.log', 'a', 20971520, 20)
-
-[handler_build_file_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/build.log', 'a', 20971520, 20)
-
-[handler_http_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/http.log', 'a', 20971520, 20)
-
-[formatter_generic_format]
-format = [%(levelname)s %(asctime)s] [%(filename)s:%(lineno)d] [%(funcName)s]: %(message)s
-datefmt =
-
-[logger_root]
-level = DEBUG
-handlers = file_handler
-qualname = root
-
-[logger_builder]
-level = DEBUG
-handlers = file_handler
-qualname = builder
-propagate = 0
-
-[logger_build_details]
-level = DEBUG
-handlers = build_file_handler
-qualname = build_details
-propagate = 0
-
-[logger_http]
-level = DEBUG
-handlers = http_handler
-qualname = http
-propagate = 0

package/lib/systemd/system/ahriman-web@.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=ArcHlinux ReposItory MANager web server (%I architecture)
+Description=ArcH linux ReposItory MANager web server (%I architecture)
 After=network.target
 
 [Service]
@@ -8,8 +8,5 @@ ExecStart=/usr/bin/ahriman --architecture %i web
 User=ahriman
 Group=ahriman
 
-KillSignal=SIGQUIT
-SuccessExitStatus=SIGQUIT
-
 [Install]
 WantedBy=multi-user.target

package/lib/systemd/system/ahriman@.service

@@ -1,7 +1,7 @@
 [Unit]
-Description=ArcHlinux ReposItory MANager (%I architecture)
+Description=ArcH linux ReposItory MANager (%I architecture)
 
 [Service]
-ExecStart=/usr/bin/ahriman --architecture %i update
+ExecStart=/usr/bin/ahriman --architecture %i repo-update --refresh
 User=ahriman
 Group=ahriman

package/lib/systemd/system/ahriman@.timer

@@ -1,5 +1,5 @@
 [Unit]
-Description=ArcHlinux ReposItory MANager timer (%I architecture)
+Description=ArcH linux ReposItory MANager timer (%I architecture)
 
 [Timer]
 OnCalendar=daily

package/share/ahriman/build-status.jinja2

@@ -1,54 +0,0 @@
-<!doctype html>
-<html lang="en">
-    <head>
-        <title>{{ repository|e }}</title>
-
-        {% include "style.jinja2" %}
-
-        {% include "sorttable.jinja2" %}
-        {% include "search.jinja2" %}
-    </head>
-
-    <body>
-        <div class="root">
-            <h1>ahriman
-                <img src="https://img.shields.io/badge/version-{{ version|e }}-informational" alt="{{ version|e }}">
-                <img src="https://img.shields.io/badge/architecture-{{ architecture|e }}-informational" alt="{{ architecture|e }}">
-                <img src="https://img.shields.io/badge/service%20status-{{ service.status|e }}-{{ service.status_color|e }}" alt="{{ service.status|e }}" title="{{ service.timestamp|e }}">
-            </h1>
-
-            {% include "search-line.jinja2" %}
-
-            <section class="element">
-                <table class="sortable search-table">
-                    <tr class="header">
-                        <th>package base</th>
-                        <th>packages</th>
-                        <th>version</th>
-                        <th>last update</th>
-                        <th>status</th>
-                    </tr>
-
-                    {% for package in packages %}
-                        <tr class="package">
-                            <td class="include-search"><a href="{{ package.web_url|e }}" title="{{ package.base|e }}">{{ package.base|e }}</a></td>
-                            <td class="include-search">{{ package.packages|join("<br>"|safe) }}</td>
-                            <td>{{ package.version|e }}</td>
-                            <td>{{ package.timestamp|e }}</td>
-                            <td class="status package-{{ package.status|e }}">{{ package.status|e }}</td>
-                        </tr>
-                    {% endfor %}
-                </table>
-            </section>
-
-            <footer>
-                <ul class="navigation">
-                    <li><a href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
-                    <li><a href="https://github.com/arcan1s/ahriman/releases" title="releases list">releases</a></li>
-                    <li><a href="https://github.com/arcan1s/ahriman/issues" title="issues tracker">report a bug</a></li>
-                </ul>
-            </footer>
-        </div>
-    </body>
-
-</html>

package/share/ahriman/repo-index.jinja2

@@ -1,62 +0,0 @@
-<!doctype html>
-<html lang="en">
-    <head>
-        <title>{{ repository|e }}</title>
-
-        {% include "style.jinja2" %}
-
-        {% include "sorttable.jinja2" %}
-        {% include "search.jinja2" %}
-    </head>
-
-    <body>
-        <div class="root">
-            <h1>Archlinux user repository</h1>
-
-            <section class="element">
-                {% if pgp_key is not none %}
-                    <p>This repository is signed with <a href="http://keys.gnupg.net/pks/lookup?search=0x{{ pgp_key|e }}&fingerprint=on&op=index" title="key search">{{ pgp_key|e }}</a> by default.</p>
-                {% endif %}
-
-                <code>
-                    $ cat /etc/pacman.conf<br>
-                    [{{ repository|e }}]<br>
-                    Server = {{ link_path|e }}<br>
-                    SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Package{% if has_package_signed %}Required{% else %}Never{% endif %} TrustedOnly
-                </code>
-            </section>
-
-            {% include "search-line.jinja2" %}
-
-            <section class="element">
-                <table class="sortable search-table">
-                    <tr class="header">
-                        <th>package</th>
-                        <th>version</th>
-                        <th>archive size</th>
-                        <th>installed size</th>
-                        <th>build date</th>
-                    </tr>
-
-                    {% for package in packages %}
-                        <tr class="package">
-                            <td class="include-search"><a href="{{ link_path|e }}/{{ package.filename|e }}" title="{{ package.name|e }}">{{ package.name|e }}</a></td>
-                            <td>{{ package.version|e }}</td>
-                            <td>{{ package.archive_size|e }}</td>
-                            <td>{{ package.installed_size|e }}</td>
-                            <td>{{ package.build_date|e }}</td>
-                        </tr>
-                    {% endfor %}
-                </table>
-            </section>
-
-            <footer>
-                <ul class="navigation">
-                    {% if homepage is not none %}
-                        <li><a href="{{ homepage|e }}" title="homepage">Homepage</a></li>
-                    {% endif %}
-                </ul>
-            </footer>
-        </div>
-    </body>
-</html>

package/share/ahriman/search-line.jinja2

@@ -1,3 +0,0 @@
-<section class="element">
-    <input type="search" id="search" onkeyup="searchInTable()" placeholder="search for package" title="search for package"/>
-</section>

package/share/ahriman/search.jinja2

@@ -1,25 +0,0 @@
-<script type="text/javascript">
-    function searchInTable() {
-        const input = document.getElementById("search");
-        const filter = input.value.toLowerCase();
-        const tables = document.getElementsByClassName("search-table");
-
-        for (let i = 0; i < tables.length; i++) {
-            const tr = tables[i].getElementsByTagName("tr");
-            // from 1 coz of header
-            for (let i = 1; i < tr.length; i++) {
-                let td = tr[i].getElementsByClassName("include-search");
-                let display = "none";
-                for (let j = 0; j < td.length; j++) {
-                    if (td[j].tagName.toLowerCase() === "td") {
-                        if (td[j].innerHTML.toLowerCase().indexOf(filter) > -1) {
-                            display = "";
-                            break;
-                        }
-                    }
-                }
-                tr[i].style.display = display;
-            }
-        }
-    }
-</script>

package/share/ahriman/settings/ahriman.ini

@@ -0,0 +1,76 @@
+[settings]
+include = ahriman.ini.d
+logging = ahriman.ini.d/logging.ini
+database = /var/lib/ahriman/ahriman.db
+suppress_http_log_errors = yes
+
+[alpm]
+database = /var/lib/pacman
+mirror = https://geo.mirror.pkgbuild.com/$repo/os/$arch
+repositories = core extra community multilib
+root = /
+use_ahriman_cache = yes
+
+[auth]
+target = disabled
+max_age = 604800
+oauth_provider = GoogleClient
+oauth_scopes = https://www.googleapis.com/auth/userinfo.email
+allow_read_only = yes
+
+[build]
+archbuild_flags =
+build_command = extra-x86_64-build
+ignore_packages =
+makechrootpkg_flags =
+makepkg_flags = --nocolor --ignorearch
+triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger ahriman.core.gitremote.RemotePushTrigger
+vcs_allowed_age = 604800
+
+[repository]
+name = aur-clone
+root = /var/lib/ahriman
+
+[sign]
+target =
+
+[remote-pull]
+target =
+
+[remote-push]
+target =
+
+[report]
+target = console
+
+[console]
+use_utf = yes
+
+[email]
+no_empty_report = yes
+template_path = /usr/share/ahriman/templates/email-index.jinja2
+ssl = disabled
+
+[html]
+template_path = /usr/share/ahriman/templates/repo-index.jinja2
+
+[telegram]
+template_path = /usr/share/ahriman/templates/telegram-index.jinja2
+
+[upload]
+target =
+
+[rsync]
+command = rsync --archive --compress --partial --delete
+
+[s3]
+chunk_size = 8388608
+
+[web]
+debug = no
+debug_check_host = no
+debug_allowed_hosts =
+host = 127.0.0.1
+static_path = /usr/share/ahriman/templates/static
+templates = /usr/share/ahriman/templates
+unix_socket_unsafe = yes

package/share/ahriman/settings/ahriman.ini.d/logging.ini

@@ -0,0 +1,68 @@
+[loggers]
+keys = root,http,stderr,boto3,botocore,nose,s3transfer
+
+[handlers]
+keys = console_handler,syslog_handler
+
+[formatters]
+keys = generic_format,syslog_format
+
+[handler_console_handler]
+class = StreamHandler
+level = DEBUG
+formatter = generic_format
+args = (sys.stderr,)
+
+[handler_syslog_handler]
+class = logging.handlers.SysLogHandler
+level = DEBUG
+formatter = syslog_format
+args = ("/dev/log",)
+
+[formatter_generic_format]
+format = [%(levelname)s %(asctime)s] [%(name)s]: %(message)s
+datefmt =
+
+[formatter_syslog_format]
+format = [%(levelname)s] [%(name)s]: %(message)s
+datefmt =
+
+[logger_root]
+level = DEBUG
+handlers = syslog_handler
+qualname = root
+
+[logger_http]
+level = DEBUG
+handlers = syslog_handler
+qualname = http
+propagate = 0
+
+[logger_stderr]
+level = DEBUG
+handlers = console_handler
+qualname = stderr
+
+[logger_boto3]
+level = INFO
+handlers = syslog_handler
+qualname = boto3
+propagate = 0
+
+[logger_botocore]
+level = INFO
+handlers = syslog_handler
+qualname = botocore
+propagate = 0
+
+[logger_nose]
+level = INFO
+handlers = syslog_handler
+qualname = nose
+propagate = 0
+
+[logger_s3transfer]
+level = INFO
+handlers = syslog_handler
+qualname = s3transfer
+propagate = 0

package/share/ahriman/sorttable.jinja2

@@ -1 +0,0 @@
-<script src="https://www.kryogenix.org/code/browser/sorttable/sorttable.js"></script>

package/share/ahriman/style.jinja2

@@ -1,136 +0,0 @@
-<style>
-    :root {
-        --color-building: 255, 255, 146;
-        --color-failed: 255, 94, 94;
-        --color-pending: 255, 255, 146;
-        --color-success: 94, 255, 94;
-        --color-unknown: 225, 225, 225;
-
-        --color-header: 200, 200, 255;
-        --color-hover: 255, 255, 225;
-        --color-line-blue: 235, 235, 255;
-        --color-line-white: 255, 255, 255;
-    }
-
-    @keyframes blink-building {
-        0% { background-color: rgba(var(--color-building), 1.0); }
-        10% { background-color: rgba(var(--color-building), 0.9); }
-        20% { background-color: rgba(var(--color-building), 0.8); }
-        30% { background-color: rgba(var(--color-building), 0.7); }
-        40% { background-color: rgba(var(--color-building), 0.6); }
-        50% { background-color: rgba(var(--color-building), 0.5); }
-        60% { background-color: rgba(var(--color-building), 0.4); }
-        70% { background-color: rgba(var(--color-building), 0.3); }
-        80% { background-color: rgba(var(--color-building), 0.2); }
-        90% { background-color: rgba(var(--color-building), 0.1); }
-        100% { background-color: rgba(var(--color-building), 0.0); }
-    }
-
-    div.root {
-        width: 70%;
-        padding: 15px 15% 0;
-    }
-
-    section.element, footer {
-        width: 100%;
-        padding: 10px 0;
-    }
-
-    code, input, table {
-        width: inherit;
-    }
-
-    th, td {
-        padding: 5px;
-    }
-
-    tr.package:nth-child(odd) {
-        background-color: rgba(var(--color-line-white), 1.0);
-    }
-
-    tr.package:nth-child(even) {
-        background-color: rgba(var(--color-line-blue), 1.0);
-    }
-
-    tr.package:hover {
-        background-color: rgba(var(--color-hover), 1.0);
-    }
-
-    tr.header{
-        background-color: rgba(var(--color-header), 1.0);
-    }
-
-    td.status {
-        text-align: center;
-    }
-
-    td.package-unknown {
-        background-color: rgba(var(--color-unknown), 1.0);
-    }
-    td.package-pending {
-        background-color: rgba(var(--color-pending), 1.0);
-    }
-    td.package-building {
-        background-color: rgba(var(--color-building), 1.0);
-        animation-name: blink-building;
-        animation-duration: 1s;
-        animation-timing-function: linear;
-        animation-iteration-count: infinite;
-        animation-direction: alternate;
-    }
-    td.package-failed {
-        background-color: rgba(var(--color-failed), 1.0);
-    }
-    td.package-success {
-        background-color: rgba(var(--color-success), 1.0);
-    }
-
-    li.service-unknown {
-        background-color: rgba(var(--color-unknown), 1.0);
-    }
-    li.service-building {
-        background-color: rgba(var(--color-building), 1.0);
-        animation-name: blink-building;
-        animation-duration: 1s;
-        animation-timing-function: linear;
-        animation-iteration-count: infinite;
-        animation-direction: alternate;
-    }
-    li.service-failed {
-        background-color: rgba(var(--color-failed), 1.0);
-    }
-    li.service-success {
-        background-color: rgba(var(--color-success), 1.0);
-    }
-
-    ul.navigation {
-        list-style-type: none;
-        margin: 0;
-        padding: 0;
-        overflow: hidden;
-        background-color: rgba(var(--color-header), 1.0);
-    }
-
-    ul.navigation li {
-        float: left;
-    }
-
-    ul.navigation li.status {
-        display: block;
-        text-align: center;
-        text-decoration: none;
-        padding: 14px 16px;
-    }
-
-    ul.navigation li a {
-        display: block;
-        color: black;
-        text-align: center;
-        text-decoration: none;
-        padding: 14px 16px;
-    }
-
-    ul.navigation li a:hover {
-        background-color: rgba(var(--color-hover), 1.0);
-    }
-</style>

package/share/ahriman/templates/api.jinja2

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>ahriman API</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <!-- Embed elements Elements via Web Component -->
+    <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css" type="text/css">
+
+    <link rel="shortcut icon" href="/static/favicon.ico">
+</head>
+<body>
+
+    <elements-api
+            apiDescriptionUrl="/api-docs/swagger.json"
+            router="hash"
+            layout="sidebar"
+    />
+
+</body>
+</html>

package/share/ahriman/templates/build-status.jinja2

@@ -0,0 +1,143 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>{{ repository }}</title>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        <link rel="shortcut icon" href="/static/favicon.ico">
+
+        {% include "utils/style.jinja2" %}
+    </head>
+
+    <body>
+
+        {% include "utils/bootstrap-scripts.jinja2" %}
+
+        <div class="container">
+            <h1 id="badge-repository">ahriman</h1>
+        </div>
+
+        <div id="alert-placeholder" class="toast-container p3 top-0 start-50 translate-middle-x"></div>
+
+        <div class="container">
+            <div id="toolbar" class="dropdown">
+                <a id="badge-status" tabindex="0" role="button" class="btn btn-outline-secondary" data-bs-toggle="popover" data-bs-trigger="focus" data-bs-content="no run data"><i class="bi bi-info-circle"></i></a>
+
+                {% if not auth.enabled or auth.username is not none %}
+                    <button type="button" class="btn btn-primary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
+                        <i class="bi bi-box"></i> packages
+                    </button>
+                    <ul class="dropdown-menu">
+                        <li>
+                            <button id="package-add-btn" class="btn dropdown-item" data-bs-toggle="modal" data-bs-target="#package-add-modal" hidden>
+                                <i class="bi bi-plus"></i> add
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-update-btn" class="btn dropdown-item" onclick="updatePackages()" hidden>
+                                <i class="bi bi-play"></i> update
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-rebuild-btn" class="btn dropdown-item" data-bs-toggle="modal" data-bs-target="#package-rebuild-modal" hidden>
+                                <i class="bi bi-arrow-clockwise"></i> rebuild
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-remove-btn" class="btn dropdown-item" onclick="removePackages()" disabled hidden>
+                                <i class="bi bi-trash"></i> remove
+                            </button>
+                        </li>
+                    </ul>
+
+                    <button id="key-import-btn" type="button" class="btn btn-info" data-bs-toggle="modal" data-bs-target="#key-import-modal" hidden>
+                        <i class="bi bi-key"></i> import key
+                    </button>
+                {% endif %}
+
+                <button type="button" class="btn btn-secondary" onclick="reload()">
+                    <i class="bi bi-arrow-clockwise"></i> reload
+                </button>
+            </div>
+
+            <table id="packages" class="table table-striped table-hover"
+                   data-export-options='{"fileName": "packages"}'
+                   data-page-list="[10, 25, 50, 100, all]"
+                   data-page-size="10"
+                   data-pagination="true"
+                   data-resizable="true"
+                   data-search="true"
+                   data-show-columns="true"
+                   data-show-columns-search="true"
+                   data-show-columns-toggle-all="true"
+                   data-show-export="true"
+                   data-show-fullscreen="true"
+                   data-show-search-clear-button="true"
+                   data-sortable="true"
+                   data-sort-name="base"
+                   data-sort-order="asc"
+                   data-toggle="table"
+                   data-toolbar="#toolbar">
+                <thead class="table-primary">
+                    <tr>
+                        <th data-checkbox="true"></th>
+                        <th data-sortable="true" data-switchable="false" data-field="base">package base</th>
+                        <th data-sortable="true" data-field="version">version</th>
+                        <th data-sortable="true" data-field="packages">packages</th>
+                        <th data-sortable="true" data-visible="false" data-field="groups">groups</th>
+                        <th data-sortable="true" data-visible="false" data-field="licenses">licenses</th>
+                        <th data-sortable="true" data-field="timestamp">last update</th>
+                        <th data-sortable="true" data-cell-style="statusFormat" data-field="status">status</th>
+                    </tr>
+                </thead>
+            </table>
+        </div>
+
+        <div class="container">
+            <footer class="d-flex flex-wrap justify-content-between align-items-center border-top">
+                <ul class="nav">
+                    <li><a id="badge-version" class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources"><i class="bi bi-github"></i> ahriman</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/releases" title="releases list">releases</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/issues" title="issues tracker">report a bug</a></li>
+                </ul>
+
+                {% if index_url is not none %}
+                    <ul class="nav">
+                        <li><a class="nav-link" href="{{ index_url }}" title="repo index"><i class="bi bi-house"></i> repo index</a></li>
+                    </ul>
+                {% endif %}
+
+                {% if auth.enabled %}
+                    <ul class="nav">
+                        {% if auth.username is none %}
+                            <li>{{ auth.control|safe }}</li>
+                        {% else %}
+                            <li>
+                                <form action="/api/v1/logout" method="post">
+                                    <button class="btn btn-link" style="text-decoration: none"><i class="bi bi-box-arrow-right"></i> logout ({{ auth.username }})</button>
+                                </form>
+                            </li>
+                        {% endif %}
+                    </ul>
+                {% endif %}
+            </footer>
+        </div>
+
+        {% if auth.enabled %}
+            {% include "build-status/login-modal.jinja2" %}
+        {% endif %}
+
+        {% include "build-status/alerts.jinja2" %}
+
+        {% include "build-status/package-add-modal.jinja2" %}
+        {% include "build-status/package-rebuild-modal.jinja2" %}
+        {% include "build-status/key-import-modal.jinja2" %}
+
+        {% include "build-status/package-info-modal.jinja2" %}
+
+        {% include "build-status/table.jinja2" %}
+
+    </body>
+
+</html>

package/share/ahriman/templates/build-status/alerts.jinja2

@@ -0,0 +1,45 @@
+<script>
+    const alertPlaceholder = $("#alert-placeholder");
+
+    function createAlert(title, message, clz) {
+        const wrapper = document.createElement("div");
+        wrapper.classList.add("toast", clz);
+        wrapper.role = "alert";
+        wrapper.ariaLive = "assertive";
+        wrapper.ariaAtomic = "true";
+        wrapper.style.width = "500px"; // 500px is default modal size
+
+        const header = document.createElement("div");
+        header.classList.add("toast-header");
+        header.innerHTML = `<strong class="me-auto">${safe(title)}</strong> <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="close"></button>`;
+        wrapper.appendChild(header);
+
+        const body = document.createElement("div");
+        body.classList.add("toast-body", "text-bg-light");
+        body.innerText = message;
+        wrapper.appendChild(body);
+
+        alertPlaceholder.append(wrapper);
+        const toast = new bootstrap.Toast(wrapper);
+        wrapper.addEventListener("hidden.bs.toast", () => {
+            wrapper.remove();  // bootstrap doesn't remove elements
+            reload();
+        });
+        toast.show();
+    }
+
+    function showFailure(title, description, jqXHR, errorThrown) {
+        let details;
+        try {
+            details = $.parseJSON(jqXHR.responseText).error; // execution handler json error response
+        } catch (_) {
+            details = errorThrown;
+        }
+        createAlert(title, description(details), "text-bg-danger");
+    }
+
+    function showSuccess(title, description) {
+        createAlert(title, description, "text-bg-success");
+    }
+
+</script>

package/share/ahriman/templates/build-status/key-import-modal.jinja2

@@ -0,0 +1,93 @@
+<div id="key-import-modal" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog modal-xl" role="document">
+        <div class="modal-content">
+            <form id="key-import-form" onsubmit="return false">
+                <div class="modal-header">
+                    <h4 class="modal-title">Import key from PGP server</h4>
+                    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+                </div>
+                <div class="modal-body">
+                    <div class="form-group row">
+                        <label for="key-fingerprint-input" class="col-sm-2 col-form-label">fingerprint</label>
+                        <div class="col-sm-10">
+                            <input id="key-fingerprint-input" type="text" class="form-control" placeholder="PGP key fingerprint" name="key" required>
+                        </div>
+                    </div>
+                    <div class="form-group row">
+                        <label for="key-server-input" class="col-sm-2 col-form-label">key server</label>
+                        <div class="col-sm-10">
+                            <input id="key-server-input" type="text" class="form-control" placeholder="PGP key server" name="server" value="keyserver.ubuntu.com" required>
+                        </div>
+                    </div>
+                    <div class="form-group row">
+                        <div class="col-sm-2"></div>
+                        <div class="col-sm-10">
+                            <pre class="language-less"><samp id="key-body-input" class="pre-scrollable language-less"></samp><button id="key-copy-btn" type="button" class="btn language-less" onclick="copyPgpKey()"><i class="bi bi-clipboard"></i> copy</button></pre>
+                        </div>
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button type="submit" class="btn btn-primary" onclick="importPgpKey()"><i class="bi bi-play"></i> import</button>
+                    <button type="submit" class="btn btn-success" onclick="fetchPgpKey()"><i class="bi bi-arrow-clockwise"></i> fetch</button>
+                </div>
+            </form>
+        </div>
+    </div>
+</div>
+
+<script>
+    const keyImportModal = $("#key-import-modal");
+    const keyImportForm = $("#key-import-form");
+    keyImportModal.on("hidden.bs.modal", () => {
+        keyBodyInput.text("");
+        keyImportForm.trigger("reset");
+    });
+
+    const keyBodyInput = $("#key-body-input");
+    const keyCopyButton = $("#key-copy-btn");
+
+    const keyFingerprintInput = $("#key-fingerprint-input");
+    const keyServerInput = $("#key-server-input");
+
+    async function copyPgpKey() {
+        const logs = keyBodyInput.text();
+        await copyToClipboard(logs, keyCopyButton);
+    }
+
+    function fetchPgpKey() {
+        const key = keyFingerprintInput.val();
+        const server = keyServerInput.val();
+
+        if (key && server) {
+            $.ajax({
+                url: "/api/v1/service/pgp",
+                data: {"key": key, "server": server},
+                type: "GET",
+                dataType: "json",
+                success: response => { keyBodyInput.text(response.key); },
+            });
+        }
+    }
+
+    function importPgpKey() {
+        const key = keyFingerprintInput.val();
+        const server = keyServerInput.val();
+
+        if (key && server) {
+            $.ajax({
+                url: "/api/v1/service/pgp",
+                data: JSON.stringify({key: key, server: server}),
+                type: "POST",
+                contentType: "application/json",
+                success: _ => {
+                    keyImportModal.modal("hide");
+                    showSuccess("Success", `Key ${key} has been imported`);
+                },
+                error: (jqXHR, _, errorThrown) => {
+                    const message = _ => { return `Could not import key ${key} from ${server}`; };
+                    showFailure("Action failed", message, jqXHR, errorThrown);
+                },
+            });
+        }
+    }
+</script>

package/share/ahriman/templates/build-status/login-modal.jinja2

@@ -0,0 +1,51 @@
+<div id="login-modal" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <form action="/api/v1/login" method="post">
+                <div class="modal-header">
+                    <h4 class="modal-title">Login</h4>
+                    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+                </div>
+                <div class="modal-body">
+                    <div class="form-group row">
+                        <label for="username" class="col-sm-2 col-form-label">username</label>
+                        <div class="col-sm-10">
+                            <input id="username" type="text" class="form-control" placeholder="enter username" name="username" required>
+                        </div>
+                    </div>
+                    <div class="form-group row">
+                        <label for="password" class="col-sm-2 col-form-label">password</label>
+                        <div class="col-sm-10">
+                            <div class="input-group">
+                                <input id="password" type="password" class="form-control" placeholder="enter password" name="password" required>
+                                <div class="input-group-append">
+                                    <button class="btn btn-outline-secondary" type="button" onclick="showPassword()"><i id="show-hide-password-btn" class="bi bi-eye"></i></button>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button class="btn btn-primary"><i class="bi bi-person"></i> login</button>
+                </div>
+            </form>
+        </div>
+    </div>
+</div>
+
+<script>
+    const passwordInput = $("#password");
+    const showHidePasswordButton = $("#show-hide-password-btn");
+
+    function showPassword() {
+        if (passwordInput.attr("type") === "password") {
+            passwordInput.attr("type", "text");
+            showHidePasswordButton.removeClass("bi-eye");
+            showHidePasswordButton.addClass("bi-eye-slash");
+        } else {
+            passwordInput.attr("type", "password");
+            showHidePasswordButton.removeClass("bi-eye-slash");
+            showHidePasswordButton.addClass("bi-eye");
+        }
+    }
+</script>

package/share/ahriman/templates/build-status/package-add-modal.jinja2

@@ -0,0 +1,78 @@
+<div id="package-add-modal" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <form id="package-add-form" onsubmit="return false">
+                <div class="modal-header">
+                    <h4 class="modal-title">Add new packages</h4>
+                    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+                </div>
+                <div class="modal-body">
+                    <div class="form-group row">
+                        <label for="package-input" class="col-sm-2 col-form-label">package</label>
+                        <div class="col-sm-10">
+                            <input id="package-input" type="text" list="known-packages-dlist" autocomplete="off" class="form-control" placeholder="AUR package" name="package" required>
+                            <datalist id="known-packages-dlist"></datalist>
+                        </div>
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button type="submit" class="btn btn-primary" onclick="packagesAdd()"><i class="bi bi-play"></i> add</button>
+                    <button type="submit" class="btn btn-success" onclick="packagesRequest()"><i class="bi bi-plus"></i> request</button>
+                </div>
+            </form>
+        </div>
+    </div>
+</div>
+
+<script>
+    const packageAddModal = $("#package-add-modal");
+    const packageAddForm = $("#package-add-form");
+    packageAddModal.on("hidden.bs.modal", () => { packageAddForm.trigger("reset"); });
+
+    const packageInput = $("#package-input");
+    const knownPackagesList = $("#known-packages-dlist");
+    packageInput.keyup(() => {
+        clearTimeout(packageInput.data("timeout"));
+        packageInput.data("timeout", setTimeout($.proxy(() => {
+            const value = packageInput.val();
+
+            if (value.length >= 3) {
+                $.ajax({
+                    url: "/api/v1/service/search",
+                    data: {"for": value},
+                    type: "GET",
+                    dataType: "json",
+                    success: response => {
+                        const options = response.map(pkg => {
+                            const option = document.createElement("option");
+                            option.value = pkg.package;
+                            option.innerText = `${pkg.package} (${pkg.description})`;
+                            return option;
+                        });
+                        knownPackagesList.empty().append(options);
+                    },
+                });
+            }
+        }, this), 500));
+    });
+
+    function packagesAdd() {
+        const packages = packageInput.val();
+        if (packages) {
+            packageAddModal.modal("hide");
+            const onSuccess = update => { return `Packages ${update} have been added`; };
+            const onFailure = error => { return `Package addition failed: ${error}`; };
+            doPackageAction("/api/v1/service/add", [packages], onSuccess, onFailure);
+        }
+    }
+
+    function packagesRequest() {
+        const packages = packageInput.val();
+        if (packages) {
+            packageAddModal.modal("hide");
+            const onSuccess = update => { return `Packages ${update} have been requested`; };
+            const onFailure = error => { return `Package request failed: ${error}`; };
+            doPackageAction("/api/v1/service/request", [packages], onSuccess, onFailure);
+        }
+    }
+</script>

package/share/ahriman/templates/build-status/package-info-modal.jinja2

@@ -0,0 +1,70 @@
+<div id="package-info-modal" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog modal-xl" role="document">
+        <div class="modal-content">
+            <div id="package-info-modal-header" class="modal-header">
+                <h4 id="package-info" class="modal-title"></h4>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+            </div>
+            <div class="modal-body">
+                <pre class="language-logs"><samp id="package-info-logs-input" class="pre-scrollable language-logs"></samp><button id="logs-copy-btn" type="button" class="btn language-logs" onclick="copyLogs()"><i class="bi bi-clipboard"></i> copy</button></pre>
+            </div>
+            <div class="modal-footer">
+                <button type="button" class="btn btn-secondary" onclick="showLogs()"><i class="bi bi-arrow-clockwise"></i> reload</button>
+                <button type="button" class="btn btn-primary" data-bs-dismiss="modal"><i class="bi bi-x"></i> close</button>
+            </div>
+        </div>
+    </div>
+</div>
+
+<script>
+    const packageInfoModal = $("#package-info-modal");
+    const packageInfoModalHeader = $("#package-info-modal-header");
+    const packageInfo = $("#package-info");
+
+    const packageInfoLogsInput = $("#package-info-logs-input");
+    const packageInfoLogsCopyButton = $("#logs-copy-btn");
+
+    async function copyLogs() {
+        const logs = packageInfoLogsInput.text();
+        await copyToClipboard(logs, packageInfoLogsCopyButton);
+    }
+
+    function showLogs(packageBase) {
+        const isPackageBaseSet = packageBase !== undefined;
+        if (isPackageBaseSet)
+            packageInfoModal.data("package", packageBase); // set package base as currently used
+        else
+            packageBase = packageInfoModal.data("package"); // read package base from the current window attribute
+
+        const headerClass = status => {
+            if (status === "pending") return ["bg-warning"];
+            if (status === "building") return ["bg-warning"];
+            if (status === "failed") return ["bg-danger", "text-white"];
+            if (status === "success") return ["bg-success", "text-white"];
+            return ["bg-secondary", "text-white"];
+        };
+
+        $.ajax({
+            url: `/api/v1/packages/${packageBase}/logs`,
+            type: "GET",
+            dataType: "json",
+            success: response => {
+                packageInfo.text(`${response.package_base} ${response.status.status} at ${new Date(1000 * response.status.timestamp).toISOString()}`);
+                packageInfoLogsInput.text(response.logs);
+
+                packageInfoModalHeader.removeClass();
+                packageInfoModalHeader.addClass("modal-header");
+                headerClass(response.status.status).forEach((clz) => packageInfoModalHeader.addClass(clz));
+
+                if (isPackageBaseSet) packageInfoModal.modal("show"); // we don't need to show window again
+            },
+            error: (jqXHR, _, errorThrown) => {
+                // show failed modal in case if first time loading
+                if (isPackageBaseSet) {
+                    const message = error => { return `Could not load package ${packageBase} logs: ${error}`; };
+                    showFailure("Load failure", message, jqXHR, errorThrown);
+                }
+            },
+        });
+    }
+</script>

package/share/ahriman/templates/build-status/package-rebuild-modal.jinja2

@@ -0,0 +1,41 @@
+<div id="package-rebuild-modal" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <form id="package-rebuild-form" onsubmit="return false">
+                <div class="modal-header">
+                    <h4 class="modal-title">Rebuild depending packages</h4>
+                    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+                </div>
+                <div class="modal-body">
+                    <div class="form-group row">
+                        <label for="dependency-input" class="col-sm-4 col-form-label">dependency</label>
+                        <div class="col-sm-8">
+                            <input id="dependency-input" type="text" class="form-control" placeholder="packages dependency" name="package" required>
+                        </div>
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button type="submit" class="btn btn-primary" onclick="packagesRebuild()"><i class="bi bi-play"></i> rebuild</button>
+                </div>
+            </form>
+        </div>
+    </div>
+</div>
+
+<script>
+    const packageRebuildModal = $("#package-rebuild-modal");
+    const packageRebuildForm = $("#package-rebuild-form");
+    packageRebuildModal.on("hidden.bs.modal", () => { packageRebuildForm.trigger("reset"); });
+
+    const dependencyInput = $("#dependency-input");
+
+    function packagesRebuild() {
+        const packages = dependencyInput.val();
+        if (packages) {
+            packageRebuildModal.modal("hide");
+            const onSuccess = update => { return `Repository rebuild has been run for packages which depend on ${update}`; };
+            const onFailure = error => { return `Repository rebuild failed: ${error}`; };
+            doPackageAction("/api/v1/service/rebuild", [packages], onSuccess, onFailure);
+        }
+    }
+</script>

package/share/ahriman/templates/build-status/table.jinja2

@@ -0,0 +1,165 @@
+<script>
+    const keyImportButton = $("#key-import-btn");
+    const packageAddButton = $("#package-add-btn");
+    const packageRebuildButton = $("#package-rebuild-btn");
+    const packageRemoveButton = $("#package-remove-btn");
+    const packageUpdateButton = $("#package-update-btn");
+
+    const table = $("#packages");
+    table.on("check.bs.table uncheck.bs.table check-all.bs.table uncheck-all.bs.table", () => {
+        packageRemoveButton.prop("disabled", !table.bootstrapTable("getSelections").length);
+    });
+    table.on("click-row.bs.table", (self, data, row, cell) => {
+        if (0 === cell || "base" === cell) {
+            const method = data[0] === true ? "uncheckBy" : "checkBy"; // fck javascript
+            table.bootstrapTable(method, {field: "id", values: [data.id]});
+        } else showLogs(data.id);
+    });
+
+    const repositoryBadge = $("#badge-repository");
+    const statusBadge = $("#badge-status");
+    const versionBadge = $("#badge-version");
+
+    function doPackageAction(uri, packages, successText, failureText) {
+        $.ajax({
+            url: uri,
+            data: JSON.stringify({packages: packages}),
+            type: "POST",
+            contentType: "application/json",
+            success: _ => {
+                const message = successText(packages.join(", "));
+                showSuccess("Success", message);
+            },
+            error: (jqXHR, _, errorThrown) => {
+                showFailure("Action failed", failureText, jqXHR, errorThrown);
+            },
+        });
+    }
+
+    function getSelection() {
+        return table.bootstrapTable("getSelections").map(row => { return row.id; });
+    }
+
+    function removePackages() {
+        const onSuccess = update => { return `Packages ${update} have been removed`; };
+        const onFailure = error => { return `Could not remove packages: ${error}`; };
+        doPackageAction("/api/v1/service/remove", getSelection(), onSuccess, onFailure);
+    }
+
+    function updatePackages() {
+        const currentSelection = getSelection();
+        const [url, onSuccess] = currentSelection.length === 0
+            ? ["/api/v1/service/update", _ => { return "Repository update has been run"; }]
+            : ["/api/v1/service/add", update => { return `Run update for packages ${update}`; }];
+        const onFailure = error => { return `Packages update failed: ${error}`; };
+        doPackageAction(url, currentSelection, onSuccess, onFailure);
+    }
+
+    function hideControls(hidden) {
+        keyImportButton.attr("hidden", hidden);
+        packageAddButton.attr("hidden", hidden);
+        packageRebuildButton.attr("hidden", hidden);
+        packageRemoveButton.attr("hidden", hidden);
+        packageUpdateButton.attr("hidden", hidden);
+    }
+
+    function reload() {
+        table.bootstrapTable("showLoading");
+
+        const badgeClass = status => {
+            if (status === "pending") return "btn-outline-warning";
+            if (status === "building") return "btn-outline-warning";
+            if (status === "failed") return "btn-outline-danger";
+            if (status === "success") return "btn-outline-success";
+            return "btn-outline-secondary";
+        };
+
+        $.ajax({
+            url: "/api/v1/packages",
+            type: "GET",
+            dataType: "json",
+            success: response => {
+                const extractListProperties = (description, property) => {
+                    return Object.values(description.packages)
+                        .map(pkg => { return pkg[property]; })
+                        .reduce((left, right) => { return left.concat(right); }, []);
+                };
+                const listToTable = data => {
+                    return Array.from(new Set(data))
+                        .sort()
+                        .map(entry => { return safe(entry); })
+                        .join("<br>");
+                };
+
+                const payload = response.map(description => {
+                    const package_base = description.package.base;
+                    const web_url = description.package.remote?.web_url;
+                    return {
+                        id: package_base,
+                        base: web_url ? `<a href="${safe(web_url)}" title="${safe(package_base)}">${safe(package_base)}</a>` : safe(package_base),
+                        version: safe(description.package.version),
+                        packages: listToTable(Object.keys(description.package.packages)),
+                        groups: listToTable(extractListProperties(description.package, "groups")),
+                        licenses: listToTable(extractListProperties(description.package, "licenses")),
+                        timestamp: new Date(1000 * description.status.timestamp).toISOString(),
+                        status: description.status.status,
+                    };
+                });
+
+                table.bootstrapTable("load", payload);
+                table.bootstrapTable("uncheckAll");
+                table.bootstrapTable("hideLoading");
+                hideControls(false);
+            },
+            error: (jqXHR, _, errorThrown) => {
+                if ((jqXHR.status === 401) || (jqXHR.status === 403)) {
+                    // authorization error
+                    const text = "In order to see statuses you must login first.";
+                    table.find("tr.unauthorized").remove();
+                    table.find("tbody").append(`<tr class="unauthorized"><td colspan="100%">${safe(text)}</td></tr>`);
+                    table.bootstrapTable("hideLoading");
+                } else {
+                    // other errors
+                    const messaga = error => { return `Could not load list of packages: ${error}`; };
+                    showFailure("Load failure", messaga, jqXHR, errorThrown);
+                }
+                hideControls(true);
+            },
+        });
+
+        $.ajax({
+            url: "/api/v1/status",
+            type: "GET",
+            dataType: "json",
+            success: response => {
+                repositoryBadge.text(`${response.repository} ${response.architecture}`);
+                versionBadge.html(`<i class="bi bi-github"></i> ahriman ${safe(response.version)}`);
+
+                statusBadge
+                    .popover("dispose")
+                    .attr("data-bs-content", `${response.status.status} at ${new Date(1000 * response.status.timestamp).toISOString()}`)
+                    .popover();
+                statusBadge.removeClass();
+                statusBadge.addClass("btn");
+                statusBadge.addClass(badgeClass(response.status.status));
+            },
+        });
+    }
+
+    function statusFormat(value) {
+        const cellClass = status => {
+            if (status === "pending") return "table-warning";
+            if (status === "building") return "table-warning";
+            if (status === "failed") return "table-danger";
+            if (status === "success") return "table-success";
+            return "table-secondary";
+        };
+        return {classes: cellClass(value)};
+    }
+
+    $(() => {
+        table.bootstrapTable({});
+        statusBadge.popover();
+        reload();
+    });
+</script>

package/share/ahriman/templates/email-index.jinja2

@@ -0,0 +1,42 @@
+{#simplified version of full report#}
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>{{ repository }}</title>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        {% include "utils/style.jinja2" %}
+    </head>
+
+    <body>
+
+        <div class="container">
+            <table id="packages" class="table table-striped">
+                <thead class="table-primary">
+                    <tr>
+                        <th>package</th>
+                        <th>version</th>
+                        <th>archive size</th>
+                        <th>installed size</th>
+                        <th>build date</th>
+                    </tr>
+                </thead>
+
+                <tbody>
+                {% for package in packages %}
+                    <tr>
+                        <td><a href="{{ link_path }}/{{ package.filename }}" title="{{ package.name }}">{{ package.name }}</a></td>
+                        <td>{{ package.version }}</td>
+                        <td>{{ package.archive_size }}</td>
+                        <td>{{ package.installed_size }}</td>
+                        <td>{{ package.build_date }}</td>
+                    </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+
+    </body>
+
+</html>

package/share/ahriman/templates/error.jinja2

@@ -0,0 +1,31 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>Error</title>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        <link rel="shortcut icon" href="/static/favicon.ico">
+
+        {% include "utils/style.jinja2" %}
+    </head>
+
+    <body>
+
+        {% include "utils/bootstrap-scripts.jinja2" %}
+
+        <div class="d-flex flex-row align-items-center">
+            <div class="container">
+                <div class="row justify-content-center">
+                    <div class="col-md-12 text-center">
+                        <span class="display-1 d-block">{{ code }}</span>
+                        <div class="mb-4 lead">{{ reason }}</div>
+                        <a class="btn btn-link" style="text-decoration: none" href="/" title="home"><i class="bi bi-house"></i> home</a>
+                    </div>
+                </div>
+            </div>
+        </div>
+
+    </body>
+
+</html>

package/share/ahriman/templates/repo-index.jinja2

@@ -0,0 +1,110 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>{{ repository }}</title>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        {% include "utils/style.jinja2" %}
+    </head>
+
+    <body>
+
+        {% include "utils/bootstrap-scripts.jinja2" %}
+
+        <div class="container">
+            <h1>Arch linux user repository</h1>
+        </div>
+
+        <div class="container">
+            {% if pgp_key is not none %}
+                <p>This repository is signed with <a href="https://keyserver.ubuntu.com/pks/lookup?search=0x{{ pgp_key }}&fingerprint=on&op=index" title="key search">{{ pgp_key }}</a> by default.</p>
+            {% endif %}
+
+            <p>In order to use this repository edit your <code>/etc/pacman.conf</code> as following:</p>
+
+            <pre class="language-ini"><code id="pacman-conf" class="language-ini">[{{ repository }}]
+Server = {{ link_path }}
+SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Package{% if has_package_signed %}Required{% else %}Never{% endif %} TrustedOnly</code><button id="copy-btn" type="button" class="btn language-ini" onclick="copyPacmanConf()"><i class="bi bi-clipboard"></i> copy</button></pre>
+        </div>
+
+        <div class="container">
+            <table id="packages" class="table table-striped table-hover"
+                   data-export-options='{"fileName": "packages"}'
+                   data-page-list="[10, 25, 50, 100, all]"
+                   data-page-size="10"
+                   data-pagination="true"
+                   data-resizable="true"
+                   data-search="true"
+                   data-show-columns="true"
+                   data-show-columns-search="true"
+                   data-show-columns-toggle-all="true"
+                   data-show-export="true"
+                   data-show-fullscreen="true"
+                   data-show-search-clear-button="true"
+                   data-sortable="true"
+                   data-sort-name="base"
+                   data-sort-order="asc"
+                   data-toggle="table">
+                <thead class="table-primary">
+                    <tr>
+                        <th data-sortable="true" data-switchable="false">package</th>
+                        <th data-sortable="true">version</th>
+                        <th data-sortable="true" data-visible="false">architecture</th>
+                        <th data-sortable="true" data-visible="false">description</th>
+                        <th data-sortable="true" data-visible="false">upstream url</th>
+                        <th data-sortable="true" data-visible="false">licenses</th>
+                        <th data-sortable="true" data-visible="false">groups</th>
+                        <th data-sortable="true" data-visible="false">depends</th>
+                        <th data-sortable="true">archive size</th>
+                        <th data-sortable="true">installed size</th>
+                        <th data-sortable="true">build date</th>
+                    </tr>
+                </thead>
+
+                <tbody>
+                {% for package in packages %}
+                    <tr>
+                        <td><a href="{{ link_path }}/{{ package.filename }}" title="{{ package.name }}">{{ package.name }}</a></td>
+                        <td>{{ package.version }}</td>
+                        <td>{{ package.architecture }}</td>
+                        <td>{{ package.description }}</td>
+                        <td><a href="{{ package.url }}" title="{{ package.name }} upstream url">{{ package.url }}</a></td>
+                        <td>{{ package.licenses|join("<br>"|safe) }}</td>
+                        <td>{{ package.groups|join("<br>"|safe) }}</td>
+                        <td>{{ package.depends|join("<br>"|safe) }}</td>
+                        <td>{{ package.archive_size }}</td>
+                        <td>{{ package.installed_size }}</td>
+                        <td>{{ package.build_date }}</td>
+                    </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+
+        <div class="container">
+            <footer class="d-flex flex-wrap justify-content-between align-items-center border-top">
+                <ul class="nav">
+                    {% if homepage is not none %}
+                        <li><a class="nav-link" href="{{ homepage }}" title="homepage"><i class="bi bi-house"></i> homepage</a></li>
+                    {% endif %}
+                </ul>
+                <ul class="nav">
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources"><i class="bi bi-github"></i> ahriman</a></li>
+                </ul>
+            </footer>
+        </div>
+
+        <script>
+            const pacmanConf = $("#pacman-conf");
+            const pacmanConfCopyButton = $("#copy-btn");
+
+            async function copyPacmanConf() {
+                const conf = pacmanConf.text();
+                await copyToClipboard(conf, pacmanConfCopyButton);
+            }
+        </script>
+
+    </body>
+
+</html>

package/share/ahriman/templates/shell

@@ -0,0 +1,18 @@
+                                              
+                         ▄▄▄    ▄▄▄▄▄▄█▀      
+                       ▄▄▄▄▄▄▄▄▄██▄▄▄█▄▄      
+                       ██▄▄███▄▄▄▄▄██▄▄█▄▄    
+                       █▄██████▄▄▄████▄▄█▄▄  ▄
+                       █▄▄▄█████████▄▄▄▄▀▄█▄█▀
+                      █▄▀▄████▄█▄▄▄▄███▄▄ ▀▀  
+                      █▄▄▄████▄██████████     
+         ▄▄▄▄▄▄▄▄▄     ▀█▄█████▄▄▄▄█▄███▄     
+       ▄▄███▄▄▄▄▄▄▄▄▄    ▀ ▀▄█████▄▄█▄███     
+       ███▄▄████▄▄█▄██▄▄▄   ███▄▄▄▄▄▄█▀▀      
+       ███████▄▀    ▄▄▄██▄▄▄█████             
+       ██▄▄████    █▄█▄▄█████████             
+      ▄▄█▄▄██▄▀    ▀▄████▄██▄██▄▄             
+      ████████      ▄███▄▄▄█▄████             
+     ▄▄▄▄███▄▀     ▄▄█████ ███▄▄▄▄            
+ ▄▄▄██▄▄█▄▄▄▀      █████▄█ █████▄█            
+  ▀▀▀▀▀▀▀           ▀▀▀▀    ▀▀▀▀