User Tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
services:obsolete:fittrackee [2024/08/06 13:42] – created - external edit 127.0.0.1services:obsolete:fittrackee [2025/05/21 08:21] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ======   FitTrackee ====== ======   FitTrackee ======
  
-[[https://samr1.github.io/FitTrackee/en/index.html|FitTrackee]] is an open-source fitness tracker selfhosted application that can also sync with Garmin and Strava. It is aimed at outdoor acvities.+[[https://samr1.github.io/FitTrackee/en/index.html|FitTrackee]] is an open-source fitness tracker selfhosted application that can also sync with Garmin and Strava. It is aimed at outdoor activities. 
 + 
 +The main factor that made me abandon FitTrackee in favor of [[services:endurain|Endurain]] is that Endurain provides a better and easier Garmin integration built-in.
  
 ===== Installation ===== ===== Installation =====
  
-Detailed instructions can be found [[https://samr1.github.io/FitTrackee/en/installation.html|here]]. There is no container for FitTrackee, so i will show you how to install on bare-metal.+Detailed instructions can be found [[https://samr1.github.io/FitTrackee/en/installation.html|here]]. Since version 0.8 there is also a container image and a docker compose example file.  Initially i had installed on bare metal, but since that time i prefer to move to the containerized installation because i do not want to manage myself a PostgreSQL installation on my server for various reasons.
  
 +For historical reasons, i will keep the original non containerized installation instructions too for reference, but keep in mind they might be outdated.
 +
 +As usual, create the dedicated user:
 <code bash> <code bash>
 useradd -d /data/daemons/fittrackee -m fittrackee useradd -d /data/daemons/fittrackee -m fittrackee
 +mkdir /data/fittrackee /data/fittrackee/upload /data/fittrackee/database /var/log/fittrackee
 +chown fittrackee:fittrackee /data/fittrackee /data/fittrackee/upload /data/fittrackee/database /var/log/fittrackee
 </code> </code>
  
-FitTrackee uses Python, so check out [[gentoo:pip|PIP on Gentoo]] page to enable virtual environments and PIP for the fittrackee user.+uploads will be stored under **/data/fittrackee/upload** and similarly the database. Logs will be located under **/var/log/fittrackee** remember to logrotate it.
  
 +=== Using containers ===
 +
 +Download the example docker-compose.yml from [[https://github.com/SamR1/FitTrackee/blob/master/docker-compose.yml|here]] and adapt it to your needs:
 +<file - docker-compose.yaml>
 +services:
 +  fittrackee-db:
 +    container_name: fittrackee-db
 +    image: postgres:17-alpine
 +    env_file:
 +      - .env
 +    volumes:
 +      - ${DATABASE_DIR:-./data/db}:/var/lib/postgresql/data
 +    networks:
 +      - fittrackee-network
 +
 +  fittrackee:
 +    container_name: fittrackee
 +    env_file:
 +      - .env
 +    image: fittrackee/fittrackee:v0.9.11
 +    volumes:
 +      - ${UPLOAD_DIR:-./data/uploads}:/usr/src/app/uploads
 +      - ${LOG_DIR:-./data/logs}:/usr/src/app/logs
 +    post_start:
 +      - command: chown -R fittrackee:fittrackee /usr/src/app/uploads
 +        user: root
 +    ports:
 +      - "${APP_PORT:-5000}:5000"
 +    command: 'sh docker-entrypoint.sh'
 +    depends_on:
 +      fittrackee-db:
 +    networks:
 +      - fittrackee-network
 +
 +networks:
 +  fittrackee-network: {}
 +</file>
 +
 +Populate the env file (/data/daemons/fittrackee/.env):
 +<file - .env>
 +# Docker volumes
 +export UPLOAD_DIR=/data/fittrackee/uploads
 +export LOG_DIR=/var/log/fittrackee
 +export DATABASE_DIR=/data/fittrackee/database
 +
 +# Application
 +export FLASK_APP=fittrackee
 +export FLASK_SKIP_DOTENV=1
 +export APP_PORT=5123
 +export APP_SECRET_KEY=<< custom key >>
 +export APP_LOG=/usr/src/app/logs/fittrackee.log
 +export UPLOAD_FOLDER=/usr/src/app/uploads
 +export UI_URL=https://train.mydomain.com
 +
 +# PostgreSQL
 +export POSTGRES_USER=fittrackee
 +export POSTGRES_PASSWORD=<< some password >>
 +export POSTGRES_DB=fittrackee
 +export DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@fittrackee-db:5432/${POSTGRES_DB}
 +</file>
 +
 +Now start the stuff:
 <code bash> <code bash>
-python -m venv venv_ft +podman compose up
-source venv_ft/bin/activate +
-pip install fittrackee+
 </code> </code>
  
-Now, FitTrackee requires PostgreSQL, so you need to install and start it. For reference, and [[https://wiki.gentoo.org/wiki/PostgreSQL/QuickStart|this]] and [[https://wiki.gentoo.org/wiki/PostgreSQL|this]] are the Gentoo wiki pages on PostgreSQL. These two pages are very well written and will let you setup your postgres in a few moments. +you might have to stop and start again, since the first start of the database takes some time and the main app might crash. Just wait for the database to be up and running, then restart.
  
-From now on i assume PostgreSQL is installed and ready.+=== Without using containers === 
 + 
 +FitTrackee uses Python, so check out [[gentoo:pip|PIP on Gentoo]] page to enable virtual environments and PIP for the fittrackee user.
  
-Now access your postgres as admin user and create the database: 
 <code bash> <code bash>
-psql -U postgres +python -m venv venv_ft 
-</code> +source venv_ft/bin/activate 
- +pip install fittrackee
-type in the following SQL statements: +
-<code sql> +
-CREATE USER fittrackee WITH PASSWORD '<PASSWORD>'; +
-CREATE SCHEMA fittrackee AUTHORIZATION fittrackee; +
-CREATE DATABASE fittrackee OWNER fittrackee;+
 </code> </code>
  
 +Populate the following **/data/daemons/fittrackee/.env** file:
 <file - .env> <file - .env>
 export PORT=5123 export PORT=5123
 export APP_SECRET_KEY=<my secret> export APP_SECRET_KEY=<my secret>
-export APP_LOG=/data/daemons/fittrackee/log.txt +export APP_LOG=/va/log/fittrackee/log.txt 
-export UPLOAD_FOLDER=/data/daemons/fittrackee/uploads+export UPLOAD_FOLDER=/data/fittrackee/upload
 export DATABASE_URL=postgresql://fittrackee:xxxxxxx@127.0.0.1:5432/ export DATABASE_URL=postgresql://fittrackee:xxxxxxx@127.0.0.1:5432/
 export UI_URL=https://train.mydomain.com export UI_URL=https://train.mydomain.com
-export EMAIL_URL=smtp://xxxx:xxxx@smtp.mydomain.com:587/?tls=True 
-export SENDER_EMAIL=xxx@mydomain.com 
 export FLASK_APP=fittrackee export FLASK_APP=fittrackee
 </file> </file>
  
-Ensure this **.env** file is sourced in your **~/.bashrc**.+Ensure this **.env** file is sourced in your **~/.bashrc**, this is needed for non-container users, and also required for the Garmin bridge, even if using containers.
  
 As a reference: As a reference:
Line 56: Line 118:
 source .env source .env
 </file> </file>
 +
 +Now, FitTrackee requires PostgreSQL, so you need to install and start it. For reference, and [[https://wiki.gentoo.org/wiki/PostgreSQL/QuickStart|this]] and [[https://wiki.gentoo.org/wiki/PostgreSQL|this]] are the Gentoo wiki pages on PostgreSQL. These two pages are very well written and will let you setup your postgres in a few moments. 
 +
 +From now on i assume PostgreSQL is installed and ready.
 +
 +Now access your postgres as admin user and create the database:
 +<code bash>
 +psql -U postgres
 +</code>
 +
 +type in the following SQL statements:
 +<code sql>
 +CREATE USER fittrackee WITH PASSWORD '<PASSWORD>';
 +CREATE SCHEMA fittrackee AUTHORIZATION fittrackee;
 +CREATE DATABASE fittrackee OWNER fittrackee;
 +</code>
  
 Now, initialize the database: Now, initialize the database:
Line 69: Line 147:
 <file - fittrackee.conf> <file - fittrackee.conf>
 server { server {
-        server_name train.gardiol.org;+        server_name train.mydomain.com;
         listen 443 ssl;         listen 443 ssl;
         listen 8443 ssl;         listen 8443 ssl;
  
-        access_log /var/log/nginx/train.gardiol.org_access_log main; +        access_log /var/log/nginx/train.mydomain.com_access_log main; 
-        error_log /var/log/nginx/train.gardiol.org_error_log info;+        error_log /var/log/nginx/train.mydomain.com_error_log info;
  
         location / {         location / {
Line 87: Line 165:
  
         client_max_body_size 100M;         client_max_body_size 100M;
-        include org.gardiol/certbot.conf;+        include com.mydomain/certbot.conf;
 } }
 </file> </file>
  
-===== Autostart =====+===== Autostart with containers ===== 
 + 
 +To start it, and set it up on boot, as usual follow my indications [[gentoo:containers|Using Containers on Gentoo]], so link the **user-containers** init script: 
 +<code> 
 +ln -s /etc/init.d/user-containers /etc/init.d/user-containers.fittrackee 
 +</code> 
 + 
 +and create the following config file: 
 +<file - /etc/conf.d/user-containers.fittrackee> 
 +USER=fittrackee 
 +DESCRIPTION="The sport and train solution" 
 +</file> 
 + 
 +Add the service to the default runlevel and start it now: 
 +<code bash> 
 +rc-update add user-containers.fittrackee default 
 +rc-service user-containers.fittrackee start 
 +</code> 
 + 
 +===== Autostart without containers =====
  
 Since i use OpenRC, simply drop the following script to /etc/init.d: Since i use OpenRC, simply drop the following script to /etc/init.d:
Line 132: Line 229:
 ===== User management ===== ===== User management =====
  
-If you do not require generating and managing many users, you can manually create them:+You can create users from the web UI, but users will be disabled. I suggest you go ahead and create one user, then use the CLI to set it as admin, you can then login and manage users with that login. 
 + 
 +To run the CLI (container installation): 
 +<code bash> 
 +podman compose exec fittrackee ftcli users update <username> --set-role admin 
 +</code> 
 + 
 +To run the CLI (without container installation): 
 +<code bash> 
 +ftcli users update <username> --set-role admin 
 +</code> 
 + 
 +To create users:
 <code bash> <code bash>
 ftcli users create --password <password> --lang en --email xxx@mydomain.com myuser ftcli users create --password <password> --lang en --email xxx@mydomain.com myuser
 +</code>
 +
 +To set an user as admin:
 +<code bash>
 ftcli users update myuser --set-admin true ftcli users update myuser --set-admin true
 </code> </code>
  
-and then disable user registration from the admin panel in theweb GUI, set the number of active users to a fixed quantity instead of zero.+You can also disable user registration from the admin panel in the web GUI, set the number of active users to a fixed quantity instead of zero.
  
 ===== Log rotation ===== ===== Log rotation =====
Line 144: Line 257:
 If you use **logrotate** (you should), create a new file under **/etc/logrotate.d/fittrackee**: If you use **logrotate** (you should), create a new file under **/etc/logrotate.d/fittrackee**:
 <file - fittrackee> <file - fittrackee>
-/data/daemons/fittrackee/log.txt {+/var/log/fittrackee/* {
     missingok     missingok
     notifempty     notifempty
Line 154: Line 267:
 Work in progress. Work in progress.
  
-===== Updates =====+===== Updates for non-container install =====
  
 Stop the service, then run, as **fitrackee** user: Stop the service, then run, as **fitrackee** user:
Line 165: Line 278:
  
 Also note, if you installed the Garmin bridge, that you might want to run again that installation command as well. Also note, if you installed the Garmin bridge, that you might want to run again that installation command as well.
 +
  
 ===== Garmin Integration ===== ===== Garmin Integration =====
  
 A Garmin bridge for FitTrackee exist [[https://git.dryusdan.fr/Dryusdan/garmin-to-fittrackee|here]]. A Garmin bridge for FitTrackee exist [[https://git.dryusdan.fr/Dryusdan/garmin-to-fittrackee|here]].
 +
 +There is no containerized version, so you need to install on bare metal. 
 +
 +===== setup for container-based Fittrackee installation  =====
 +
 +Garmin integration uses Python, so check out [[gentoo:pip|PIP on Gentoo]] page to enable virtual environments and PIP for the fittrackee user.
 +
 +Only if you have done a Fittrackee containerized installation, do the following:
 +<code bash>
 +python -m venv venv_ft
 +source venv_ft/bin/activate
 +</code>
 +
 +and enable it in fittrackee' user **.bashrc**, as a reference:
 +<file - .bashrc>
 +(only last lines shown)
 +export PATH=$PATH:~/.local/bin
 +source venv_ft/bin/activate
 +source .env
 +</file>
 +
 +===== bridge installation  =====
  
 First of all, as the same **fittrackee** user, install the bridge: First of all, as the same **fittrackee** user, install the bridge:
Line 175: Line 311:
 </code> </code>
  
-Now, citing the documentation in the above link, y ou need to create an application in your Fittrackee instance so go to you're fittrackee account, then go to "apps", then "Add an application".+Now, citing the documentation in the above link, you need to create an application in your Fittrackee instance so go to you're fittrackee account, then go to "apps", then "Add an application".
 In the "Add a new OAuth2 application" section; chose your Application name (let's put **GarminConnect** as an example). In the "Add a new OAuth2 application" section; chose your Application name (let's put **GarminConnect** as an example).
 As "application URL" and "Redirect URL" set your FitTrackee URL, so for example **https://train.mydomain.com**.  As "application URL" and "Redirect URL" set your FitTrackee URL, so for example **https://train.mydomain.com**. 
Line 184: Line 320:
 At this point, setup the link to Garmin, from your fittrackee user terminal: At this point, setup the link to Garmin, from your fittrackee user terminal:
 <code bash> <code bash>
-.garmin2fittrackee setup config-tool+garmin2fittrackee setup config-tool
 </code> </code>
  
 +Link to Garmin:
 +<code bash>
 + garmin2fittrackee sync
 +</code>
 You will need to provide your garmin credentials for login. You will need to provide your garmin credentials for login.
  

This website uses technical cookies only. No information is shared with anybody or used in any way but provide the website in your browser.

More information