diff --git a/docs/architecture.rst b/docs/architecture.rst index 6c6077a9..eb25bf0c 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -274,7 +274,7 @@ There are several supported synchronization providers, currently they are ``rsyn ``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 `_. +``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/aur-clone/x86_64`` for the ``aur-clone`` repository ``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 `_. ``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. diff --git a/docs/configuration.rst b/docs/configuration.rst index b1f0a6dd..c725723d 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -30,7 +30,7 @@ There is also additional subcommand which will allow to validate configuration a .. code-block:: shell - ahriman -a x86_64 service-config-validate + ahriman service-config-validate It will check current settings on common errors and compare configuration with known schema. diff --git a/docs/faq.rst b/docs/faq.rst index 8c92911f..ab112223 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -32,7 +32,7 @@ There is special command which can be used in order to validate current configur .. code-block:: shell - ahriman -a x86_64 -r aur-clone service-config-validate --exit-code + ahriman service-config-validate --exit-code This command will print found errors, based on `cerberus `_, e.g.: