github.com/kubri/kubri@v0.5.1-0.20240317001612-bda2aaef967e/website/docs/configuration/index.mdx (about)

     1  ---
     2  sidebar_position: 4
     3  ---
     4  
     5  # Configuration
     6  
     7  Releases are configured using a YAML file called `.kubri.yml`.
     8  
     9  A simple configuration consists of a source that your releases are fetched from, a target to publish
    10  your repositories to and one or more integrations, which are your repository generators.
    11  
    12  Click on the links below to learn more about each configuration.
    13  
    14  ```mdx-code-block
    15  import DocCardList from '@theme/DocCardList';
    16  
    17  <DocCardList />
    18  ```
    19  
    20  ## Full Example
    21  
    22  ```yaml
    23  # source contains the configuration for the source of your releases.
    24  source:
    25    type: github
    26    owner: kubri
    27    repo: kubri
    28  
    29  # target contains the configuration for the target of your releases.
    30  target:
    31    type: s3
    32    bucket: kubri-releases
    33    region: us-west-1
    34    url: https://download.example.com
    35  
    36  # apk contains the configuration for the Alpine Linux repository generator.
    37  apk:
    38    folder: alpine
    39    key-name: alpine@kubri.dev
    40  
    41  # apt contains the configuration for the Debian repository generator.
    42  apt:
    43    folder: deb
    44    compress: [gzip, xz]
    45  
    46  # yum contains the configuration for the YUM repository generator.
    47  yum:
    48    folder: rpm
    49  
    50  # appinstaller contains the configuration for the AppInstaller generator.
    51  appinstaller:
    52    folder: windows
    53    upload-packages: true
    54    on-launch:
    55      hours-between-update-checks: 12
    56      show-prompt: true
    57      update-blocks-activation: true
    58    automatic-background-task: true
    59    force-update-from-any-version: true
    60  
    61  # sparkle contains the configuration for the Sparkle appcast feed generator.
    62  sparkle:
    63    folder: appcast
    64    title: My app feed title
    65    description: My app feed description
    66    params:
    67      - os: windows
    68        installer-arguments: /passive
    69      - os: macos
    70        minimum-system-version: '10.13.0'
    71  ```