Dawarich

Stack

Self-Hosted Location History Tracker. | Visualize your location history, track your movements, and analyze your travel patterns with complete privacy and control.

Configuration

Type

Compose

Platform

linux

Source

Repo

Template by xneo1·Source

Services

dawarich_redis

Configuration

Image

redis:7.0-alpine

Command

redis-server

Volumes

/data : /portainer/Files/AppData/Config/dawarich/shared

Restart

always

Image details

Pulls: 11.1B

User: stackbrew

Created: Jun 05, 2014

Updated: 9 days ago

Status: active

dawarich_db

Configuration

Image

postgis/postgis:17-3.5-alpine

Volumes

/var/lib/postgresql/data : /portainer/Files/AppData/Config/dawarich/dawarich_db_data/var/shared : /portainer/Files/AppData/Config/dawarich/shared

Env vars

POSTGRES_USER=postgresPOSTGRES_PASSWORD=password

Restart

always

Image details

Pulls: 302.1M

User: postgis

Created: Feb 18, 2020

Updated: 5 days ago

Status: active

dawarich_app

Configuration

Image

freikin/dawarich:latest

Command

bin/rails,server,-p,3000,-b,::

Entrypoint

web-entrypoint.sh

Ports

3000:3000

Volumes

/var/app/public : /portainer/Files/AppData/Config/dawarich/public/var/app/tmp/imports/watched : /portainer/Files/AppData/Config/dawarich/watched/var/app/storage : /portainer/Files/AppData/Config/dawarich/storage

Env vars

RAILS_ENV=developmentREDIS_URL=redis://dawarich_redis:6379/0DATABASE_HOST=dawarich_dbDATABASE_USERNAME=postgresDATABASE_PASSWORD=passwordDATABASE_NAME=dawarich_developmentMIN_MINUTES_SPENT_IN_CITY=60APPLICATION_HOSTS=localhostTIME_ZONE=Europe/AthensAPPLICATION_PROTOCOL=httpDISTANCE_UNIT=kmPROMETHEUS_EXPORTER_ENABLED=falsePROMETHEUS_EXPORTER_HOST=0.0.0.0PROMETHEUS_EXPORTER_PORT=9394SELF_HOSTED=true

Restart

on-failure

Image details

Pulls: 6.9M

User: freikin

Created: Mar 24, 2024

Updated: 12 hours ago

Status: active

dawarich_sidekiq

Configuration

Image

freikin/dawarich:latest

Command

sidekiq

Entrypoint

sidekiq-entrypoint.sh

Volumes

Env vars

RAILS_ENV=developmentREDIS_URL=redis://dawarich_redis:6379/0DATABASE_HOST=dawarich_dbDATABASE_USERNAME=postgresDATABASE_PASSWORD=passwordDATABASE_NAME=dawarich_developmentAPPLICATION_HOSTS=localhostBACKGROUND_PROCESSING_CONCURRENCY=10APPLICATION_PROTOCOL=httpDISTANCE_UNIT=kmPROMETHEUS_EXPORTER_ENABLED=falsePROMETHEUS_EXPORTER_HOST=dawarich_appPROMETHEUS_EXPORTER_PORT=9394SELF_HOSTED=true

Restart

on-failure

Image details

Pulls: 6.9M

User: freikin

Created: Mar 24, 2024

Updated: 12 hours ago

Status: active

Standalone Install

Select an install method, to see config/commands for deploying Dawarich

Installation method

Docker Run

Docker Compose

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select Dawarich, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

Original stackfile

The compose file this template deploys, straight from its repo:

networks:
  dawarich:
