bump to version 0.7.13

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 566 KiB

After

Width:  |  Height:  |  Size: 568 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 386 KiB

After

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 216 KiB

After

Width:  |  Height:  |  Size: 218 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 83 KiB

View File

@ -1,5 +1,5 @@
Authentication
##############
Authentication and account
##########################
.. autoflask:: fittrackee:create_app()
:endpoints:

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
@ -104,39 +139,3 @@ Modify a user account (admin rights, active status, email and password).
- Reset user password (a new password will be displayed).
* - ``--update-email EMAIL``
- Update user email.
``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 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.

View File

@ -74,7 +74,7 @@ Workouts
Account & preferences
^^^^^^^^^^^^^^^^^^^^^
- A user can create, update and deleted his account.
- The user must accept the privacy policy to register. If the privacy change, a message is displayed on the dashboard to review the new version and validate it (*new in 0.7.13*).
- 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*).
@ -99,7 +99,11 @@ 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*).
- | 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
@ -138,10 +142,10 @@ The following parameters can be set:
(*new in 0.7.13*)
| 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 and validate it.
| 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.
.. note::
Only the default privacy policy is translated (if translation is available).
Only the default privacy policy is translated (if the translation is available).
Users
"""""

View File

@ -33,15 +33,15 @@ Prerequisites
- `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).
| On other OS, some issues can be encountered and adaptations may be
necessary.
.. warning::
| If registration is enabled, it is recommended to set Redis and a SMTP provider for email sending and data export requests.
Environment variables
~~~~~~~~~~~~~~~~~~~~~
@ -276,7 +276,7 @@ Emails sent by FitTrackee are:
- password reset request
- email change (to old and new email adresses)
- password change
- when a data export archive is ready to download (*new in 0.7.13*)
- notification when a data export archive is ready to download (*new in 0.7.13*)
.. versionchanged:: 0.6.5
@ -298,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
@ -507,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
@ -633,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>`__).