geek-cookbook/docs/recipes/owntracks.md

title

title
Run OwnTracks under Docker

OwnTracks

OwnTracks 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 when you arrive/leave home

--8<-- "recipe-standard-ingredients.md"

Preparation

Setup data locations

We'll need a directory so store OwnTracks' data , so create /var/data/owntracks:

mkdir /var/data/owntracks

Prepare environment

Create owntracks.env, and populate with the following variables

OTR_USER=recorder
OTR_PASS=yourpassword
OTR_HOST=owntracks.example.com

Setup Docker Swarm

Create a docker swarm config file in docker-compose syntax (v3), something like this:

--8<-- "premix-cta.md"

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.

--8<-- "recipe-footer.md"