1 # Configuration file for Calamares
4 # Modules can be job modules (with different interfaces) and QtWidgets view modules.
5 # 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 path to a
7 # directory or the keyword "local".
8 # "local" means LIBDIR/calamares/modules with settings in SHARE/calamares/modules or
9 # /etc/calamares/modules.
10 # YAML: list of strings.
11 modules-search: [ local ]
13 # Instances section. This section is optional, and it defines custom instances for
14 # modules of any kind. An instance entry has an instance name, a module name, and
15 # a configuration file name.
16 # The primary goal of this mechanism is to allow loading multiple instances of the
17 # same module, with different configuration. If you don't need this, the instances
18 # section can safely be left empty.
19 # Module name plus instance name makes an instance key, e.g. "webview@owncloud",
20 # where "webview" is the module name (for the webview viewmodule) and "owncloud"
21 # is the instance name, which loads a configuration file named "owncloud.conf" from
22 # any of the configuration file paths, including the webview module directory.
23 # This instance key can then be referenced in the sequence section.
24 # For all modules without a custom instance specification, a default instance is
25 # generated automatically by Calamares. Therefore a statement such as "webview" in
26 # the sequence section automatically implies an instance key of "webview@webview"
27 # even without explicitly defining this instance, and the configuration file for
28 # this default instance "<modulename>@<modulename>" is always assumed to be
29 # "<modulename>.conf".
30 # For more information on running module instances, run Calamares in debug mode
31 # and check the Modules page in the Debug information interface.
32 # YAML: list of maps of string:string key-value pairs.
37 # config: owncloud.conf
39 # Sequence section. This section describes the sequence of modules, both
40 # viewmodules and jobmodules, as they should appear and/or run.
41 # A jobmodule instance key (or name) can only appear in an exec phase, whereas
42 # a viewmodule instance key (or name) can appear in both exec and show phases.
43 # There is no limit to the number of show or exec phases. However, the same module
44 # instance key should not appear more than once per phase, and deployers should
45 # take notice that the global storage structure is persistent throughout the
46 # application lifetime, possibly influencing behavior across phases.
47 # A show phase defines a sequence of viewmodules (and therefore pages). These
48 # viewmodules can offer up jobs for the execution queue.
49 # An exec phase displays a progress page (with brandable slideshow). This progress
50 # page iterates over the modules listed in the *immediately preceding* show phase,
51 # and enqueues their jobs, as well as any other jobs from jobmodules, in the order
52 # defined in the current exec phase.
53 # It then executes the job queue and clears it. If a viewmodule offers up a job
54 # for execution, but the module name (or instance key) isn't listed in the
55 # immediately following exec phase, this job will not be executed.
56 # WARNING: when upgrading from Calamares 1.1, this section requires manual
57 # intervention. There are no fixed prepare/install/postinstall phases any more,
58 # and all limitations on the number of phases, number of pages, and number of
59 # instances are lifted.
60 # YAML: list of lists of strings.
85 # - luksopenswaphookcfg
104 # A branding component is a directory, either in SHARE/calamares/branding or in
105 # /etc/calamares/branding (the latter takes precedence). The directory must contain a
106 # YAML file branding.desc which may reference additional resources (such as images) as
107 # paths relative to the current directory.
108 # A branding component can also ship a QML slideshow for execution pages, along with
110 # Only the name of the branding component (directory) should be specified here, Calamares
111 # then takes care of finding it and loading the contents.
115 # If this is set to true, Calamares will show an "Are you sure?" prompt right before
116 # each execution phase, i.e. at points of no return. If this is set to false, no prompt
120 prompt-install: false
122 # If this is set to true, Calamares will execute all target environment commands in the
123 # current environment, without chroot. This setting is considered experimental, and it
124 # should only be used when setting up Calamares as a post-install configuration tool, as
125 # opposed to a full operating system installer.
126 # Some official Calamares modules are not expected to function with this setting.
127 # Packagers beware, here be dragons.