services:
  dawarich_redis:
    image: redis:7.0-alpine
    container_name: dawarich_redis
    command: redis-server
    networks:
      - dawarich
    volumes:
      - /portainer/Files/AppData/Config/dawarich/shared:/data
    restart: always
    healthcheck:
      test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
      interval: 10s
      retries: 5
      start_period: 30s
      timeout: 10s
  dawarich_db:
    image: postgis/postgis:17-3.5-alpine
    shm_size: 1G
    container_name: dawarich_db
    volumes:
      - /portainer/Files/AppData/Config/dawarich/dawarich_db_data:/var/lib/postgresql/data
      - /portainer/Files/AppData/Config/dawarich/shared:/var/shared
      # - ./postgresql.conf:/etc/postgresql/postgresql.conf # Optional, uncomment if you want to use a custom config
    networks:
      - dawarich
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
    restart: always
    healthcheck:
      test: [ "CMD-SHELL", "pg_isready -U postgres -d dawarich_development" ]
      interval: 10s
      retries: 5
      start_period: 30s
      timeout: 10s
    # command: postgres -c config_file=/etc/postgresql/postgresql.conf # Use custom config, uncomment if you want to use a custom config
  dawarich_app:
    image: freikin/dawarich:latest
    container_name: dawarich_app
    volumes:
      - /portainer/Files/AppData/Config/dawarich/public:/var/app/public
      - /portainer/Files/AppData/Config/dawarich/watched:/var/app/tmp/imports/watched
      - /portainer/Files/AppData/Config/dawarich/storage:/var/app/storage
    networks:
      - dawarich
    ports:
      - 3000:3000
      # - 9394:9394 # Prometheus exporter, uncomment if needed
    stdin_open: true
    tty: true
    entrypoint: web-entrypoint.sh
    command: ['bin/rails', 'server', '-p', '3000', '-b', '::']
    restart: on-failure
    environment:
      RAILS_ENV: development
      REDIS_URL: redis://dawarich_redis:6379/0
      DATABASE_HOST: dawarich_db
      DATABASE_USERNAME: postgres
      DATABASE_PASSWORD: password
      DATABASE_NAME: dawarich_development
      MIN_MINUTES_SPENT_IN_CITY: 60
      APPLICATION_HOSTS: localhost
      TIME_ZONE: Europe/Athens
      APPLICATION_PROTOCOL: http
      DISTANCE_UNIT: km
      PROMETHEUS_EXPORTER_ENABLED: false
      PROMETHEUS_EXPORTER_HOST: 0.0.0.0
      PROMETHEUS_EXPORTER_PORT: 9394
      SELF_HOSTED: "true"
    logging:
      driver: "json-file"
      options:
        max-size: "100m"
        max-file: "5"
    healthcheck:
      test: [ "CMD-SHELL", "wget -qO - http://127.0.0.1:3000/api/v1/health | grep -q '\"status\"\\s*:\\s*\"ok\"'" ]
      interval: 10s
      retries: 30
      start_period: 30s
      timeout: 10s
    depends_on:
      dawarich_db:
        condition: service_healthy
        restart: true
      dawarich_redis:
        condition: service_healthy
        restart: true
    deploy:
      resources:
        limits:
          cpus: '0.50'    # Limit CPU usage to 50% of one core
          memory: '4G'    # Limit memory usage to 4GB
  dawarich_sidekiq:
    image: freikin/dawarich:latest
    container_name: dawarich_sidekiq
    volumes:
      - /portainer/Files/AppData/Config/dawarich/public:/var/app/public
      - /portainer/Files/AppData/Config/dawarich/watched:/var/app/tmp/imports/watched
      - /portainer/Files/AppData/Config/dawarich/storage:/var/app/storage
    networks:
      - dawarich
    stdin_open: true
    tty: true
    entrypoint: sidekiq-entrypoint.sh
    command: ['sidekiq']
    restart: on-failure
    environment:
      RAILS_ENV: development
      REDIS_URL: redis://dawarich_redis:6379/0
      DATABASE_HOST: dawarich_db
      DATABASE_USERNAME: postgres
      DATABASE_PASSWORD: password
      DATABASE_NAME: dawarich_development
      APPLICATION_HOSTS: localhost
      BACKGROUND_PROCESSING_CONCURRENCY: 10
      APPLICATION_PROTOCOL: http
      DISTANCE_UNIT: km
      PROMETHEUS_EXPORTER_ENABLED: false
      PROMETHEUS_EXPORTER_HOST: dawarich_app
      PROMETHEUS_EXPORTER_PORT: 9394
      SELF_HOSTED: "true"
    logging:
      driver: "json-file"
      options:
        max-size: "100m"
        max-file: "5"
    healthcheck:
      test: [ "CMD-SHELL", "bundle exec sidekiqmon processes | grep $${HOSTNAME}" ]
      interval: 10s
      retries: 30
      start_period: 30s
      timeout: 10s
    depends_on:
      dawarich_db:
        condition: service_healthy
        restart: true
      dawarich_redis:
        condition: service_healthy
        restart: true
      dawarich_app:
        condition: service_healthy
        restart: true
    deploy:
      resources:
        limits:
          cpus: '0.50'    # Limit CPU usage to 50% of one core
          memory: '4G'    # Limit memory usage to 4GB

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/dawarich.yml up -d

