1GEOCLUE CONFIGURATION(5) File Formats Manual GEOCLUE CONFIGURATION(5)
2
6 geoclue.conf - geoclue configuration parameters
7
9 Main configuration file: /etc/geoclue/geoclue.conf
10 Overwriting parameters files: /etc/geoclue/conf.d
11
13 The main GeoClue configuration file 'geoclue.conf' specifies parameters
14 that control the operation of geoclue. Parameters can be overwritten by
15 placing configuration files in conf.d directory and applied in alpha‐
16 betic order. Thus, a configuration file '90-config.conf' will overwrite
17 parameters specified in another configuration file '50-config.conf' in
18 the conf.d directory.
19 All configurations settings below are mandatory and the defaults are
21 what you see before you edit them in geoclue.conf. If you want to keep
22 the default values around, copy and comment out the appropriate line(s)
23 before changing them.
24 Missing 'enable' key for a particular source in the main configuration
26 file causes that source to be enabled by default. Adding 'enable' key
27 setting to any further config file can overwrite this default.
28
30 [agent] is used to begin the agent configuration.
31 whitelist
33 Whitelist of desktop IDs (without .desktop part) of all agents
34 we recognise, separated by a ';'.
35 whitelist=geoclue-demo-agent;gnome-shell;io.elementary.desk‐
37 top.agent-geoclue2
38 [network-nmea]
40 Network NMEA source configuration options
41 enable=true
43 Fetch location from NMEA sources on local network?
44 nmea-socket=/var/run/gps-share.sock
46 Use a nmea unix socket as the data source. If not set, unix
47 socket will not be used.
48 [3g]
50 3G source configuration options
51 enable=true
53 Enable 3G source
54 [cdma]
56 CDMA source configuration options
57 enable=true
59 Enable CDMA source
60 [modem-gps]
62 Modem GPS source configuration options
63 enable=true
65 Enable Modem-GPS source
66 [wifi]
68 WiFi source configuration options
69 enable=true
71 Enable WiFi source
72 url=https://location.services.mozilla.com/v1/geolo‐
74 cate?key=YOUR_KEY
75 URL to the WiFi geolocation service. If not set, defaults to
76 Mozilla's Location Service with a hardcoded key. To use a custom
77 key, uncomment this URL while changing YOUR_KEY to your MLS API
78 key.
79 submit-data=false Submit data to Mozilla Location Service
81 If set to true, geoclue will automatically submit network data
82 to Mozilla each time it gets a GPS lock.
83 submission-url=https://location.services.mozilla.com/v2/geosub‐
85 mit?key=YOUR_KEY
86 URL to submission API of Mozilla Location Service
87 submission-nick=geoclue
89 A nickname to submit network data with. A nickname must be 2-32
90 characters long.
91 [compass]
93 Compass configuration options
94 enable=true
96 Enable Compass
97 [static-source]
99 Static source configuration options.
100 This source reads location from "geolocation" file in /etc.
101 While this file is constantly monitored for changes during geo‐
102 clue operation, and the reported static location is updated ac‐
103 cordingly, this source isn't meant for inputting a dynamically
104 changing location to geoclue (please use the Network NMEA source
105 for that).
106 enable=true
108 Enable the static source.
109 If you make use of this source, you probably should disable
110 other location sources in geoclue.conf so they won't override
111 the configured static location.
112
114 Having an entry here for an application with allowed=true means that
115 geoclue will not ask agent to authorize the application. This is to en‐
116 sure that applications with built-in authorization mechanism (e.g web
117 browsers) do not have to be bound to agents.
118 If your application is denied access to location information and your
120 operating system doesn't provide any mechanism to change that, it is
121 likely a bug in your operation system (or geoclue). The solution is to
122 report the issue with all details, rather than adding your application
123 to this list.
124 Format:
126 [random-app]
127 Desktop ID of application without .desktop part
128 allowed=true|false
130 Allowed access to location information?
131 system=true|false
133 Is application a system component?
134 users=
136 List of UIDs of all users for which this application is allowed
137 location info access, separate by ';'. Keep it empty for allow‐
138 ing it for all users.
139 Examples:
141 [gnome-datetime-panel]
142 allowed=true
143 system=true
144 users=
145 [gnome-color-panel]
147 allowed=true
148 system=true
149 users=
150 [org.gnome.Shell]
152 allowed=true
153 system=true
154 users=
155 [io.elementary.desktop.agent-geoclue2]
157 allowed=true
158 system=true
159 users=
160 [epiphany]
162 allowed=true
163 system=false
164 users=
165 [firefox]
167 allowed=true
168 system=false
169 users=
170
172 Basic format:
173 The static location file in /etc (used by the static source) is a text
174 file consisting of the following:
175 1 Latitude (floating point number; positive values mean north,
177 negative south)
178 2 Longitude (floating point number; positive values mean east,
180 negative west)
181 3 Altitude (floating point number; in meters)
183 4 Accuracy radius (floating point number; in meters)
185 These values need to be separated by newline characters.
187 Additional format information:
189 • The '#' character starts a comment, which continues until the
190 end of the current line.
191 • Leading and trailing white-space on each line is ignored.
193 • Empty lines (or containing just white-space or a comment) are
195 ignored.
196 Example:
198 # Example static location file for a machine inside Statue of Liberty torch
199 40.6893129 # latitude
201 -74.0445531 # longitude
202 96 # altitude
203 1.83 # accuracy radius (the diameter of the torch is 12 feet)
204 Notes:
206 For extra security, the static location file can be made readable just
207 by the geoclue user:
208 # chown geoclue /etc/geolocation
209 # chmod 600 /etc/geolocation
210
212 Sachin Chand
213 GEOCLUE CONFIGURATION(5)