]> www.average.org Git - loctrkd.git/blob - docs/loctrkd.conf.5
1110b4b659a15fbff4f2375ecc8b55333cbf4585
[loctrkd.git] / docs / loctrkd.conf.5
1 .TH LOCTRKD.CONF 5 2022-05-27 "LOCTRKD GPS Tracker Service" "File Formats Manual"
2
3 .SH NAME
4
5 loctrkd.conf \- Configuration file for LOCTRKD service
6
7 .SH DESCRIPTION
8
9 Services that consitute
10 .BR loctrkd (1)
11 suite read configuration data from
12 .B /etc/loctrkd\&.conf
13 .PP
14 The file in
15 .B .ini
16 format contains several service\&-specific sections and optional
17 device\&-specific sections.
18 .TP
19 .B [collector]
20 \- defines interface points of the
21 .B collector
22 daemon.
23 .TP
24 .B [wsgateway]
25 \- defines websockets listen port and optionally the location of the
26 .B .html
27 file to serve when a non-websocket request is received.
28 .TP
29 .B [storage]
30 \- defines location of
31 .BR sqlite3 (1)
32 database file where events are stored.
33 .TP
34 .B [rectifier]
35 \- defines which backend will be used.
36 .TP
37 .B [opencellid]
38 \- defines location of
39 .BR sqlite3 (1)
40 database file with cell tower coordinates and how to download it.
41 .TP
42 .B [googlemaps]
43 \- defines the location of google API access token.
44 .TP
45 .BR [termconfig] " and sections titled after terminals' IMEIs
46 \- defines parameters to be sent to configure the terminals.
47 .PP
48 Section contain the following parameters:
49 .SS [collector]
50 .TP
51 .B port
52 (integer) \- TCP port to listen for terminal connections. Default
53 .BR 4303 .
54 .TP
55 .B publishurl
56 (string) \- Zeromq "pub" socket where events are published. Default
57 .BR ipc:///var/lib/loctrkd/collected .
58 .TP
59 .B listenurl
60 (string) \- Zeromq "pull" socket for messages to be sent to the terminal.
61 Default
62 .BR ipc:///var/lib/loctrkd/responses .
63 .SS [wsgateway]
64 .TP
65 .B port
66 (integer) \- TCP port to listen for websocket connections. Default
67 .BR 5049 .
68 .TP
69 .B htmlfile
70 (string) \- path to the
71 .B .html
72 file to be served for
73 .IR non "-websocket requests. Default
74 .BR /var/lib/loctrkd/index.html .
75 .SS [storage]
76 .TP
77 .B dbfn
78 (string) \- location of the database file where events are stored.
79 .SS [lookaside]
80 .TP
81 .B backend
82 (string) \- either
83 .B opencellid
84 or
85 .B googlemaps
86 to select which location service to use. Googlemaps is a realtime service,
87 which means that you are sending location of your clients to Google.
88 Opencellid resolves location against a local database of cell towers, that
89 can be updated from time to time (e.g. once in a week or in a month).
90 This source does not contain WiFi access point locations, and therefore
91 may be less accurate. Default
92 .BR opencellid .
93 .SS [opencellid]
94 .TP
95 .B dbfn
96 (string) \- location of the database file with cell tower locations.
97 Default
98 .BR /var/lib/opencellid/opencellid.sqlite .
99 .TP
100 .B downloadtoken
101 (string) \- location of the file that contains opencellid authentication
102 token. Default
103 .BR /var/lib/opencellid/opencellid.token .
104 .TP
105 .B downloadmcc
106 (number or string) \- MCC of the region, or string "all" for the whole world.
107 Please set correct value for your country.
108 .TP
109 .B downloadurl
110 (string) \- if specified, download the file (that must be
111 .BR .csv.gz )
112 from this URL instead of the official opencellid.org site.
113 .B downloadtoken
114 and
115 .B downloadmcc
116 are ignored when
117 .B downloadurl
118 is specified.
119 .SS [termconfig] and sections with numeric name
120 .TP
121 .B statusIntervalMinutes
122 (integer) \- terminal will report status this often. Default
123 .BR 25 .
124 .TP
125 .B uploadIntervalSeconds
126 (integer) \- terminal will report location this often. Default
127 .BR 0x0300 .
128 .TP
129 .B binarySwitch
130 (integer) \- see protocol description document. Note that all integer values
131 can be specified in decimal, hexadecimal, octal, or binary base. Binary
132 is useful for this value in particular. Default
133 .BR 0b00110001 .
134 .TP
135 .B alarms
136 (list of 3 elements) \- this value must be specified as three continuation
137 lines, with time in HHMM (four digit) format.
138 .TP
139 .B dndTimeSwitch
140 (0 or 1) \- enable or not enable "do not disturb" intervals. Default
141 .BR 0 .
142 .TP dndTimes
143 (list of 3 elements) \- three continuation lines with time intervals
144 in HHMMHHMM (start \- end) format.
145 .TP
146 .B gpsTimeSwitch
147 (0 or 1) \- enable or not enable location upload time interval.
148 .TP
149 .B gpsTimeStart
150 (HHMM) \- start of the interval to upload locations.
151 .TP
152 .B gpsTimeStop
153 (HHMM) \- end of the interval to upload locations.
154 .TP
155 .B phoneNumbers
156 (list of three elements) \- three
157 .I strings in quotes
158 as three continuation lines, with three phone numbers that the terminal
159 will use for various reports and calls.
160
161 .PP
162 .B [termconfig]
163 section is used as a default fallback for terminals that have no section
164 in the configuration file named according to their IMEI.
165
166 .SH KNOWN BUGS
167
168 Keeping configuration for the terminals in this file is suboptimal,
169 and is suitable only for very small installations with one or few
170 served tracker terminals.
171
172 .SH COPYRIGHT
173
174 The program is copyrighted by Eugene G. Crosser <crosser@average.org>
175 and freely distributable under the terms of MIT license.
176
177 .SH CREDITS
178
179 The program is inspired by the project petGPS by Thomas Obadia
180
181 .SH SEE ALSO
182
183 .BR loctrkd (1)