Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bump to version 0.7.13

Browse Source
This commit is contained in:
Sam
2023-03-05 14:26:31 +01:00
parent 510cfd2c0b
commit d57133f839
97 changed files with 1172 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/_sources/api/auth.rst.txt
View File

@ -1,5 +1,5 @@
Authentication
##############
Authentication and account
##########################
.. autoflask:: fittrackee:create_app()
:endpoints:
@ -18,4 +18,8 @@ Authentication
auth.update_user_account,
auth.update_password,
auth.update_email,
auth.logout_user
auth.logout_user,
auth.accept_privacy_policy,
auth.get_user_data_export,
auth.request_user_data_export,
auth.download_data_export

37
docs/_sources/changelog.md.txt
View File

@ -1,5 +1,42 @@
# Change log
## Version 0.7.13 (2023/03/05)
This version allows to display the instance privacy policy. A user must agree to the privacy policy to register.
A default policy is available and a custom policy can be defined in the administration.
**Note:** After **FitTrackee** upgrade, a message will be displayed to all users in order to review the policy.
A user can now request a data export (containing user info, workout data and uploaded gpx files).
Lastly, additional information that may be useful to users can be displayed in **About** page.
### Features and enhancements
* [#301](https://github.com/SamR1/FitTrackee/issues/301) - add privacy policy
* [#304](https://github.com/SamR1/FitTrackee/issues/304) - add user data export
* [#305](https://github.com/SamR1/FitTrackee/issues/305) - add additional information in About page
### Bugs Fixed
* [PR#307](https://github.com/SamR1/FitTrackee/pull/307) - Minor fixes
* update workout and map files name
* fix error message when api is not running
* fix modal position
### Translations
* [PR#297](https://github.com/SamR1/FitTrackee/pull/297) - Translations update from Hosted Weblate (Dutch)
* [PR#308](https://github.com/SamR1/FitTrackee/pull/308) - Translations update from Hosted Weblate (Dutch)
* [PR#310](https://github.com/SamR1/FitTrackee/pull/310) - Translations update from Hosted Weblate (Dutch and German)
Thanks to the contributors:
- @bjornclauw
- @qwerty287
**Note:** This release contains database migration (see upgrade instructions in [documentation](https://samr1.github.io/FitTrackee/installation.html#upgrade))
## Version 0.7.12 (2023/02/16)
### Translations

49
docs/_sources/cli.rst.txt
View File

@ -28,13 +28,6 @@ A command line interface (CLI) is available to manage database, OAuth2 tokens an
Database
~~~~~~~~
``ftcli db upgrade``
""""""""""""""""""""
.. versionadded:: 0.6.5
Apply migrations.
``ftcli db drop``
"""""""""""""""""
.. versionadded:: 0.6.5
@ -42,6 +35,13 @@ Apply migrations.
Empty database and delete uploaded files, only on development environments.
``ftcli db upgrade``
""""""""""""""""""""
.. versionadded:: 0.6.5
Apply migrations.
OAuth2
~~~~~~
@ -66,6 +66,23 @@ Remove tokens expired for more than provided number of days
Users
~~~~~
``ftcli users clean_archives``
""""""""""""""""""""""""""""""
.. versionadded:: 0.7.13
Delete export requests and related archives created more than provided number of days.
.. cssclass:: table-bordered
.. list-table::
:widths: 25 50
:header-rows: 1
* - Options
- Description
* - ``--days``
- Number of days.
``ftcli users clean_tokens``
""""""""""""""""""""""""""""
.. versionadded:: 0.7.0
@ -83,6 +100,24 @@ Remove blacklisted tokens expired for more than provided number of days.
- Number of days.
``ftcli users export_archives``
"""""""""""""""""""""""""""""""
.. versionadded:: 0.7.13
Process incomplete user export requests.
Can be used if redis is not set (no dramatiq workers running).
.. cssclass:: table-bordered
.. list-table::
:widths: 25 50
:header-rows: 1
* - Options
- Description
* - ``--max``
- Maximum number of export requests to process.
``ftcli users update``
""""""""""""""""""""""
.. versionadded:: 0.6.5

73
docs/_sources/features.rst.txt
View File

@ -74,9 +74,10 @@ Workouts
Account & preferences
^^^^^^^^^^^^^^^^^^^^^
- A user can create, update and deleted his account.
- The user must agree to the privacy policy to register. If a more recent policy is available, a message is displayed on the dashboard to review the new version (*new in 0.7.13*).
- On registration, the user account is created with selected language in dropdown as user preference (*new in 0.6.9*).
- After registration, the user account is inactive and an email with confirmation instructions is sent to activate it.
A user with an inactive account cannot log in. (*new in 0.6.0*)
A user with an inactive account cannot log in. (*new in 0.6.0*).
.. note::
In case email sending is not configured, a `command line <cli.html#ftcli-users-update>`__ allows to activate users account.
@ -98,42 +99,70 @@ Account & preferences
| A workout with a disabled sport will still be displayed in the application.
- A user can create `clients <apps.html>`__ for third-party applications (*new in 0.7.0*).
- | A user can request a data export (*new in 0.7.13*).
| It generates a zip archive containing 2 ``json`` files (user info and workouts data) and all uploaded gpx files.
.. note::
For now, it's not possible to import these files into another **FitTrackee** instance.
Administration
^^^^^^^^^^^^^^
(*new in 0.3.0*)
- **Application**
Application
"""""""""""
The following parameters can be set:
**Configuration**
- active users limit. If 0, registration is enabled (no limit defined)
- maximum size of gpx file (individually uploaded or in a zip archive) (*changed in 0.7.4*)
- maximum size of zip archive
- maximum number of files in the zip archive (*changed in 0.7.4*)
- administrator email for contact (*new in 0.6.0*)
The following parameters can be set:
.. warning::
Updating server configuration may be necessary to handle large files (like `nginx <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_ for instance).
- active users limit. If 0, registration is enabled (no limit defined).
- maximum size of gpx file (individually uploaded or in a zip archive) (*changed in 0.7.4*)
- maximum size of zip archive
- maximum number of files in the zip archive (*changed in 0.7.4*)
- administrator email for contact (*new in 0.6.0*)
.. note::
If email sending is disabled, a warning is displayed.
.. warning::
Updating server configuration may be necessary to handle large files (like `nginx <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_ for instance).
.. note::
If email sending is disabled, a warning is displayed.
**About**
(*new in 0.7.13*)
| It is possible displayed additional information that may be useful to users in **About** page.
| Markdown syntax can be used.
- **Users**
**Privacy policy**
- display and filter users list
- edit a user to:
- add/remove administration rights
- activate his account (*new in 0.6.0*)
- update his email (in case his account is locked) (*new in 0.6.0*)
- reset his password (in case his account is locked) (*new in 0.6.0*). If email sending is disabled, it is only possible via CLI.
- delete a user
(*new in 0.7.13*)
- **Sports**
| A default privacy policy is available (originally adapted from the `Discourse <https://github.com/discourse/discourse>`__ privacy policy).
| A custom privacy policy can set if needed (Markdown syntax can be used). A policy update will display a message on users dashboard to review it.
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
.. note::
Only the default privacy policy is translated (if the translation is available).
Users
"""""
- display and filter users list
- edit a user to:
- add/remove administration rights
- activate his account (*new in 0.6.0*)
- update his email (in case his account is locked) (*new in 0.6.0*)
- reset his password (in case his account is locked) (*new in 0.6.0*). If email sending is disabled, it is only possible via CLI.
- delete a user
Sports
""""""
- enable or disable a sport (a sport can be disabled even if workout with this sport exists)
Translations

29
docs/_sources/installation.rst.txt
View File

@ -26,13 +26,16 @@ Prerequisites
- Python 3.7+
- PostgreSQL 11+
- optional
- Redis for task queue (if email sending is enabled) and API rate limits
- 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 <installation.html#weather-data>`__
- `Poetry <https://poetry.eustace.io>`__ (for installation from sources only)
- `Yarn <https://yarnpkg.com>`__ (for development only)
- Docker and Docker Compose (for development or evaluation purposes)
.. note::
| If registration is enabled, it is recommended to set Redis and a SMTP provider for email sending and data export requests.
.. note::
| The following steps describe an installation on Linux systems (tested
on Debian and Arch).
@ -273,11 +276,13 @@ Emails sent by FitTrackee are:
- password reset request
- email change (to old and new email adresses)
- password change
- notification when a data export archive is ready to download (*new in 0.7.13*)
.. versionchanged:: 0.6.5
| For single-user instance, it is possible to disable email sending with an empty ``EMAIL_URL`` (in this case, no need to start dramatiq workers).
| A `CLI <cli.html#ftcli-users-update>`__ is available to activate account and modify email and password.
For single-user instance, it is possible to disable email sending with an empty ``EMAIL_URL`` (in this case, no need to start dramatiq workers).
A `CLI <cli.html#ftcli-users-update>`__ is available to activate account, modify email and password and handle data export requests.
Map tile server
@ -293,7 +298,7 @@ To keep using **ThunderForest Outdoors**, the configuration is:
- ``MAP_ATTRIBUTION=&copy; <a href="http://www.thunderforest.com/">Thunderforest</a>, &copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors``
.. note::
| Check the terms of service of tile provider for map attribution
| Check the terms of service of tile provider for map attribution.
.. versionchanged:: 0.6.10
@ -502,13 +507,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.7.12):
- Download the last release (for now, it is the release v0.7.13):
.. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.12.tar.gz
$ tar -xzf v0.7.12.tar.gz
$ mv FitTrackee-0.7.12 FitTrackee
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.13.tar.gz
$ tar -xzf v0.7.13.tar.gz
$ mv FitTrackee-0.7.13 FitTrackee
$ cd FitTrackee
- Create **.env** from example and update it
@ -628,13 +633,13 @@ Prod environment
- Change to the directory where FitTrackee directory is located
- Download the last release (for now, it is the release v0.7.12) and overwrite existing files:
- Download the last release (for now, it is the release v0.7.13) and overwrite existing files:
.. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.12.tar.gz
$ tar -xzf v0.7.12.tar.gz
$ cp -R FitTrackee-0.7.12/* FitTrackee/
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.13.tar.gz
$ tar -xzf v0.7.13.tar.gz
$ cp -R FitTrackee-0.7.13/* FitTrackee/
$ cd FitTrackee
- Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).