diff --git a/docs/faq/reporting.rst b/docs/faq/reporting.rst index 7a86dab8..84336025 100644 --- a/docs/faq/reporting.rst +++ b/docs/faq/reporting.rst @@ -28,8 +28,8 @@ How to report by email sender = me@example.com user = me@example.com -How to generate index page for S3 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +How to generate index page +^^^^^^^^^^^^^^^^^^^^^^^^^^ #. Install dependencies: @@ -50,7 +50,27 @@ How to generate index page for S3 path = ${repository:root}/repository/aur-clone/x86_64/index.html link_path = http://example.com/aur-clone/x86_64 -After these steps ``index.html`` file will be automatically synced to S3. +Having this configuration, the generated ``index.html`` will be also automatically synced to remote services (e.g. S3). + +How to generate RSS feed for index page +""""""""""""""""""""""""""""""""""""""" + +In addition to previous steps, the following configuration is required: + +.. code-block:: ini + + [report] + target = html rss + + [html] + rss_url = ${html:link_path}/rss.xml + + [rss] + link_path = ${html:link_path} + path = ${repository:root}/repository/ahriman-demo/x86_64/rss.xml + rss_url = ${html:link_path}/rss.xml + +With the appended configuration, the service fill also generate ``rss.xml``, link it to generated ``index.html`` and put it together. How to post build report to telegram ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/recipes/index/README.md b/recipes/index/README.md index 7f101552..ed380627 100644 --- a/recipes/index/README.md +++ b/recipes/index/README.md @@ -1,6 +1,7 @@ # Index 1. Setup repository named `ahriman-demo` with architecture `x86_64`. -2. Generate index page. +2. Generate index page and RSS feed. 3. Repository is available at `http://localhost:8080/repo`. 4. Index page is available at `http://localhost:8080/repo/ahriman-demo/x86_64/index.html` +5. Index page is available at `http://localhost:8080/repo/ahriman-demo/x86_64/rss.xml` diff --git a/recipes/index/service.ini b/recipes/index/service.ini index 80e3f016..e08109b5 100644 --- a/recipes/index/service.ini +++ b/recipes/index/service.ini @@ -1,6 +1,12 @@ [report] -target = html +target = html rss [html] path = ${repository:root}/repository/ahriman-demo/x86_64/index.html link_path = http://localhost:8080/repo/ahriman-demo/x86_64 +rss_url = ${html:link_path}/rss.xml + +[rss] +link_path = ${html:link_path} +path = ${repository:root}/repository/ahriman-demo/x86_64/rss.xml +rss_url = ${html:link_path}/rss.xml