gps-cli/.env.sample at main · alexcolls/gps-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# GPS CLI Configuration Sample
# Copy this to ~/.config/gps-cli/.env and configure as needed

# ============================================
# GPS Provider Selection
# ============================================
# Options: traccar, owntracks, phonetrack, gpslogger
GPS_PROVIDER=traccar

# ============================================
# Traccar Configuration (Recommended)
# ============================================
# Use FREE demo server or your own Traccar instance
TRACCAR_SERVER=https://demo2.traccar.org
TRACCAR_PORT=5055
TRACCAR_DEVICE_ID=auto  # Will be auto-generated
TRACCAR_TOKEN=

# ============================================
# OwnTracks Configuration
# ============================================
# Requires self-hosted MQTT broker or HTTP endpoint
OWNTRACKS_ENDPOINT=http://your-server.com/owntracks/endpoint
OWNTRACKS_USERNAME=
OWNTRACKS_PASSWORD=

# ============================================
# PhoneTrack Configuration
# ============================================
# Requires Nextcloud instance with PhoneTrack app
PHONETRACK_URL=https://your-nextcloud.com
PHONETRACK_SESSION=your-session-token
PHONETRACK_DEVICE=your-device-name

# ============================================
# GPSLogger Configuration
# ============================================
# Custom HTTP endpoint for maximum flexibility
GPSLOGGER_ENDPOINT=https://your-api.com/gps/update
GPSLOGGER_AUTH=Bearer your-api-token-here

# ============================================
# Tracking Settings
# ============================================
# Update interval in seconds (default: 60 = 1 minute)
UPDATE_INTERVAL=60

# GPS Source: auto, ip, hardware
# auto = try hardware first, fallback to IP
# ip = use IP geolocation only
# hardware = use GPS hardware only (requires gpsd)
GPS_SOURCE=auto

# ============================================
# IP Geolocation API
# ============================================
# Primary provider for IP-based location
# Options: ipapi.co, ip-api.com
IP_API_PROVIDER=ipapi.co

# ============================================
# Logging Configuration
# ============================================
# Log level: debug, info, warning, error
LOG_LEVEL=info

# Log file location
LOG_FILE=~/.config/gps-cli/gps.log

# ============================================
# Notes
# ============================================
# • For Traccar: Use demo2.traccar.org for testing (FREE)
# • For OwnTracks: Requires own MQTT broker (Mosquitto)
# • For PhoneTrack: Requires Nextcloud + PhoneTrack app
# • For GPSLogger: Any HTTP endpoint that accepts POST requests
#
# IP Geolocation is approximate (city-level accuracy)
# For precise tracking, use GPS hardware with gpsd