Warning, /plasma-bigscreen/calamares-bigscreen-branding/sample-settings/settings.conf is written in an unsupported language. File is not indexed.
0001 # SPDX-FileCopyrightText: no 0002 # SPDX-License-Identifier: CC0-1.0 0003 # 0004 # Configuration file for Calamares 0005 # 0006 # This is the top-level configuration file for Calamares. 0007 # It specifies what modules will be used, as well as some 0008 # overall characteristics -- is this a setup program, or 0009 # an installer. More specific configuration is devolved 0010 # to the branding file (for the UI) and the individual 0011 # module configuration files (for functionality). 0012 --- 0013 # Modules can be job modules (with different interfaces) and QtWidgets view 0014 # modules. They could all be placed in a number of different paths. 0015 # "modules-search" is a list of strings, each of these can either be a full 0016 # path to a directory or the keyword "local". 0017 # 0018 # "local" means: 0019 # - modules in $LIBDIR/calamares/modules, with 0020 # - settings in SHARE/calamares/modules or /etc/calamares/modules. 0021 # In debug-mode (e.g. calamares -d) "local" also adds some paths 0022 # that make sense from inside the build-directory, so that you 0023 # can build-and-run with the latest modules immediately. 0024 # 0025 # Strings other than "local" are taken as paths and interpreted 0026 # relative to wherever Calamares is started. It is therefore **strongly** 0027 # recommended to use only absolute paths here. This is mostly useful 0028 # if your distro has forks of standard Calamares modules, but also 0029 # uses some form of upstream packaging which might overwrite those 0030 # forked modules -- then you can keep modules somewhere outside of 0031 # the "regular" module tree. 0032 # 0033 # 0034 # YAML: list of strings. 0035 modules-search: [ local ] 0036 0037 # Instances section. This section is optional, and it defines custom instances 0038 # for modules of any kind. An instance entry has these keys: 0039 # - *module* name, which matches the module name from the module descriptor 0040 # (usually the name of the directory under `src/modules/`, but third- 0041 # party modules may diverge. 0042 # - *id* (optional) an identifier to distinguish this instance from 0043 # all the others. If none is given, the name of the module is used. 0044 # Together, the module and id form an instance key (see below). 0045 # - *config* (optional) a filename for the configuration. If none is 0046 # given, *module*`.conf` is used (e.g. `welcome.conf` for the welcome 0047 # module) 0048 # - *weight* (optional) In the *exec* phase of the sequence, progress 0049 # is reported as jobs are completed. The jobs from a single module 0050 # together contribute the full weight of that module. The overall 0051 # progress (0 .. 100%) is divided up according to the weight of each 0052 # module. Give modules that take a lot of time to complete, a larger 0053 # weight to keep the overall progress moving along steadily. This 0054 # weight overrides a weight given in the module descriptor. If no weight 0055 # is given, uses the value from the module descriptor, or 1 if there 0056 # isn't one there either. 0057 # 0058 # The primary goal of this mechanism is to allow loading multiple instances 0059 # of the same module, with different configuration. If you don't need this, 0060 # the instances section can safely be left empty. 0061 # 0062 # Module name plus instance name makes an instance key, e.g. 0063 # "webview@owncloud", where "webview" is the module name (for the webview 0064 # viewmodule) and "owncloud" is the instance name. In the *sequence* 0065 # section below, use instance-keys to name instances (instead of just 0066 # a module name, for modules which have only a single instance). 0067 # 0068 # Every module implicitly has an instance with the instance name equal 0069 # to its module name, e.g. "welcome@welcome". In the *sequence* section, 0070 # mentioning a module without a full instance key (e.g. "welcome") 0071 # means that implicit module. 0072 # 0073 # An instance may specify its configuration file (e.g. `webview-home.conf`). 0074 # The implicit instances all have configuration files named `<module>.conf`. 0075 # This (implict) way matches the source examples, where the welcome 0076 # module contains an example `welcome.conf`. Specify a *config* for 0077 # any module (also implicit instances) to change which file is used. 0078 # 0079 # For more information on running module instances, run Calamares in debug 0080 # mode and check the Modules page in the Debug information interface. 0081 # 0082 # A module that is often used with instances is shellprocess, which will 0083 # run shell commands specified in the configuration file. By configuring 0084 # more than one instance of the module, multiple shell sessions can be run 0085 # during install. 0086 # 0087 # YAML: list of maps of string:string key-value pairs. 0088 #instances: 0089 #- id: owncloud 0090 # module: webview 0091 # config: owncloud.conf 0092 0093 # Sequence section. This section describes the sequence of modules, both 0094 # viewmodules and jobmodules, as they should appear and/or run. 0095 # 0096 # A jobmodule instance key (or name) can only appear in an exec phase, whereas 0097 # a viewmodule instance key (or name) can appear in both exec and show phases. 0098 # There is no limit to the number of show or exec phases. However, the same 0099 # module instance key should not appear more than once per phase, and 0100 # deployers should take notice that the global storage structure is persistent 0101 # throughout the application lifetime, possibly influencing behavior across 0102 # phases. A show phase defines a sequence of viewmodules (and therefore 0103 # pages). These viewmodules can offer up jobs for the execution queue. 0104 # 0105 # An exec phase displays a progress page (with brandable slideshow). This 0106 # progress page iterates over the modules listed in the *immediately 0107 # preceding* show phase, and enqueues their jobs, as well as any other jobs 0108 # from jobmodules, in the order defined in the current exec phase. 0109 # 0110 # It then executes the job queue and clears it. If a viewmodule offers up a 0111 # job for execution, but the module name (or instance key) isn't listed in the 0112 # immediately following exec phase, this job will not be executed. 0113 # 0114 # YAML: list of lists of strings. 0115 sequence: 0116 - show: 0117 - welcomeq 0118 # - notesqml 0119 - localeq 0120 - keyboardq 0121 - partition 0122 - users 0123 # - tracking 0124 - summary 0125 - exec: 0126 # - dummycpp 0127 # - dummyprocess 0128 # - dummypython 0129 - partition 0130 # - zfs 0131 - mount 0132 - unpackfs 0133 - machineid 0134 - fstab 0135 - locale 0136 - keyboard 0137 - localecfg 0138 # - luksbootkeyfile 0139 # - luksopenswaphookcfg 0140 # - dracutlukscfg 0141 # - plymouthcfg 0142 - initcpiocfg 0143 - initcpio 0144 - users 0145 - displaymanager 0146 - networkcfg 0147 - hwclock 0148 - services-systemd 0149 # - dracut 0150 - initramfs 0151 # - grubcfg 0152 - bootloader 0153 - umount 0154 - show: 0155 # - webview@owncloud 0156 - finished 0157 0158 # A branding component is a directory, either in SHARE/calamares/branding or 0159 # in /etc/calamares/branding (the latter takes precedence). The directory must 0160 # contain a YAML file branding.desc which may reference additional resources 0161 # (such as images) as paths relative to the current directory. 0162 # 0163 # A branding component can also ship a QML slideshow for execution pages, 0164 # along with translation files. 0165 # 0166 # Only the name of the branding component (directory) should be specified 0167 # here, Calamares then takes care of finding it and loading the contents. 0168 # 0169 # YAML: string. 0170 branding: bigscreen 0171 0172 # If this is set to true, Calamares will show an "Are you sure?" prompt right 0173 # before each execution phase, i.e. at points of no return. If this is set to 0174 # false, no prompt is shown. Default is false, but Calamares will complain if 0175 # this is not explicitly set. 0176 # 0177 # YAML: boolean. 0178 prompt-install: false 0179 0180 # If this is set to true, Calamares will execute all target environment 0181 # commands in the current environment, without chroot. This setting should 0182 # only be used when setting up Calamares as a post-install configuration tool, 0183 # as opposed to a full operating system installer. 0184 # 0185 # Some official Calamares modules are not expected to function with this 0186 # setting. (e.g. partitioning seems like a bad idea, since that is expected to 0187 # have been done already) 0188 # 0189 # Default is false (for a normal installer), but Calamares will complain if 0190 # this is not explicitly set. 0191 # 0192 # YAML: boolean. 0193 dont-chroot: false 0194 0195 # If this is set to true, Calamares refers to itself as a "setup program" 0196 # rather than an "installer". Defaults to the value of dont-chroot, but 0197 # Calamares will complain if this is not explicitly set. 0198 oem-setup: false 0199 0200 # If this is set to true, the "Cancel" button will be disabled entirely. 0201 # The button is also hidden from view. 0202 # 0203 # This can be useful if when e.g. Calamares is used as a post-install 0204 # configuration tool and you require the user to go through all the 0205 # configuration steps. 0206 # 0207 # Default is false, but Calamares will complain if this is not explicitly set. 0208 # 0209 # YAML: boolean. 0210 disable-cancel: false 0211 0212 # If this is set to true, the "Cancel" button will be disabled once 0213 # you start the 'Installation', meaning there won't be a way to cancel 0214 # the Installation until it has finished or installation has failed. 0215 # 0216 # Default is false, but Calamares will complain if this is not explicitly set. 0217 # 0218 # YAML: boolean. 0219 disable-cancel-during-exec: false 0220 0221 # If this is set to true, the "Next" and "Back" button will be hidden once 0222 # you start the 'Installation'. 0223 # 0224 # Default is false, but Calamares will complain if this is not explicitly set. 0225 # 0226 # YAML: boolean. 0227 hide-back-and-next-during-exec: false 0228 0229 # If this is set to true, then once the end of the sequence has 0230 # been reached, the quit (done) button is clicked automatically 0231 # and Calamares will close. Default is false: the user will see 0232 # that the end of installation has been reached, and that things are ok. 0233 # 0234 # 0235 quit-at-end: false