diff --git a/README.md b/README.md index ebd4ba7..12100b3 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,32 @@ This is done via three plugins: new compose. +## Installation + +The plugins need to be installed on the machines running the corresponding +services. Installation via RPMs is recommended. The RPMs for the latest git +commit of the source can be easily created via meson: + +``` +meson . build +ninja -C build rpms +``` + +The RPMs should then be in `build/rpmbuild`. The hub and builder plugin +also need to be explicitly enabled in the respective configuration files. +The *hub* plugin configuration file at `/etc/koji-hub/hub.conf`. The +plugin is enabled by adding `osbuild` to the `Plugins` directive. The +*builder*: configuration file at `/etc/kojid/kojid.conf`. Here `osbuild` +needs to be added to the `plugin` directive. +For an example, see the test container configuration files +[`hub.conf`](test/container/hub/hub.conf`) for the hub and +[`kojid.conf`](`container/builder/kojid.conf`) for the builder. + +Additionally, an osbuild-composer instance, at least version 21, with the +koji API enabled needs to be running and reachable via TCP from the host +running the koji builder. + + ## Configuration The builder plugin needs to be configured via a `builder.conf` file that