README.md

A workout tracking web application for personal use (or family, friends), geared towards running and other GPX-based activities

Self-hosted, everything included.

Chat with the community on Matrix

Heavily inspired by FitTrackee ❤️.

❤️ Donate your workout files ❤️

We are collecting real workout files for testing purposes. If you want to support the project, donate your files. You can open an issue and attach the file, or send a pull request.

We are looking for general files from all sources, but also "raw" files from devices. The first file type can be edited to remove personal information, but the second type should be as pure (raw) as possible.

Make sure the file does not contain personally identifiable information, specifically your home address! Preferably, share files from workouts that you recorded while travelling.

Be sure to add some metadata in the issue or pull request, such as:

• the activity type (running, swimming, ...)
• the general location's name (city, national park, ...)
• anything relevant, such as whether there is heart rate or cadence data, or any other data

By donating the files, you grant the project full permission to use them as they see fit.

Getting started

Docker

Run the latest image from GitHub Container Registry (latest and release images are available for amd64 and arm64). The current directory is mounted as the data directory.

# Latest master build
docker run -p 8080:8080 -v .:/data ghcr.io/jovandeginste/workout-tracker:latest

# Tagged release
docker run -p 8080:8080 -v .:/data ghcr.io/jovandeginste/workout-tracker:0.11.3
docker run -p 8080:8080 -v .:/data ghcr.io/jovandeginste/workout-tracker:0.11
docker run -p 8080:8080 -v .:/data ghcr.io/jovandeginste/workout-tracker:0

# Latest release
docker run -p 8080:8080 -v .:/data ghcr.io/jovandeginste/workout-tracker:release

# Run as non-root user; make sure . is owned by uid 1000
docker run -p 8080:8080 -v .:/data -u 1000:1000 ghcr.io/jovandeginste/workout-tracker

Open your browser at http://localhost:8080

To persist data and sessions, run:

docker run -p 8080:8080 \
    -e WT_JWT_ENCRYPTION_KEY=my-secret-key \
    -v $PWD/data:/data \
    ghcr.io/jovandeginste/workout-tracker:master

or use docker compose

# Create directory that stores your data
mkdir -p /opt/workout-tracker
cd /opt/workout-tracker

# Download the docker compose file
## For sqlite as database:
curl https://raw.githubusercontent.com/jovandeginste/workout-tracker/master/docker-compose.sqlite.yaml --output docker-compose.yaml

## For postgres as database:
curl https://raw.githubusercontent.com/jovandeginste/workout-tracker/master/docker-compose.postgres.yaml --output docker-compose.yaml
curl https://raw.githubusercontent.com/jovandeginste/workout-tracker/master/postgres.env --output postgres.env

# Start the server
docker compose up -d

NOTE: If using postgres, configure the parameters in postgres.env.

Natively

Download a pre-built binary or build it yourself (see Development below).

Eg. for v0.11.3 on Linux x86_64:

wget https://github.com/jovandeginste/workout-tracker/releases/download/v0.11.3/workout-tracker-v0.11.3-linux-amd64.tar.gz
tar xf workout-tracker-v0.11.3-linux-amd64.tar.gz
./workout-tracker

To persist sessions, run:

export WT_JWT_ENCRYPTION_KEY=my-secret-key
./workout-tracker

This will create a new database file in the current directory and start the web server at http://localhost:8080.

Screenshots

Login page

Login / registration form

• new users have to be activated by an admin
• registration can be disabled

Dashboard

Dashboard view with:

• personal totals
• running records
• a calendar view
• recent activities (by you and other users)

Overview of workouts

Overview of all your activities, with summaries.

Details of a single workout

Details of a workout, with:

• a zoomable, dragable map of the GPX track with more details per point
• many summarized statistics
• a breakdown per kilometer or per mile
• track color based on elevation of the segment
• graph of average speed and elevation per minute
• optional graph of heart rate, cadans

Tooltips for even more information

• green and red circle are start and end points of the track
• every point on the track has a tooltip with a summary at that moment
• hover over the breakdown per kilometer to highlight the point

Upload your files

• Upload one or multiple GPX files.
• Pick the type (running, cycling, ...) or let the application guess based on average speed.
• The files are parsed when uploaded: statistics and other information are calculated and stored in the database (serialized).
• Or add a workout manually.

Statistics to follow your progress

• Graphs showing monthly aggregated statistics.
• Pick different time range or bucket size.

Basic multi-language support

• Switch between (supported) languages
  • Please help translate via Weblate
• Use the language configured in the browser (default)
• Very limited amount of languages supported for now 😄
• Re-calculate all previously uploaded workouts (useful while developing)

Responsive design

