Installation¶

FitTrackee can be installed:

via a single Python package from PyPI,
from sources,
with a Docker image.

Thanks to contributors, packages are also available on Yunohost and NixOS.

Main dependencies¶

This application is written in Python (API) and Typescript (client):

API:
- Flask
- SQLAlchemy and geoalchemy2 to interact with the database
- gpxpy to parse gpx files
- fitdecode to parse fit files
- GeoPandas to work with geospatial data
- Static Map 3, a fork of Static Map to generate a static map image from file coordinates
- Dramatiq and Flask-Dramatiq for task queue
- Authlib for OAuth 2.0 Authorization support
- Flask-Limiter for API rate limits
- gunicorn to serve application
Client:
- Vue3/Vuex
- Leaflet to display map
- Chart.js to display charts
- heatmap.js (fork) and leaflet-heatmap to display heatmap for rackets sports
- zxcvbn-ts for password strength estimation

Logo, most of sports icons and weather icons are made by Freepik from Flaticon.
FitTrackee also uses icons from Fork Awesome.
Sports icons for Canoeing, Kayaking and Rowing are made by @Von-Birne.
Sport icon for Halfbike is made by @astridx.

Instance types¶

Single-user instance¶

For a single-user instance, registration can be disabled.

So all you need is Python and PostgreSQL/PostGIS database if you want to keep the setup simple. A CLI is available to manage user account.

Multiple-users instance¶

Registration can en enabled and maximum number of accounts can be set in the Administration.

It is recommended to set Redis and a SMTP provider for email sending and tasks processing. Alternatively, a CLI is available to manage users account.

Prerequisites¶

mandatory
- installation from sources or package:
  - Python 3.10+
  - PostgreSQL 14+
  - PostGIS 3.4+
  - GDAL on the server running the application, if different from the server running the database (GDAL is installed with PostGIS)
- installation with Docker:
  - Docker and Docker Compose v2.30+
optional
- Redis for task queue (for email sending if enable, for data export requests, and asynchronous archive uploads if enabled) and API rate limits (for installation from sources or package)
- SMTP provider (if email sending is enabled)
- API key from a weather data provider
- elevation data provider
- Poetry 1.2+ (for installation from sources only)
- Node 20+ and Yarn (for development only)

Note

If registration is enabled, it is recommended to set Redis and a SMTP provider for email sending and data export requests.

Note

Depending on the operating system and the version of Python installed, additional dependencies may be required, such as gcc or libgdal-dev.

Important

This documentation does not detail how to secure a server. Please refer to the documentation and best practices corresponding to your installation and operating system.