bump version to 0.7.0
Before Width: | Height: | Size: 550 KiB After Width: | Height: | Size: 550 KiB |
Before Width: | Height: | Size: 371 KiB After Width: | Height: | Size: 371 KiB |
Before Width: | Height: | Size: 206 KiB After Width: | Height: | Size: 206 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 105 KiB |
@ -9,9 +9,6 @@ To allow a third-party application to interact with API endpoints, an
|
||||
`OAuth2 <https://datatracker.ietf.org/doc/html/rfc6749>`_ client can be created
|
||||
in user settings ('apps' tab).
|
||||
|
||||
.. note::
|
||||
OAuth2 support is implemented with `Authlib <https://docs.authlib.org/en/latest/>`_ library.
|
||||
|
||||
.. warning::
|
||||
OAuth2 endpoints requiring authentication are not accessible by third-party
|
||||
applications (`documentation <api/oauth2.html>`__), only by FitTrackee
|
||||
@ -20,6 +17,7 @@ in user settings ('apps' tab).
|
||||
FitTrackee supports only `Authorization Code <https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.1>`_
|
||||
flow (with PKCE support).
|
||||
It allows to exchange an authorization code for an access token.
|
||||
The client ID and secret must be sent in the POST body.
|
||||
It is recommended to use `PKCE <https://datatracker.ietf.org/doc/html/rfc7636>`_
|
||||
to provide a better security.
|
||||
|
||||
@ -36,7 +34,20 @@ The following scopes are available:
|
||||
.. figure:: _images/fittrackee_screenshot-07.png
|
||||
:alt: OAuth2 client creation on FitTrackee
|
||||
|
||||
.. note::
|
||||
OAuth2 support is implemented with `Authlib <https://docs.authlib.org/en/latest/>`_ library.
|
||||
|
||||
.. warning::
|
||||
| If FitTrackee is running behind a proxy, the ``X-Forwarded-Proto`` header must be set.
|
||||
| For instance for `nginx`:
|
||||
|
||||
.. code-block::
|
||||
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
|
||||
Some resources about OAuth 2.0:
|
||||
|
||||
- `OAuth 2.0 Simplified <https://www.oauth.com>`_ by `Aaron Parecki <https://aaronparecki.com>`_
|
||||
- `Web App Example of OAuth 2 web application flow <https://requests-oauthlib.readthedocs.io/en/latest/examples/real_world_example.html>`_ with Requests-OAuthlib
|
||||
- `Web App Example of OAuth 2 web application flow <https://requests-oauthlib.readthedocs.io/en/latest/examples/real_world_example.html>`_ with Requests-OAuthlib (python)
|
||||
- `OAuth 2 Session <https://docs.authlib.org/en/latest/client/oauth2.html#oauth-2-session>`_ with Authlib (python)
|
||||
- `Minimal example of an application interacting with FitTrackee <https://codeberg.org/SamR1/ft-oauth-client>`_ (python)
|
@ -1,7 +1,7 @@
|
||||
Command line interface
|
||||
######################
|
||||
|
||||
A command line interface (CLI) is available to manage database and users.
|
||||
A command line interface (CLI) is available to manage database, OAuth2 tokens and users.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
@ -1,6 +1,14 @@
|
||||
Features
|
||||
########
|
||||
|
||||
| **FitTrackee** allows you to store and display gpx files and some statistics from your outdoor activities.
|
||||
| For now, this app is kind of a single-user application. Even if several users can register, a user can only view his own workouts.
|
||||
|
||||
Gpx files are stored in an upload directory (without encryption).
|
||||
|
||||
With the default configuration, `Open Street Map <https://www.openstreetmap.org>`__ is used as tile server in Workout detail and for static map generation.
|
||||
|
||||
|
||||
Workouts
|
||||
^^^^^^^^
|
||||
- 11 sports are supported:
|
||||
|
@ -60,7 +60,7 @@ deployment method.
|
||||
|
||||
**FitTrackee** host.
|
||||
|
||||
:default: 0.0.0.0
|
||||
:default: 127.0.0.1
|
||||
|
||||
|
||||
.. envvar:: PORT
|
||||
@ -477,13 +477,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.6.12):
|
||||
- Download the last release (for now, it is the release v0.7.0):
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ wget https://github.com/SamR1/FitTrackee/archive/v0.6.12.tar.gz
|
||||
$ tar -xzf v0.6.12.tar.gz
|
||||
$ mv FitTrackee-0.6.12 FitTrackee
|
||||
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.0.tar.gz
|
||||
$ tar -xzf v0.7.0.tar.gz
|
||||
$ mv FitTrackee-0.7.0 FitTrackee
|
||||
$ cd FitTrackee
|
||||
|
||||
- Create **.env** from example and update it
|
||||
@ -603,13 +603,13 @@ Prod environment
|
||||
|
||||
- Change to the directory where FitTrackee directory is located
|
||||
|
||||
- Download the last release (for now, it is the release v0.6.12) and overwrite existing files:
|
||||
- Download the last release (for now, it is the release v0.7.0) and overwrite existing files:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ wget https://github.com/SamR1/FitTrackee/archive/v0.6.12.tar.gz
|
||||
$ tar -xzf v0.6.12.tar.gz
|
||||
$ cp -R FitTrackee-0.6.12/* FitTrackee/
|
||||
$ wget https://github.com/SamR1/FitTrackee/archive/v0.7.0.tar.gz
|
||||
$ tar -xzf v0.7.0.tar.gz
|
||||
$ cp -R FitTrackee-0.7.0/* FitTrackee/
|
||||
$ cd FitTrackee
|
||||
|
||||
- Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).
|
||||
|