feat: allow to use single web instance for all repositories (#114)

* Allow to use single web instance for any repository

* some improvements

* drop includes from user home directory, introduce new variables to docker

The old solution didn't actually work as expected, because devtools
configuration belongs to filesystem (as well as sudo one), so it was
still required to run setup command.

In order to handle additional repositories, the POSTSETUP and PRESETUP
commands variables have been introduced. FAQ has been updated as well

* raise 404 in case if repository is unknown

docs/ahriman.application.handlers.rst

@@ -100,6 +100,14 @@ ahriman.application.handlers.remove\_unknown module
    :no-undoc-members:
    :show-inheritance:
 
+ahriman.application.handlers.repositories module
+------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
 ahriman.application.handlers.restore module
 -------------------------------------------
 

docs/ahriman.core.formatters.rst

@@ -60,6 +60,14 @@ ahriman.core.formatters.printer module
    :no-undoc-members:
    :show-inheritance:
 
+ahriman.core.formatters.repository\_printer module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.repository_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
 ahriman.core.formatters.status\_printer module
 ----------------------------------------------
 

docs/ahriman.models.rst

@@ -140,6 +140,14 @@ ahriman.models.pkgbuild\_patch module
    :no-undoc-members:
    :show-inheritance:
 
+ahriman.models.process\_status module
+-------------------------------------
+
+.. automodule:: ahriman.models.process_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
 ahriman.models.property module
 ------------------------------
 

docs/ahriman.web.schemas.rst

@@ -172,6 +172,14 @@ ahriman.web.schemas.remote\_schema module
    :no-undoc-members:
    :show-inheritance:
 
+ahriman.web.schemas.repository\_id\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.repository_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
 ahriman.web.schemas.search\_schema module
 -----------------------------------------
 

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

@@ -28,6 +28,14 @@ ahriman.web.views.v1.status.packages module
    :no-undoc-members:
    :show-inheritance:
 
+ahriman.web.views.v1.status.repositories module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
 ahriman.web.views.v1.status.status module
 -----------------------------------------
 

docs/configuration.rst

@@ -41,7 +41,7 @@ Base configuration settings.
 
 * ``apply_migrations`` - perform migrations on application start, boolean, optional, default ``yes``. Useful if you are using git version. Note, however, that this option must be changed only if you know what to do and going to handle migrations automatically.
 * ``database`` - path to SQLite database, string, required.
-* ``include`` - path to directory with configuration files overrides, string, required.
+* ``include`` - path to directory with configuration files overrides, string, optional.
 * ``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.
 
@@ -103,10 +103,10 @@ Settings for signing packages or repository. Group name can refer to architectur
 * ``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.
 
-``web:*`` groups
-----------------
+``web`` group
+-------------
 
-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.
+Web server settings. If any of ``host``/``port`` is not set, web integration will be disabled. 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``.

docs/faq.rst

@@ -402,6 +402,8 @@ The following environment variables are supported:
 * ``AHRIMAN_PACKAGER`` - packager name from which packages will be built, default is ``ahriman bot <ahriman@example.com>``.
 * ``AHRIMAN_PACMAN_MIRROR`` - override pacman mirror server if set.
 * ``AHRIMAN_PORT`` - HTTP server port if any, default is empty.
+* ``AHRIMAN_POSTSETUP_COMMAND`` - if set, the command which will be called (as root) after the setup command, but before any other actions.
+* ``AHRIMAN_PRESETUP_COMMAND`` - if set, the command which will be called (as root) right before the setup command.
 * ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur-clone``.
 * ``AHRIMAN_REPOSITORY_SERVER`` - optional override for the repository url. Useful if you would like to download packages from remote instead of local filesystem.
 * ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume.
@@ -429,7 +431,7 @@ This command uses same rules as ``repo-update``, thus, e.g. requires ``--privile
 Web service setup
 ^^^^^^^^^^^^^^^^^
 
-Well for that you would need to have web container instance running forever; it can be achieved by the following command:
+For that you would need to have web container instance running forever; it can be achieved by the following command:
 
 .. code-block:: shell
 
@@ -451,6 +453,20 @@ Otherwise, you would need to pass ``AHRIMAN_PORT`` and mount container network t
 
    docker run --privileged --net=host -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
 
+Mutli-repository web service
+""""""""""""""""""""""""""""
+
+Idea is pretty same as to just run web service. However, it is required to run setup commands for each repository, except for one which is specified by ``AHRIMAN_REPOSITORY`` and ``AHRIMAN_ARCHITECTURE`` variables.
+
+In order to create configuration for additional repositories, the ``AHRIMAN_POSTSETUP_COMMAND`` variable should be used, e.g.:
+
+.. code-block:: shell
+
+   docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -e AHRIMAN_UNIX_SOCKET=/var/lib/ahriman/ahriman/ahriman-web.sock -e AHRIMAN_POSTSETUP_COMMAND="ahriman --architecture x86_64 --repository aur-clone-v2 service-setup --build-as-user ahriman --packager 'ahriman bot <ahriman@example.com>'" -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+
+The command above will also create configuration for the repository named ``aur-clone-v2``.
+
+Note, however, that the command above is only required in case if the service is going to be used to run subprocesses. Otherwise, everything else (web interface, status, etc) will be handled as usual.
 
 Non-x86_64 architecture setup
 -----------------------------
@@ -1073,7 +1089,7 @@ How to setup web service
       port = 8080
 
 #. 
-   Start the web service ``systemctl enable --now ahriman-web@x86_64-aur-clone``.
+   Start the web service ``systemctl enable --now ahriman-web``.
 
 How to enable basic authorization
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -1130,7 +1146,7 @@ How to enable basic authorization
       sudo -u ahriman ahriman user-add -r full my-first-user
 
 #.
-   Restart web service ``systemctl restart ahriman-web@x86_64-aur-clone``.
+   Restart web service ``systemctl restart ahriman-web``.
 
 How to enable OAuth authorization
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -1176,7 +1192,7 @@ How to enable OAuth authorization
    When it will ask for the password leave it blank.
 
 #.
-   Restart web service ``systemctl restart ahriman-web@x86_64-aur-clone``.
+   Restart web service ``systemctl restart ahriman-web``.
 
 How to implement own interface
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/migration.rst

@@ -54,6 +54,8 @@ In order to migrate to new filesystem tree the following actions are required:
 
    Alternatively it can be done by running ``service-setup`` command again.
 
+#. If you didn't run setup command on the previous step, make sure to remove architecture reference from ``web`` section (if any).
+
 #.
    Make sure to update remote synchronization services if any. Almost all of them rely on current repository tree by default, so you need to setup either redirects or configure to synchronize to the old locations (e.g. ``object_path`` option for S3 synchronization).
 
@@ -63,4 +65,4 @@ In order to migrate to new filesystem tree the following actions are required:
    .. code-block:: shell
 
       sudo systemctl enable --now ahriman@x86_64-aur-clone.timer
-      sudo systemctl enable --now ahriman-web@x86_64-aur-clone
+      sudo systemctl enable --now ahriman-web

docs/setup.rst

@@ -81,7 +81,7 @@ Initial setup
 
    .. code-block:: shell
 
-       systemctl enable --now ahriman-web@x86_64-aur-clone
+       systemctl enable --now ahriman-web
 
 #. 
    Add packages by using ``ahriman package-add {package}`` command: