diff --git a/CHANGELOG.md b/CHANGELOG.md
index 92790c517..c94095ee0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,38 @@
# Change log
+## Version 0.8.13 (2024/12/29)
+
+### Translations
+
+* [PR#667](https://github.com/SamR1/FitTrackee/pull/667) - Translations update (Galicien)
+
+Translation status:
+- Basque: 100%
+- Bulgarian: 98%
+- Czech: 72%
+- Dutch: 99%
+- English: 100%
+- French: 100%
+- Galician: 100%
+- German: 100%
+- Italian: 81%
+- Norwegian Bokmål: 52%
+- Polish: 100%
+- Portuguese: 97%
+- Russian: 62%
+- Spanish: 100%
+
+### Misc
+
+* [#126](https://github.com/SamR1/FitTrackee/issues/126) - Docker's Container on docker hub
+* [PR#673](https://github.com/SamR1/FitTrackee/pull/673) - Publish package on PyPI using GitHub Actions workflow
+
+
+Thanks to the contributors:
+- @DavidHenryThoreau
+- @xmgz
+
+
## Version 0.8.12 (2024/11/17)
### Bugs Fixed
@@ -11,7 +44,6 @@
* [PR#651](https://github.com/SamR1/FitTrackee/pull/651) - Tests - add databases to parallelize more tests
-
## Version 0.8.11 (2024/10/30)
**FitTrackee** is now available for Python 3.13.
diff --git a/README.md b/README.md
index 65e90ea2c..2db229d7f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# FitTrackee
**A simple self-hosted workout/activity tracker.**
-[](https://pypi.org/project/fittrackee/)
+
[](https://python.org)
[](http://flask.pocoo.org/)
[](https://docs.astral.sh/ruff/)
@@ -9,10 +9,10 @@
[](https://v3.vuejs.org/)
[](https://github.com/prettier/prettier)
[](https://www.typescriptlang.org/)
+[](https://pypi.org/project/fittrackee/) [](https://hub.docker.com/r/fittrackee/fittrackee)
[](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-python.yml)
[](https://github.com/SamR1/FitTrackee/actions/workflows/.tests-javascript.yml)
-[](https://hosted.weblate.org/engage/fittrackee/)
-
+[](https://hosted.weblate.org/engage/fittrackee/)
---
Web application allowing tracking of outdoor activities (workouts) from GPX files, \
diff --git a/VERSION b/VERSION
index 7eff8ab95..c2f73c6ec 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.8.12
+0.8.13
diff --git a/docker-compose.yml b/docker-compose.yml
index d03274aed..5833e64d2 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -28,9 +28,10 @@ services:
container_name: fittrackee
env_file:
- .env
-# TODO: to update on next release
-# image: fittrackee/fittrackee:v0.8.13
- build: .
+# Image from Docker Hub
+ image: fittrackee/fittrackee:v0.8.13
+# Uncomment following line to build image instead of using pre-built image
+# build: .
volumes:
- ${UPLOAD_DIR:-./data/uploads}:/usr/src/app/uploads
- ${UPLOAD_LOG:-./data/logs}:/usr/src/app/logs
@@ -61,9 +62,10 @@ services:
# container_name: fittrackee-workers
# env_file:
# - .env
-## TODO: to update on next release
-## image: fittrackee/fittrackee:v0.8.13
-# build: .
+## Image from Docker Hub
+# image: fittrackee/fittrackee:v0.8.13
+## Uncomment following line to build image instead of using pre-built image
+## build: .
# volumes:
# - ${UPLOAD_LOG:-./data/logs}:/usr/src/app/logs
# post_start:
diff --git a/docs/en/.buildinfo b/docs/en/.buildinfo
index a081914d9..f966400d1 100644
--- a/docs/en/.buildinfo
+++ b/docs/en/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3569b0304590d86389f79e54c10d6b9a
+config: 306a9e16d377977980ae964bbcf57f98
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/en/_images/fittrackee_screenshot-01.png b/docs/en/_images/fittrackee_screenshot-01.png
index 64b285df2..019b6e67a 100644
Binary files a/docs/en/_images/fittrackee_screenshot-01.png and b/docs/en/_images/fittrackee_screenshot-01.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-02.png b/docs/en/_images/fittrackee_screenshot-02.png
index 62063c1af..788de3486 100644
Binary files a/docs/en/_images/fittrackee_screenshot-02.png and b/docs/en/_images/fittrackee_screenshot-02.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-03.png b/docs/en/_images/fittrackee_screenshot-03.png
index a01d55838..28023a9b0 100644
Binary files a/docs/en/_images/fittrackee_screenshot-03.png and b/docs/en/_images/fittrackee_screenshot-03.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-04.png b/docs/en/_images/fittrackee_screenshot-04.png
index 891ddeaca..20074b206 100644
Binary files a/docs/en/_images/fittrackee_screenshot-04.png and b/docs/en/_images/fittrackee_screenshot-04.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-05.png b/docs/en/_images/fittrackee_screenshot-05.png
index e875f94c9..14a36f288 100644
Binary files a/docs/en/_images/fittrackee_screenshot-05.png and b/docs/en/_images/fittrackee_screenshot-05.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-06.png b/docs/en/_images/fittrackee_screenshot-06.png
index 28b6394c5..932a5d79e 100644
Binary files a/docs/en/_images/fittrackee_screenshot-06.png and b/docs/en/_images/fittrackee_screenshot-06.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-07.png b/docs/en/_images/fittrackee_screenshot-07.png
index aac958342..a7ad2d5f6 100644
Binary files a/docs/en/_images/fittrackee_screenshot-07.png and b/docs/en/_images/fittrackee_screenshot-07.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-08.png b/docs/en/_images/fittrackee_screenshot-08.png
index 6d496cda6..f7ae93f7a 100644
Binary files a/docs/en/_images/fittrackee_screenshot-08.png and b/docs/en/_images/fittrackee_screenshot-08.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-09.png b/docs/en/_images/fittrackee_screenshot-09.png
index 980512de0..c0839682d 100644
Binary files a/docs/en/_images/fittrackee_screenshot-09.png and b/docs/en/_images/fittrackee_screenshot-09.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-10.png b/docs/en/_images/fittrackee_screenshot-10.png
index 94ca28350..fbd566f61 100644
Binary files a/docs/en/_images/fittrackee_screenshot-10.png and b/docs/en/_images/fittrackee_screenshot-10.png differ
diff --git a/docs/en/_images/fittrackee_screenshot-11.png b/docs/en/_images/fittrackee_screenshot-11.png
index 01c18fab1..374ea7f01 100644
Binary files a/docs/en/_images/fittrackee_screenshot-11.png and b/docs/en/_images/fittrackee_screenshot-11.png differ
diff --git a/docs/en/_sources/changelog.md.txt b/docs/en/_sources/changelog.md.txt
index 92790c517..c94095ee0 100644
--- a/docs/en/_sources/changelog.md.txt
+++ b/docs/en/_sources/changelog.md.txt
@@ -1,5 +1,38 @@
# Change log
+## Version 0.8.13 (2024/12/29)
+
+### Translations
+
+* [PR#667](https://github.com/SamR1/FitTrackee/pull/667) - Translations update (Galicien)
+
+Translation status:
+- Basque: 100%
+- Bulgarian: 98%
+- Czech: 72%
+- Dutch: 99%
+- English: 100%
+- French: 100%
+- Galician: 100%
+- German: 100%
+- Italian: 81%
+- Norwegian Bokmål: 52%
+- Polish: 100%
+- Portuguese: 97%
+- Russian: 62%
+- Spanish: 100%
+
+### Misc
+
+* [#126](https://github.com/SamR1/FitTrackee/issues/126) - Docker's Container on docker hub
+* [PR#673](https://github.com/SamR1/FitTrackee/pull/673) - Publish package on PyPI using GitHub Actions workflow
+
+
+Thanks to the contributors:
+- @DavidHenryThoreau
+- @xmgz
+
+
## Version 0.8.12 (2024/11/17)
### Bugs Fixed
@@ -11,7 +44,6 @@
* [PR#651](https://github.com/SamR1/FitTrackee/pull/651) - Tests - add databases to parallelize more tests
-
## Version 0.8.11 (2024/10/30)
**FitTrackee** is now available for Python 3.13.
diff --git a/docs/en/_sources/installation.rst.txt b/docs/en/_sources/installation.rst.txt
index 33a2cc03e..43e0db512 100644
--- a/docs/en/_sources/installation.rst.txt
+++ b/docs/en/_sources/installation.rst.txt
@@ -39,15 +39,23 @@ Prerequisites
~~~~~~~~~~~~~
- mandatory
- - Python 3.9+
- - PostgreSQL 12+
+
+ - installation from sources or package:
+
+ - `Python `__ 3.9+
+ - `PostgreSQL `__ 12+
+
+ - installation with Docker:
+
+ - `Docker `__ and `Docker Compose `__ v2.30+
+
- optional
- - Redis for task queue (if email sending is enabled and for data export requests) and API rate limits
- - SMTP provider (if email sending is enabled)
- - API key from a `weather data provider `__
- - `Poetry `__ 1.2+ (for installation from sources only)
- - `Node `__ 18+ and `Yarn `__ (for development only)
- - Docker and Docker Compose (for development or evaluation purposes)
+
+ - `Redis `__ for task queue (if email sending is enabled and for data export requests) and API rate limits (for installation from sources or package)
+ - SMTP provider (if email sending is enabled)
+ - API key from a `weather data provider `__
+ - `Poetry `__ 1.2+ (for installation from sources only)
+ - `Node `__ 18+ 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.
@@ -260,6 +268,53 @@ deployment method.
.. versionchanged:: 0.7.26 ⚠️ replaces ``VUE_APP_API_URL``
+ **FitTrackee** API URL, only needed in dev environment.
+
+Docker
+^^^^^^
+
+.. versionadded:: 0.8.13
+
+Environment variables for ``docker-compose.yml``
+
+.. envvar:: APP_PORT
+
+ Application container port
+
+
+.. envvar:: DATABASE_DIR
+
+ Host directory for PostgreSQL data volume
+
+
+.. envvar:: POSTGRES_USER
+
+ User for PostgreSQL database
+
+
+.. envvar:: POSTGRES_PASSWORD
+
+ Password for PostgreSQL user
+
+
+.. envvar:: POSTGRES_DB
+
+ Database name for FitTrackee application
+
+
+.. envvar:: REDIS_DIR
+
+ Host directory for redis data volume
+
+
+.. envvar:: LOG_DIR
+
+ Host directory for logs volume
+
+
+.. envvar:: UPLOAD_DIR
+
+ Host directory for uploaded files volume
Emails
@@ -529,13 +584,13 @@ Production environment
.. warning::
| Note that FitTrackee is under heavy development, some features may be unstable.
-- Download the last release (for now, it is the release v0.8.12):
+- Download the last release (for now, it is the release v0.8.13):
.. code:: bash
- $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.12.tar.gz
- $ tar -xzf v0.8.12.tar.gz
- $ mv FitTrackee-0.8.12 FitTrackee
+ $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.13.tar.gz
+ $ tar -xzf v0.8.13.tar.gz
+ $ mv FitTrackee-0.8.13 FitTrackee
$ cd FitTrackee
- Create **.env** from example and update it
@@ -666,13 +721,13 @@ Prod environment
- Change to the directory where FitTrackee directory is located
-- Download the last release (for now, it is the release v0.8.12) and overwrite existing files:
+- Download the last release (for now, it is the release v0.8.13) and overwrite existing files:
.. code:: bash
- $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.12.tar.gz
- $ tar -xzf v0.8.12.tar.gz
- $ cp -R FitTrackee-0.8.12/* FitTrackee/
+ $ wget https://github.com/SamR1/FitTrackee/archive/v0.8.13.tar.gz
+ $ tar -xzf v0.8.13.tar.gz
+ $ cp -R FitTrackee-0.8.13/* FitTrackee/
$ cd FitTrackee
- Update **.env** if needed (see `Environment variables `__).
@@ -834,15 +889,50 @@ Examples:
Docker
~~~~~~
-Installation
-^^^^^^^^^^^^
-
.. versionadded:: 0.4.4
+.. versionchanged:: 0.5.0 add client application for development
+.. versionchanged:: 0.8.13 add docker image for production
+
+
+Production
+^^^^^^^^^^
+
+Images are available on `DockerHub `_ or `Github registry `_.
+
+.. note::
+
+ Images are available for ``linux/amd64`` and ``linux/arm64`` platforms. Only ``linux/amd64`` image has been tested.
+
+- create a ``docker-compose.yml`` file as needed (see the example in the repository):
+
+ - the minimal set up requires at least the database and the web application
+ - to activate the rate limit, redis is required
+ - to send e-mails, redis and workers are required and a valid ``EMAIL_URL`` variable must be set in ``.env``
+
+.. note::
+ The same image is used by the web application and workers.
+
+- create ``.env`` from example (``.env.docker.example``) and update it (see `Environment variables `__).
+
+- to start the application:
-For **evaluation** purposes, docker files are available, installing **FitTrackee** from **sources**.
+.. code:: bash
+
+ $ docker compose up -d
.. warning::
- Docker files are not suitable for production installation.
+
+ Migrations are executed at startup. Please backup data before updating FitTrackee image version.
+
+- to run a CLI command, for instance to give admin rights:
+
+.. code:: bash
+
+ $ docker compose exec fittrackee ftcli users update --set-admin true
+
+
+Development
+^^^^^^^^^^^
- To install and run **FitTrackee**:
@@ -850,7 +940,6 @@ For **evaluation** purposes, docker files are available, installing **FitTrackee
$ git clone https://github.com/SamR1/FitTrackee.git
$ cd FitTrackee
- $ cp .env.docker .env
$ make docker-run
- Open http://localhost:5000 and register.
@@ -878,12 +967,6 @@ Open http://localhost:8025 to access `MailHog interface
- Authentication and account - FitTrackee 0.8.12 documentation
+ Authentication and account - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/configuration.html b/docs/en/api/configuration.html
index aeccfe3c2..198648c75 100644
--- a/docs/en/api/configuration.html
+++ b/docs/en/api/configuration.html
@@ -6,7 +6,7 @@
- Configuration - FitTrackee 0.8.12 documentation
+ Configuration - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/equipment_types.html b/docs/en/api/equipment_types.html
index 9830c06fe..e90cf09c4 100644
--- a/docs/en/api/equipment_types.html
+++ b/docs/en/api/equipment_types.html
@@ -6,7 +6,7 @@
- Equipment Types - FitTrackee 0.8.12 documentation
+ Equipment Types - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/equipments.html b/docs/en/api/equipments.html
index a108688f4..1561ccbb4 100644
--- a/docs/en/api/equipments.html
+++ b/docs/en/api/equipments.html
@@ -6,7 +6,7 @@
- Equipments - FitTrackee 0.8.12 documentation
+ Equipments - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/index.html b/docs/en/api/index.html
index bddef026f..3a98d63d9 100644
--- a/docs/en/api/index.html
+++ b/docs/en/api/index.html
@@ -6,7 +6,7 @@
- API documentation - FitTrackee 0.8.12 documentation
+ API documentation - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/oauth2.html b/docs/en/api/oauth2.html
index 36c034ec5..624d86fcf 100644
--- a/docs/en/api/oauth2.html
+++ b/docs/en/api/oauth2.html
@@ -6,7 +6,7 @@
- OAuth2 - FitTrackee 0.8.12 documentation
+ OAuth2 - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
-
+
diff --git a/docs/en/api/records.html b/docs/en/api/records.html
index c733e4aef..539faadf7 100644
--- a/docs/en/api/records.html
+++ b/docs/en/api/records.html
@@ -6,7 +6,7 @@
- Records - FitTrackee 0.8.12 documentation
+ Records - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
-
+
diff --git a/docs/en/api/sports.html b/docs/en/api/sports.html
index 26054e934..36c4085b2 100644
--- a/docs/en/api/sports.html
+++ b/docs/en/api/sports.html
@@ -6,7 +6,7 @@
- Sports - FitTrackee 0.8.12 documentation
+ Sports - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
-
+
diff --git a/docs/en/api/stats.html b/docs/en/api/stats.html
index 23c2baf81..74100d4db 100644
--- a/docs/en/api/stats.html
+++ b/docs/en/api/stats.html
@@ -6,7 +6,7 @@
- Statistics - FitTrackee 0.8.12 documentation
+ Statistics - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
diff --git a/docs/en/api/users.html b/docs/en/api/users.html
index 5f1ab9beb..fc1731dc2 100644
--- a/docs/en/api/users.html
+++ b/docs/en/api/users.html
@@ -6,7 +6,7 @@
- Users - FitTrackee 0.8.12 documentation
+ Users - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
-
+
diff --git a/docs/en/api/workouts.html b/docs/en/api/workouts.html
index 0ddba3a46..1d72cfe25 100644
--- a/docs/en/api/workouts.html
+++ b/docs/en/api/workouts.html
@@ -6,7 +6,7 @@
- Workouts - FitTrackee 0.8.12 documentation
+ Workouts - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
-
+
diff --git a/docs/en/changelog.html b/docs/en/changelog.html
index f938d7e43..76f3614f7 100644
--- a/docs/en/changelog.html
+++ b/docs/en/changelog.html
@@ -6,7 +6,7 @@
- Change log - FitTrackee 0.8.12 documentation
+ Change log - FitTrackee 0.8.13 documentation
@@ -169,7 +169,7 @@
