napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[tracking] expand documentation of configuration

Browse Source
This commit is contained in:
Adriaan de Groot 2020-06-17 14:52:48 +02:00
parent 3f55d415e9
commit 98ab4330c4
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/modules/tracking/tracking.conf
View File

@ -28,7 +28,7 @@
# policy applies. # policy applies.
# #
# Each area has a key *enabled*. If the area is enabled, it is shown to # Each area has a key *enabled*. If the area is enabled, it is shown to
# the user. This defaults to off, which means no tracking would be # the user. This defaults to false, which means no tracking would be
# configured or enabled by Calamares. # configured or enabled by Calamares.
# #
# Each area has a key *policy*, which is a Url to be opened when # Each area has a key *policy*, which is a Url to be opened when
@ -53,9 +53,11 @@
# page. You **must** provide policy links per-area as well. # page. You **must** provide policy links per-area as well.
policy: "https://github.com/calamares/calamares/wiki/Use-Guide#installation-tracking" policy: "https://github.com/calamares/calamares/wiki/Use-Guide#installation-tracking"
# This is the default level to enable for tracking. If commented out, # This is the default area to enable for tracking. If commented out,
# empty, or otherwise invalid, "none" is used, so no tracking by default. # empty, or otherwise invalid, "none" is used, so no tracking by default.
default: user # Setting an area here also checks the areas before it (install, machine,
# then user) by default -- subject to those areas being enabled at all.
# default: user
# The install area has one specific configuration key: # The install area has one specific configuration key:
# url: this URL (remember to include the protocol, and prefer https) # url: this URL (remember to include the protocol, and prefer https)
@ -73,22 +75,28 @@ default: user
install: install:
enabled: false enabled: false
policy: "https://github.com/calamares/calamares/wiki/Use-Guide#installation-tracking" policy: "https://github.com/calamares/calamares/wiki/Use-Guide#installation-tracking"
# url: "https://example.com/install.php?c=$CPU&m=$MEMORY" url: "https://example.com/install.php?c=$CPU&m=$MEMORY"
# The machine area has one specific configuration key: # The machine area has one specific configuration key:
# style: This string specifies what kind of tracking configuration # style: This string specifies what kind of tracking configuration
# needs to be done. There is currently only one valid # needs to be done. See below for valid styles.
# style, "updatemanager", which edits two files in the installed
# system to enable system-tracking.
# #
# Per-style documentation: # Available styles:
# - updatemanager replaces the literal string "${MACHINE_ID}" with the contents of # - *updatemanager* replaces the literal string "${MACHINE_ID}" with the contents of
# /etc/machine-id, in lines starting with "URI" in the file /etc/update-manager/meta-release # /etc/machine-id, in lines starting with "URI" in the file /etc/update-manager/meta-release
machine: machine:
enabled: false enabled: false
style: updatemanager style: updatemanager
policy: "https://github.com/calamares/calamares/wiki/Use-Guide#machine-tracking" policy: "https://github.com/calamares/calamares/wiki/Use-Guide#machine-tracking"
# The user area is not yet implemented, and has no specific configuration. # The user area has one specific configuration key:
# style: This string specifies what kind of tracking configuration
# needs to be done. See below for valid styles.
#
# Available styles:
# - *kuserfeedback* sets up KUserFeedback tracking (applicable to the KDE
# Plasma Desktop) for each KUserFeedback area listed in *areas*.
user: user:
enabled: false enabled: false
style: kuserfeedback
areas: [ PlasmaUserFeedback ]