source: calamares/trunk/fuentes/src/modules/tracking/tracking.conf @ 7538

Last change on this file since 7538 was 7538, checked in by kbut, 13 months ago

sync with github

File size: 3.9 KB
Line 
1# Settings for various kinds of tracking that Distributions can
2# enable. Distributions looking at tracking should be aware of
3# the privacy (and hence communications) impact of that tracking,
4# and are advised to consult the Mozilla and KDE policies on
5# privacy and user tracking.
6#
7# There are three areas of tracking (-configuration) supported
8# by Calamares It is up to individual Distributions to create
9# suitable backends / configuration scripts for each. The
10# different areas are:
11#
12# install:  This is "phone home" functionality at the end of the
13#           install process. When enabled, it contacts the given
14#           URL. The URL can contain the special token $MACHINE,
15#           which is replaced by the machine-id of the installed
16#           system (if available, blank otherwise).
17#
18# machine:  This enables machine-level tracking on a (semi-)
19#           continuous basis. It is meant to keep track of installed
20#           systems and their continued use / updating.
21#
22# user:     This area enables user-level tracking, along the lines
23#           of the KDE User Telemetry Policy. It enables specific
24#           collection of data at a user- and application-level,
25#           possibly including actions done in an application.
26#           For the KDE environment, this enables user tracking
27#           with the appropriate framework, and the KDE User Telemetry
28#           policy applies.
29#
30# Each area has a key *enabled*. If the area is enabled, it is shown to
31# the user. This defaults to off, which means no tracking would be
32# configured or enabled by Calamares.
33#
34# Each area has a key *policy*, which is a Url to be opened when
35# the user clicks on the corresponding Help button for an explanation
36# of the details of that particular kind of tracking. If no policy
37# is set, the help button is hidden. The example policy links
38# go to Calamares' generic user manual.
39#
40# Each area may have other configuration keys, depending on the
41# area and how it needs to be configured.
42#
43# Globally, there are two other keys:
44#
45# policy:   (optional) url about tracking settings for this distro.
46# default:  (optional) level to enable by default
47#
48---
49# This is the global policy; it is displayed as a link on the page.
50# If blank or commented out, no link is displayed on the tracking
51# page. It is recommended to either provide policy URLs for each
52# area, *or* one general link, and not to mix them.
53policy:  "https://github.com/calamares/calamares/wiki/Users-Guide#installation-tracking"
54
55# This is the default level to enable for tracking. If commented out,
56# empty, or otherwise invalid, "none" is used, so no tracking by default.
57default:    user
58
59# The install area has one specific configuration key:
60#   url:    this URL (remember to include the protocol, and prefer https)
61#           is fetched (with a GET request, and the data discarded) at
62#           the end of the installation process. The following tokens
63#           are replaced in the url (possibly by blank strings, or by 0).
64#               - $CPU (cpu make and model)
65#               - $MEMORY (amount of main memory available)
66#               - $DISK (total amount of disk attached)
67#           Typically these are used as GET parameters, as in the example.
68#
69# Note that phone-home only works if the system has an internet
70# connection; it is a good idea to require internet in the welcome
71# module then.
72install:
73    enabled: false
74    policy:  "https://github.com/calamares/calamares/wiki/Users-Guide#installation-tracking"
75    # url:     "https://example.com/install.php?c=$CPU&m=$MEMORY"
76
77# The machine area has one specific configuration key:
78#   style:  This string specifies what kind of tracking configuration
79#           needs to be done. There is currently only one valid
80#           style, "neon", which edits two files in the installed
81#           system to enable system-tracking.
82machine:
83    enabled: false
84    style: neon
85
86# The user area is not yet implemented, and has no specific configuration.
87user:
88    enabled: false
Note: See TracBrowser for help on using the repository browser.