OSDN Git Service

[fstab] Improve btrfs mount options
[alterlinux/alterlinux-calamares.git] / settings.conf
1 # SPDX-FileCopyrightText: no
2 # SPDX-License-Identifier: CC0-1.0
3 #
4 # Configuration file for Calamares
5 #
6 # This is the top-level configuration file for Calamares.
7 # It specifies what modules will be used, as well as some
8 # overall characteristics -- is this a setup program, or
9 # an installer. More specific configuration is devolved
10 # to the branding file (for the UI) and the individual
11 # module configuration files (for functionality).
12 ---
13 # Modules can be job modules (with different interfaces) and QtWidgets view
14 # modules. They could all be placed in a number of different paths.
15 # "modules-search" is a list of strings, each of these can either be a full
16 # path to a directory or the keyword "local".
17 #
18 # "local" means:
19 #   - modules in $LIBDIR/calamares/modules, with
20 #   - settings in SHARE/calamares/modules or /etc/calamares/modules.
21 # In debug-mode (e.g. calamares -d) "local" also adds some paths
22 # that make sense from inside the build-directory, so that you
23 # can build-and-run with the latest modules immediately.
24 #
25 # Strings other than "local" are taken as paths and interpreted
26 # relative to wherever Calamares is started. It is therefore **strongly**
27 # recommended to use only absolute paths here. This is mostly useful
28 # if your distro has forks of standard Calamares modules, but also
29 # uses some form of upstream packaging which might overwrite those
30 # forked modules -- then you can keep modules somewhere outside of
31 # the "regular" module tree.
32 #
33 #
34 # YAML: list of strings.
35 modules-search: [ local ]
36
37 # Instances section. This section is optional, and it defines custom instances
38 # for modules of any kind. An instance entry has these keys:
39 # - *module* name, which matches the module name from the module descriptor
40 #   (usually the name of the directory under `src/modules/`, but third-
41 #   party modules may diverge.
42 # - *id* (optional) an identifier to distinguish this instance from
43 #   all the others. If none is given, the name of the module is used.
44 #   Together, the module and id form an instance key (see below).
45 # - *config* (optional) a filename for the configuration. If none is
46 #   given, *module*`.conf` is used (e.g. `welcome.conf` for the welcome
47 #   module)
48 # - *weight* (optional) In the *exec* phase of the sequence, progress
49 #   is reported as jobs are completed. The jobs from a single module
50 #   together contribute the full weight of that module. The overall
51 #   progress (0 .. 100%) is divided up according to the weight of each
52 #   module. Give modules that take a lot of time to complete, a larger
53 #   weight to keep the overall progress moving along steadily. This
54 #   weight overrides a weight given in the module descriptor. If no weight
55 #   is given, uses the value from the module descriptor, or 1 if there
56 #   isn't one there either.
57 #
58 # The primary goal of this mechanism is to allow loading multiple instances
59 # of the same module, with different configuration. If you don't need this,
60 # the instances section can safely be left empty.
61 #
62 # Module name plus instance name makes an instance key, e.g.
63 # "webview@owncloud", where "webview" is the module name (for the webview
64 # viewmodule) and "owncloud" is the instance name. In the *sequence*
65 # section below, use instance-keys to name instances (instead of just
66 # a module name, for modules which have only a single instance).
67 #
68 # Every module implicitly has an instance with the instance name equal
69 # to its module name, e.g. "welcome@welcome". In the *sequence* section,
70 # mentioning a module without a full instance key (e.g. "welcome")
71 # means that implicit module.
72 #
73 # An instance may specify its configuration file (e.g. `webview-home.conf`).
74 # The implicit instances all have configuration files named `<module>.conf`.
75 # This (implict) way matches the source examples, where the welcome
76 # module contains an example `welcome.conf`. Specify a *config* for
77 # any module (also implicit instances) to change which file is used.
78 #
79 # For more information on running module instances, run Calamares in debug
80 # mode and check the Modules page in the Debug information interface.
81 #
82 # A module that is often used with instances is shellprocess, which will
83 # run shell commands specified in the configuration file. By configuring
84 # more than one instance of the module, multiple shell sessions can be run
85 # during install.
86 #
87 # YAML: list of maps of string:string key-value pairs.
88 #instances:
89 #- id:       owncloud
90 #  module:   webview
91 #  config:   owncloud.conf
92
93 # Sequence section. This section describes the sequence of modules, both
94 # viewmodules and jobmodules, as they should appear and/or run.
95 #
96 # A jobmodule instance key (or name) can only appear in an exec phase, whereas
97 # a viewmodule instance key (or name) can appear in both exec and show phases.
98 # There is no limit to the number of show or exec phases. However, the same
99 # module instance key should not appear more than once per phase, and
100 # deployers should take notice that the global storage structure is persistent
101 # throughout the application lifetime, possibly influencing behavior across
102 # phases. A show phase defines a sequence of viewmodules (and therefore
103 # pages). These viewmodules can offer up jobs for the execution queue.
104 #
105 # An exec phase displays a progress page (with brandable slideshow). This
106 # progress page iterates over the modules listed in the *immediately
107 # preceding* show phase, and enqueues their jobs, as well as any other jobs
108 # from jobmodules, in the order defined in the current exec phase.
109 #
110 # It then executes the job queue and clears it. If a viewmodule offers up a
111 # job for execution, but the module name (or instance key) isn't listed in the
112 # immediately following exec phase, this job will not be executed.
113 #
114 # YAML: list of lists of strings.
115 sequence:
116 - show:
117   - welcome
118 #  - notesqml
119   - locale
120   - keyboard
121   - partition
122   - users
123 #  - tracking
124   - summary
125 - exec:
126 #  - dummycpp
127 #  - dummyprocess
128 #  - dummypython
129   - partition
130   - mount
131   - unpackfs
132   - machineid
133   - fstab
134   - locale
135   - keyboard
136   - localecfg
137 #  - luksbootkeyfile
138 #  - luksopenswaphookcfg
139 #  - dracutlukscfg
140 #  - plymouthcfg
141   - initcpiocfg
142   - initcpio
143   - users
144   - displaymanager
145   - networkcfg
146   - hwclock
147   - services-systemd
148 #  - dracut
149   - initramfs
150 #  - grubcfg
151   - bootloader
152   - umount
153 - show:
154 #  - webview@owncloud
155   - finished
156
157 # A branding component is a directory, either in SHARE/calamares/branding or
158 # in /etc/calamares/branding (the latter takes precedence). The directory must
159 # contain a YAML file branding.desc which may reference additional resources
160 # (such as images) as paths relative to the current directory.
161 #
162 # A branding component can also ship a QML slideshow for execution pages,
163 # along with translation files.
164 #
165 # Only the name of the branding component (directory) should be specified
166 # here, Calamares then takes care of finding it and loading the contents.
167 #
168 # YAML: string.
169 branding: default
170
171 # If this is set to true, Calamares will show an "Are you sure?" prompt right
172 # before each execution phase, i.e. at points of no return. If this is set to
173 # false, no prompt is shown. Default is false, but Calamares will complain if
174 # this is not explicitly set.
175 #
176 # YAML: boolean.
177 prompt-install: false
178
179 # If this is set to true, Calamares will execute all target environment
180 # commands in the current environment, without chroot. This setting should
181 # only be used when setting up Calamares as a post-install configuration tool,
182 # as opposed to a full operating system installer.
183 #
184 # Some official Calamares modules are not expected to function with this
185 # setting. (e.g. partitioning seems like a bad idea, since that is expected to
186 # have been done already)
187 #
188 # Default is false (for a normal installer), but Calamares will complain if
189 # this is not explicitly set.
190 #
191 # YAML: boolean.
192 dont-chroot: false
193
194 # If this is set to true, Calamares refers to itself as a "setup program"
195 # rather than an "installer". Defaults to the value of dont-chroot, but
196 # Calamares will complain if this is not explicitly set.
197 oem-setup: false
198
199 # If this is set to true, the "Cancel" button will be disabled entirely.
200 # The button is also hidden from view.
201 #
202 # This can be useful if when e.g. Calamares is used as a post-install
203 # configuration tool and you require the user to go through all the
204 # configuration steps.
205 #
206 # Default is false, but Calamares will complain if this is not explicitly set.
207 #
208 # YAML: boolean.
209 disable-cancel: false
210
211 # If this is set to true, the "Cancel" button will be disabled once
212 # you start the 'Installation', meaning there won't be a way to cancel
213 # the Installation until it has finished or installation has failed.
214 #
215 # Default is false, but Calamares will complain if this is not explicitly set.
216 #
217 # YAML: boolean.
218 disable-cancel-during-exec: false
219
220 # If this is set to true, the "Next" and "Back" button will be hidden once
221 # you start the 'Installation'.
222 #
223 # Default is false, but Calamares will complain if this is not explicitly set.
224 #
225 # YAML: boolean.
226 hide-back-and-next-during-exec: false
227
228 # If this is set to true, then once the end of the sequence has
229 # been reached, the quit (done) button is clicked automatically
230 # and Calamares will close. Default is false: the user will see
231 # that the end of installation has been reached, and that things are ok.
232 #
233 #
234 quit-at-end: false