More install options in our documentation.

Container Documentation

dawarich_redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

dawarich_db Documentation

PostGIS is a spatial database extender for PostgreSQL object-relational database.

Serve Dawarich on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying dawarich.example.com to http://dawarich_app:3000

Add this to your Caddyfile

dawarich.example.com {
	reverse_proxy http://dawarich_app:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :3000
Stop the other service, or pick a different host port. In 3000:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, dawarich can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/dawarich/shared (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull redis:7.0-alpine

"manifest unknown" means the tag no longer exists.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within dawarich's repo
Template not working: Open an issue on xneo1/portainer_templates
This website not working: Open an issue on lissy93/portainer-templates

A Compose stack

Dawarich is a Compose stack, a set of containers (4 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 4 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

dawarich_redis runs redis:7.0-alpine
dawarich_db runs postgis/postgis:17-3.5-alpine
dawarich_app runs freikin/dawarich:latest, starts after dawarich_db, dawarich_redis
dawarich_sidekiq runs freikin/dawarich:latest, starts after dawarich_db, dawarich_redis, dawarich_app

Ports

A port is the door the app answers on. A mapping like 3000:3000 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:

3000:3000, likely the web interface

Volumes

A volume is where Dawarich keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

/data from /portainer/Files/AppData/Config/dawarich/shared on the host
/var/lib/postgresql/data from /portainer/Files/AppData/Config/dawarich/dawarich_db_data on the host
/var/shared from /portainer/Files/AppData/Config/dawarich/shared on the host
/var/app/public from /portainer/Files/AppData/Config/dawarich/public on the host
/var/app/tmp/imports/watched from /portainer/Files/AppData/Config/dawarich/watched on the host
/var/app/storage from /portainer/Files/AppData/Config/dawarich/storage on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Dawarich takes 18 of them, all with defaults you can leave alone or tweak:

POSTGRES_USER, defaults to postgres
POSTGRES_PASSWORD, defaults to password
RAILS_ENV, defaults to development
REDIS_URL, defaults to redis://dawarich_redis:6379/0
DATABASE_HOST, defaults to dawarich_db
DATABASE_USERNAME, defaults to postgres
DATABASE_PASSWORD, defaults to password
DATABASE_NAME, defaults to dawarich_development
MIN_MINUTES_SPENT_IN_CITY, defaults to 60
APPLICATION_HOSTS, defaults to localhost
TIME_ZONE, defaults to Europe/Athens
APPLICATION_PROTOCOL, defaults to http
DISTANCE_UNIT, defaults to km
PROMETHEUS_EXPORTER_ENABLED, defaults to false
PROMETHEUS_EXPORTER_HOST, defaults to dawarich_app
PROMETHEUS_EXPORTER_PORT, defaults to 9394
SELF_HOSTED, defaults to true
BACKGROUND_PROCESSING_CONCURRENCY, defaults to 10

Restart policy

The restart policy here is always, so Docker brings Dawarich back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like dawarich_redis) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Dawarich up. Add the template list to Portainer once, then deploying Dawarich is a click rather than a wall of config.

Dawarich

Configuration

Services

dawarich_redis

Configuration

Image details

dawarich_db

Configuration

Image details

dawarich_app

Configuration

Image details

dawarich_sidekiq

Configuration

Image details

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

dawarich_redis Documentation

dawarich_db Documentation

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Stack won't deploy

Raise an issue

Config glossary

A Compose stack

The services

Ports

Volumes

Environment variables

Restart policy

Networking

Platform

Portainer app templates