• Usable on small and medium screens

Light and dark mode

• Browser decides whether to use light or dark mode, based on your preferences

Configuration

The web server looks for a file workout-tracker.yaml (or json or toml) in the current directory, or takes it's configuration from environment variables. The most important variable is the JWT encryption key. If you don't provide it, the key is randomly generated every time the server starts, invalidating all current sessions.

Generate a secure key and write it to workout-tracker.yaml:

echo "jwt_encryption_key: $(pwgen -c 32)" > workout-tracker.yaml

or export it as an environment variable:

export WT_JWT_ENCRYPTION_KEY="$(pwgen -c 32)"

See workout-tracker.example.yaml for more options and details.

Other environment variables, with their default values:

WT_BIND="[::]:8080"
WT_LOGGING="true"
WT_DEBUG="false"
WT_DATABASE_DRIVER="sqlite"
WT_DSN="./database.db"
WT_REGISTRATION_DISABLED="false"
WT_SOCIALS_DISABLED="false"

After starting the server, you can access it at http://localhost:8080 (the default port). A login form is shown.

If no users are in the database (eg. when starting with an empty database), a default admin user is created with password admin. You should change this password in a production environment.

API usage

The API is documented using swagger. You must enable API access for your user, and copy the API key. You can use the API key as a query parameter (api-key=${API_KEY}) or as a header (Authorization: Bearer ${API_KEY}).

You can configure some tools to automatically upload files to Workout Tracker, using the POST /api/v1/import/$program API endpoint.

Generic upload

The generic upload endpoint takes the recording as body. Prepend the path with @ to tell curl to read the data from a file:

curl -sSL -H "Authorization: bearer your-api-key" \
  http://localhost:8080/api/v1/import/generic \
  --data @path/to/recorded.gpx

or

curl -sSL http://localhost:8080/api/v1/import/generic?api-key=your-api-key \
  --data @path/to/recorded.gpx

FitoTrack

Read their documentation before you continue.

The path to POST to is: /api/v1/import/fitotrack?api-key=${API_KEY}

Development

Build and run it yourself

• install go
• clone the repository

go build ./
./workout-tracker

This does not require npm or Tailwind, since the compiled css is included in the repository.

Do some development

You need to install Golang and npm.

Because I keep forgetting how to build every component, I created a Makefile.

# Make everything. This is also the default target.
make all # Run tests and build all components

# Install system dependencies
make install-deps

# Testing
make test # Runs all the tests
make test-assets test-go # Run tests for the individual components

# Building
make build # Builds all components
make build-tw # Builds the Tailwind CSS output file
make build-server # Builds the web server
make build-docker # Performs all builds inside Docker containers, creates a Docker image
make build-swagger # Generates swagger docs

# Translating
make generate-messages # Detects all translatable strings and write them to translations/messages.yaml
make generate-translations # Populates the translation files per language


# Running it
make serve # Runs the compiled binary
make dev # Runs a wrapper that watches for changes, then rebuilds and restarts
make watch-tw # Runs the Tailwind CSS watcher (not useful unless you're debugging Tailwind CSS)

# Cleanin' up
make clean # Removes build artifacts

What is this, technically?

A single binary that runs on any platform, with no dependencies.

The binary contains all assets to serve a web interface, through which you can upload your GPX files, visualize your tracks and see their statistics and graphs. The web application is multi-user, with a simple registration and authentication form, session cookies and JWT tokens). New accounts are inactive by default. An admin user can activate (or edit, delete) accounts. The default database storage is a single SQLite file.

What technologies are used

• Go, with some notable libraries
  • gpxgo
  • Echo
  • Gorm
  • Spreak
• HTML, CSS and JS
  • Tailwind CSS
  • Iconify Design
  • FullCalendar
  • Leaflet
  • apexcharts
• Docker

The application uses OpenStreetMap and Esri as its map providers and for geocoding a GPS coordinate to a location.

Compatiblity

This is a work in progress. If you find any problems, please let us know. The application is tested with GPX files from these sources:

• Garmin Connect (export to GPX)
• FitoTrack (automatic export to GPX)
• Workoutdoors (export to GPX)

TODO

• write tests!!!!!
• add support for authentication through a reverse proxy
• make a dev-flag that doesn't embed all files in the binary
• add support for generic database drivers
  • added support for MySQL, but untested so far
  • added support for Postgres by @icewind1991
• add support for other types of import files (eg. Garmin fit files)
  • importing fit files works, kinda: there seems to be an issue with the elevation
  • see tormoder/fit#87
  • https://www.fitfileviewer.com/ gives the same elevation issue
• see if htmx is worth using
  • first I need a use case