github.com/kubri/kubri@v0.5.1-0.20240317001612-bda2aaef967e/website/docs/configuration/generators/appinstaller.md (about)

     1  ---
     2  sidebar_position: 20
     3  ---
     4  
     5  # Windows App Installer
     6  
     7  Generate and publish a Windows App Installer file from your `.msix`, `.msixbundle`, `.appx` and
     8  `.appxbundle` files.
     9  
    10  For more information see
    11  https://learn.microsoft.com/en-us/uwp/schemas/appinstallerschema/element-update-settings
    12  
    13  ## Configuration
    14  
    15  ### `disabled`
    16  
    17  - Type: `boolean`
    18  - Default: `false`
    19  
    20  Disable Windows App Installer.
    21  
    22  ### `folder`
    23  
    24  - Type: `string`
    25  - Default: `'appinstaller'`
    26  
    27  Path to the directory on your target.
    28  
    29  <!-- ### `upload-packages`
    30  
    31  - Type: `boolean`
    32  - Default: `false`
    33  
    34  Defines whether to upload packages to your target or reference them from your source. Set it to
    35  `true` if the source is private. -->
    36  
    37  ### `on-launch`
    38  
    39  Use `on-launch` to configure checking for updates on launch. This type of update can show UI.
    40  
    41  ### `on-launch.hours-between-update-checks`
    42  
    43  - Type: `integer`
    44  - Default: `24`
    45  
    46  An integer that indicates how often (in how many hours) the system will check for updates to the
    47  app. `0` to `255` inclusive. The default value is `24` (if this value is not specified). For example
    48  if `hours-between-update-checks` is `3` then when the user launches the app, if the system has not
    49  checked for updates within the past 3 hours, it will check for updates now.
    50  
    51  ### `on-launch.show-prompt`
    52  
    53  - Type: `boolean`
    54  - Default: `false`
    55  
    56  A boolean that determines if UI will be shown to the user. This value is supported on Windows 10,
    57  version 1903 and later.
    58  
    59  ### `on-launch.update-blocks-activation`
    60  
    61  - Type: `boolean`
    62  - Default: `false`
    63  
    64  A boolean that determines if the UI shown to the user allows the user to launch the app without
    65  taking the update, or if the user must take the update before launching the app. This attribute can
    66  be set to `true` only if ShowPrompt is set to `true`. If set to `true` this means the UI the user
    67  will see, allows the user to take the update or close the app. If set to `false` this means the UI
    68  the user will see, allows the user to take the update or start the app without updating. In the
    69  latter case, the update will be applied silently at an opportune time. This value is supported on
    70  Windows 10, version 1903 and later.
    71  
    72  :::info
    73  
    74  `show-prompt` needs to be set to `true` if `update-blocks-activation` is set to `true`.
    75  
    76  :::
    77  
    78  ### `automatic-background-task`
    79  
    80  - Type: `boolean`
    81  - Default: `false`
    82  
    83  Checks for updates in the background every 8 hours independently of whether the user launched the
    84  app. This type of update cannot show UI.
    85  
    86  ### `force-update-from-any-version`
    87  
    88  - Type: `boolean`
    89  - Default: `false`
    90  
    91  Allows the app to update from version x to version x++ or to downgrade from version x to version
    92  x--. Without this element, the app can only move to a higher version.
    93  
    94  ## Example
    95  
    96  ```yaml
    97  appinstaller:
    98    folder: windows
    99    upload-packages: true
   100    on-launch:
   101      hours-between-update-checks: 12
   102      show-prompt: true
   103      update-blocks-activation: true
   104    automatic-background-task: true
   105    force-update-from-any-version: true
   106  ```