mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 01:36:23 +00:00
cf44acda27
* Add recipe for searxng Signed-off-by: David Young <davidy@funkypenguin.co.nz> * Fussy linter Signed-off-by: David Young <davidy@funkypenguin.co.nz> --------- Signed-off-by: David Young <davidy@funkypenguin.co.nz>
107 lines
3.3 KiB
Markdown
107 lines
3.3 KiB
Markdown
---
|
|
title: Run OwnTracks under Docker
|
|
recipe: OwnTracks
|
|
---
|
|
|
|
# OwnTracks
|
|
|
|
[OwnTracks](https://owntracks.org/) allows you to keep track of your own location. You can build your private location diary or share it with your family and friends. OwnTracks is open-source and uses open protocols for communication so you can be sure your data stays secure and private.
|
|
|
|
{ loading=lazy }
|
|
|
|
Using a smartphone app, OwnTracks allows you to collect and analyse your own location data **without** sharing this data with a cloud provider (_i.e. Apple, Google_). Potential use cases are:
|
|
|
|
* Sharing family locations without relying on Apple Find-My-friends
|
|
* Performing automated actions in [HomeAssistant](/recipes/homeassistant/) when you arrive/leave home
|
|
|
|
## {{ page.meta.recipe }} Requirements
|
|
|
|
--8<-- "recipe-standard-ingredients.md"
|
|
|
|
## Preparation
|
|
|
|
### Setup data locations
|
|
|
|
We'll need a directory so store OwnTracks' data , so create ```/var/data/owntracks```:
|
|
|
|
```bash
|
|
mkdir /var/data/owntracks
|
|
```
|
|
|
|
### Prepare {{ page.meta.recipe }} environment
|
|
|
|
Create owntracks.env, and populate with the following variables
|
|
|
|
```bash
|
|
OTR_USER=recorder
|
|
OTR_PASS=yourpassword
|
|
OTR_HOST=owntracks.example.com
|
|
```
|
|
|
|
### {{ page.meta.recipe }} Docker Swarm config
|
|
|
|
Create a docker swarm config file in docker-compose syntax (v3), something like the example below:
|
|
|
|
--8<-- "premix-cta.md"
|
|
|
|
```yaml
|
|
version: "3.0"
|
|
|
|
services:
|
|
owntracks-app:
|
|
image: funkypenguin/owntracks
|
|
env_file : /var/data/config/owntracks/owntracks.env
|
|
volumes:
|
|
- /var/data/owntracks:/owntracks
|
|
networks:
|
|
- internal
|
|
- traefik_public
|
|
ports:
|
|
- 1883:1883
|
|
- 8883:8883
|
|
- 8083:8083
|
|
deploy:
|
|
labels:
|
|
# traefik common
|
|
- traefik.enable=true
|
|
- traefik.docker.network=traefik_public
|
|
|
|
# traefikv1
|
|
- traefik.frontend.rule=Host:owntracks-app.example.com
|
|
- traefik.port=8083
|
|
|
|
# traefikv2
|
|
- "traefik.http.routers.owntracks.rule=Host(`owntracks-app.example.com`)"
|
|
- "traefik.http.services.owntracks.loadbalancer.server.port=8083"
|
|
- "traefik.enable=true"
|
|
|
|
# Remove if you wish to access the URL directly
|
|
- "traefik.http.routers.owntracks.middlewares=forward-auth@file"
|
|
|
|
|
|
networks:
|
|
traefik_public:
|
|
external: true
|
|
internal:
|
|
driver: overlay
|
|
ipam:
|
|
config:
|
|
- subnet: 172.16.15.0/24
|
|
```
|
|
|
|
--8<-- "reference-networks.md"
|
|
|
|
## Serving
|
|
|
|
### Launch OwnTracks stack
|
|
|
|
Launch the OwnTracks stack by running ```docker stack deploy owntracks -c <path -to-docker-compose.yml>```
|
|
|
|
Log into your new instance at https://**YOUR-FQDN**, with user "root" and the password you specified in gitlab.env.
|
|
|
|
[^1]: If you wanted to expose the Owntracks UI directly, you could remove the traefik-forward-auth from the design.
|
|
[^2]: I'm using my own image rather than owntracks/recorderd, because of a [potentially swarm-breaking bug](https://github.com/owntracks/recorderd/issues/14) I found in the official container. If this gets resolved (_or if I was mistaken_) I'll update the recipe accordingly.
|
|
[^3]: By default, you'll get a fully accessible, unprotected MQTT broker. This may not be suitable for public exposure, so you'll want to look into securing mosquitto with TLS and ACLs.
|
|
|
|
--8<-- "recipe-footer.md"
|