https://github.com/jannickfahlbusch/carstatsviewer-exporter
https://github.com/jannickfahlbusch/carstatsviewer-exporter
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jannickfahlbusch/carstatsviewer-exporter
- Owner: jannickfahlbusch
- License: mit
- Created: 2023-03-10T20:34:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T18:50:02.000Z (over 1 year ago)
- Last Synced: 2025-01-23T12:13:05.909Z (5 months ago)
- Language: Go
- Size: 53.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CarStatsViewer-Exporter
# Running
To locally run the exporter you need to run the following:
```bash
go run cmd/carstatsviewer-exporter/main.go
```
By default, the exporter will listen on `:8080`.
You can customize this by specifying `-listen-address`.
Alternatively you can run the exporter using Docker via:
```bash
docker build -t carstatsviewer-exporter .
docker run -p 8080:8080 carstatsviewer-exporter
```
# Endpoints
The metrics are available under the `/metrics` endpoint.
Additionally, the `/data` endpoint serves the last received payload (If any).
Live data needs to be POSTed to `/live`. There is currently no security in place. Use this exporter only for experiments to play around with the HTTP live data PoC (See [Ixam97/CarStatsViewer#139](https://github.com/Ixam97/CarStatsViewer/pull/139)) of the [CarStatsViewer](https://github.com/Ixam97/CarStatsViewer).
# Owntracks Integration
The exporter is able to forward the received coordinates to an Owntracks instance via HTTP.
To enable the integration, specify `-owntracks-url`.
Customization of the user or device is possible via `-owntracks-user` and `-owntracks-device`