From 4d482520cdbfd5d835891f5dbe5c78e525d6d83b Mon Sep 17 00:00:00 2001 From: Evgeniy Alekseev Date: Fri, 13 Jan 2023 17:00:11 +0200 Subject: [PATCH] add note about other authroization options to gitremote triggers --- docs/configuration.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 58e312e6..15ec7dfd 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -110,7 +110,12 @@ Web server settings. If any of ``host``/``port`` is not set, web integration wil 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. +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 `_. + +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). @@ -125,7 +130,12 @@ Remote pull trigger 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. +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 `_. + +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).