settings.conf

   1 # Configuration file for Calamares
   2 # Syntax is YAML 1.2
   3 ---
   4 # Modules can be job modules (with different interfaces) and QtWidgets view
   5 # modules. They could all be placed in a number of different paths.
   6 # "modules-search" is a list of strings, each of these can either be a full
   7 # path to a directory or the keyword "local".
   8 #
   9 # "local" means:
  10 #   - modules in $LIBDIR/calamares/modules, with
  11 #   - settings in SHARE/calamares/modules or /etc/calamares/modules.
  12 # In debug-mode (e.g. calamares -d) "local" also adds some paths
  13 # that make sense from inside the build-directory, so that you
  14 # can build-and-run with the latest modules immediately.
  15 #
  16 # Strings other than "local" are taken as paths and interpreted
  17 # relative to wherever Calamares is started. It is therefore **strongly**
  18 # recommended to use only absolute paths here. This is mostly useful
  19 # if your distro has forks of standard Calamares modules, but also
  20 # uses some form of upstream packaging which might overwrite those
  21 # forked modules -- then you can keep modules somewhere outside of
  22 # the "regular" module tree.
  23 #
  24 #
  25 # YAML: list of strings.
  26 modules-search: [ local ]
  27
  28 # Instances section. This section is optional, and it defines custom instances
  29 # for modules of any kind. An instance entry has an instance name, a module
  30 # name, and a configuration file name. The primary goal of this mechanism is
  31 # to allow loading multiple instances of the same module, with different
  32 # configuration. If you don't need this, the instances section can safely be
  33 # left empty.
  34 #
  35 # Module name plus instance name makes an instance key, e.g.
  36 # "webview@owncloud", where "webview" is the module name (for the webview
  37 # viewmodule) and "owncloud" is the instance name, which loads a configuration
  38 # file named "owncloud.conf" from any of the configuration file paths,
  39 # including the webview module directory. This instance key can then be
  40 # referenced in the sequence section.
  41 #
  42 # For all modules without a custom instance specification, a default instance
  43 # is generated automatically by Calamares. Therefore a statement such as
  44 # "webview" in the sequence section automatically implies an instance key of
  45 # "webview@webview" even without explicitly defining this instance, and the
  46 # configuration file for this default instance "<modulename>@<modulename>" is
  47 # always assumed to be "<modulename>.conf".
  48 #
  49 # For more information on running module instances, run Calamares in debug
  50 # mode and check the Modules page in the Debug information interface.
  51 #
  52 # A module that is often used with instances is dummyprocess, which will
  53 # run a single (shell) command. By configuring more than one instance of
  54 # the module, multiple shell commands can be run during install.
  55 #
  56 # YAML: list of maps of string:string key-value pairs.
  57 #instances:
  58 #- id:       owncloud
  59 #  module:   webview
  60 #  config:   owncloud.conf
  61
  62 # Sequence section. This section describes the sequence of modules, both
  63 # viewmodules and jobmodules, as they should appear and/or run.
  64 #
  65 # A jobmodule instance key (or name) can only appear in an exec phase, whereas
  66 # a viewmodule instance key (or name) can appear in both exec and show phases.
  67 # There is no limit to the number of show or exec phases. However, the same
  68 # module instance key should not appear more than once per phase, and
  69 # deployers should take notice that the global storage structure is persistent
  70 # throughout the application lifetime, possibly influencing behavior across
  71 # phases. A show phase defines a sequence of viewmodules (and therefore
  72 # pages). These viewmodules can offer up jobs for the execution queue.
  73 #
  74 # An exec phase displays a progress page (with brandable slideshow). This
  75 # progress page iterates over the modules listed in the *immediately
  76 # preceding* show phase, and enqueues their jobs, as well as any other jobs
  77 # from jobmodules, in the order defined in the current exec phase.
  78 #
  79 # It then executes the job queue and clears it. If a viewmodule offers up a
  80 # job for execution, but the module name (or instance key) isn't listed in the
  81 # immediately following exec phase, this job will not be executed.
  82 #
  83 # YAML: list of lists of strings.
  84 sequence:
  85 - show:
  86   - welcome
  87 #  - dummypythonqt
  88   - locale
  89   - keyboard
  90   - partition
  91   - users
  92 #  - tracking
  93   - summary
  94 - exec:
  95 #  - dummycpp
  96 #  - dummyprocess
  97 #  - dummypython
  98 #  - dummypythonqt
  99   - partition
 100   - mount
 101   - unpackfs
 102   - machineid
 103   - fstab
 104   - locale
 105   - keyboard
 106   - localecfg
 107 #  - luksbootkeyfile
 108 #  - luksopenswaphookcfg
 109 #  - dracutlukscfg
 110 #  - plymouthcfg
 111   - initcpiocfg
 112   - initcpio
 113   - users
 114   - displaymanager
 115   - networkcfg
 116   - hwclock
 117   - services-systemd
 118 #  - dracut
 119   - initramfs
 120 #  - grubcfg
 121   - bootloader
 122   - umount
 123 - show:
 124 #  - webview@owncloud
 125   - finished
 126
 127 # A branding component is a directory, either in SHARE/calamares/branding or
 128 # in /etc/calamares/branding (the latter takes precedence). The directory must
 129 # contain a YAML file branding.desc which may reference additional resources
 130 # (such as images) as paths relative to the current directory.
 131 #
 132 # A branding component can also ship a QML slideshow for execution pages,
 133 # along with translation files.
 134 #
 135 # Only the name of the branding component (directory) should be specified
 136 # here, Calamares then takes care of finding it and loading the contents.
 137 #
 138 # YAML: string.
 139 branding: default
 140
 141 # If this is set to true, Calamares will show an "Are you sure?" prompt right
 142 # before each execution phase, i.e. at points of no return. If this is set to
 143 # false, no prompt is shown. Default is false, but Calamares will complain if
 144 # this is not explicitly set.
 145 #
 146 # YAML: boolean.
 147 prompt-install: false
 148
 149 # If this is set to true, Calamares will execute all target environment
 150 # commands in the current environment, without chroot. This setting should
 151 # only be used when setting up Calamares as a post-install configuration tool,
 152 # as opposed to a full operating system installer.
 153 #
 154 # Some official Calamares modules are not expected to function with this
 155 # setting. (e.g. partitioning seems like a bad idea, since that is expected to
 156 # have been done already)
 157 #
 158 # Default is false (for a normal installer), but Calamares will complain if
 159 # this is not explicitly set.
 160 #
 161 # YAML: boolean.
 162 dont-chroot: false
 163
 164 # If this is set to true, Calamares refers to itself as a "setup program"
 165 # rather than an "installer". Defaults to the value of dont-chroot, but
 166 # Calamares will complain if this is not explicitly set.
 167 # oem-setup: true
 168
 169 # If this is set to true, the "Cancel" button will be disabled entirely.
 170 # The button is also hidden from view.
 171 #
 172 # This can be useful if when e.g. Calamares is used as a post-install
 173 # configuration tool and you require the user to go through all the
 174 # configuration steps.
 175 #
 176 # Default is false, but Calamares will complain if this is not explicitly set.
 177 #
 178 # YAML: boolean.
 179 disable-cancel: false
 180
 181 # If this is set to true, the "Cancel" button will be disabled once
 182 # you start the 'Installation', meaning there won't be a way to cancel
 183 # the Installation until it has finished or installation has failed.
 184 #
 185 # Default is false, but Calamares will complain if this is not explicitly set.
 186 #
 187 # YAML: boolean.
 188 disable-cancel-during-exec: false