Commit graph

118 commits

Author SHA1 Message Date
Baptiste Jonglez
7d30794420 security docs: Clarify what is possible with a token 2023-07-29 14:02:49 +02:00
Baptiste Jonglez
3e5cd9e04e API docs: new current_password field 2023-07-29 14:02:49 +02:00
Baptiste Jonglez
4d3bcf69d3 Update security docs for the new feed token 2023-07-28 17:34:34 +02:00
Zottelchen
fc3ceba216 Update configuration.md
Fix minimal typo, tripping me (and most likely others) during setup. (e.g. #854)
2023-07-11 23:15:27 +02:00
50d1bce3a5 [Doc] Include minimal steps to get started.
Thanks to @natim for the issue.
2023-01-08 16:00:16 +01:00
Glandos
d8b6355101
Update Python (#1083)
* drop python3.6

* update github python actions and use pip cache

* we use setup.cfg not requirements.txt

* add python 3.11. Still in RC for now

* use latest 3.11 version

* 3.11 is strill RC for now

* go back to include key that match original py version

this shouldn't fail

* upgrade psycopg2 for python 3.11

Upgrade for all, it's a minor version

* update documentation for python 3.11 support

* update version

* 3.11 is out

Right on time!
2022-11-08 00:10:21 +01:00
ffcc0a717a Fix broken link to CHANGELOG in the docs. 2022-08-09 19:52:49 +02:00
Baptiste Jonglez
70790386cc Prepare changelog for 5.2.0 release 2022-04-07 21:23:25 +02:00
Glandos
5f4f69bc6c
Convert MAIL_DEFAULT_SENDER to a string (#1007)
Fixes #1005
2022-04-07 21:15:48 +02:00
9b1dfa38f3 Document cookies settings when using local Docker.
Secure Session Cookies must be disabled when running things
locally and using localhost.

Fix #979.
2022-03-08 22:28:28 +01:00
Nicolas Ferrari
5cb53f1fce
Cloud Providers list (#998)
* Add Cloud Providers
* Link to Cloud Providers
2022-03-07 17:21:56 +01:00
Peter Maksymowsky
a5452ccee5
Display admin email in error message for password reminder (#965)
Co-authored-by: Glandos <bugs-github@antipoul.fr>
2022-01-30 15:33:54 +01:00
Peter Maksymowsky
470c19fe4d
List supported currencies in API under api/currencies (#961)
* List supported currencies in API under api/currencies

* Added test for /currencies route
2021-12-13 23:25:25 +01:00
9ac4418486
Convert all the rst files to markdown. (#906)
Update sphinx to work with the new format.

https://myst-parser.readthedocs.io/en/latest/sphinx/use.html#automatically-create-targets-for-section-headers
was a valuable resource along the way.

Fixes #902.
2021-11-01 20:09:55 +01:00
zorun
6750e4f429
Update release documentation (#893)
Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
2021-10-30 21:23:27 +02:00
Glandos
ff4de78b56
Reduce the size of showcase images (#899)
Fixes #875

Original showcase images are kept in another directory, and compressed
in webp in the distributed directory.
Since they won't change so much, let's keep them in git.
2021-10-30 17:30:59 +02:00
d2c96c5bc6
Enhance Docker documentation. (#882)
* Enhance Docker documentation.

Fixes #868

* Adress @zorun feedback.

* Update installation.rst
2021-10-22 17:56:41 +02:00
53c88c3b13
Add a LEGAL_LINK setting. Fixes #761 (#883) 2021-10-21 19:16:32 +02:00
2b7a6f31a2 @zorun feedback. 2021-10-21 09:16:00 +02:00
34577f73cb Update release instructions. 2021-10-21 09:16:00 +02:00
3fd69f2267
Prepare 5.0 (#866)
* Update changelog.

Based on the work done in #570 and #834 by @Natim and @Glandos.

* Update contributing.rst release instructions.

* Update documentation configuration.

* Update translations

* Update translation strings

* Preparing release 5.0.0

* Back to development: 5.0.1
2021-10-19 23:01:29 +02:00
zorun
6a0533e517
Add some documentation about security (#858)
Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
2021-10-14 23:45:22 +02:00
Baptiste Jonglez
dc793effce Update API doc 2021-10-14 00:07:41 +02:00
2bcc41bdb3
Add optional support for a simple CAPTCHA. (#844)
* Add optional support for a simple CAPTCHA.
* formatting
* add test case
* Flake8

Co-authored-by: Glandos <bugs-github@antipoul.fr>
2021-10-11 17:39:24 +02:00
Baptiste Jonglez
e626a1cbea Implement security best practices using Flask-Talisman 2021-10-10 22:06:33 +02:00
Baptiste Jonglez
c1ef4033b6 Better document configuration files location and override 2021-10-10 18:34:24 +02:00
Erik Kristofer Anderson
49d79033b4 update api output (For issue #782)
Updated the example API output for "Getting information about the project" in the documentation.
2021-08-01 16:30:14 +02:00
George Thomas
b94fc08138
Miscellaneous improvements to installation instructions (#819)
Co-authored-by: Glandos <bugs-github@antipoul.fr>
2021-07-28 22:32:55 +02:00
Baptiste Jonglez
9a5badd3be docs: Add SQLAlchemy workaround to install current release 2021-07-20 19:39:21 +02:00
Raju Subramanian
942617a436 Change Dockerfile to compile python dependencies at build time.
- Updated entrypoint.sh
- Updated docs for running with Docker
- Added .dockerignore
2021-07-14 18:01:34 +02:00
Baptiste Jonglez
e25bc6825d Document how to generate and use tokens with the API 2021-07-14 13:37:24 +02:00
Glandos
31a9ed29f6 bump pymysql upper bound 2021-07-12 23:42:31 +02:00
Baptiste Jonglez
def6dba825 Replace MySQL by MariaDB in all documentation / README / changelog
Also document the new requirement for MariaDB >= 10.3.2

Fixes: #632
Fixes: #743
2021-07-05 08:52:13 +02:00
Glandos
74e222f1a1 remove usage of Flask-Script
Use flask.cli instead with compatibility layer for existing commands,
such as "runserver".
2021-06-06 15:13:21 +02:00
Glandos
45f4d8f8b0 Using one job for all linting and doc generation
Requirements for doc are now an extra require in setup.cfg
2021-06-03 22:35:49 +02:00
Sanjay S S
d2b86e95f1
Fixed Typo in docs/index.rst (#751) 2021-05-22 21:31:40 +02:00
dependabot-preview[bot]
5cd25e2659
Bump docutils from 0.17 to 0.17.1 (#746)
Bumps [docutils](http://docutils.sourceforge.net/) from 0.17 to 0.17.1.

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-04-21 16:13:40 +02:00
dependabot-preview[bot]
5875f64773 Bump docutils from 0.16 to 0.17
Bumps [docutils](http://docutils.sourceforge.net/) from 0.16 to 0.17.

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-04-05 14:56:39 +02:00
dependabot-preview[bot]
5032e338ab Bump sphinx from 3.5.2 to 3.5.3
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.2 to 3.5.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-03-28 22:09:15 +02:00
dependabot-preview[bot]
30bebf0a33 Bump sphinx from 3.5.1 to 3.5.2
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.5.1 to 3.5.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.5.1...v3.5.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-03-17 20:27:09 +01:00
dependabot-preview[bot]
e017a7a95b
Bump sphinx from 3.4.3 to 3.5.1 (#720)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.4.3 to 3.5.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.4.3...v3.5.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-17 09:53:24 +01:00
dependabot-preview[bot]
8df29a9adf
Bump sphinx from 3.4.2 to 3.4.3 (#709)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.4.2 to 3.4.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.4.2...v3.4.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-01-10 19:18:24 +01:00
dependabot-preview[bot]
e0bc285c92
Bump sphinx from 3.3.1 to 3.4.2 (#707)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.3.1 to 3.4.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.3.1...v3.4.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-01-05 21:58:59 +01:00
Glandos
0380521b4a Add python3.9 support 2020-11-24 22:52:46 +01:00
Baptiste Jonglez
384d3eeb2c Document timezone settings 2020-11-13 21:40:39 +01:00
dependabot-preview[bot]
de13945a91
Bump sphinx from 3.3.0 to 3.3.1 (#696)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.3.0 to 3.3.1.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.3.0...v3.3.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-11-13 21:37:32 +01:00
dependabot-preview[bot]
d417336d02
Bump sphinx from 3.1.2 to 3.3.0 (#692)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.1.2 to 3.3.0.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.1.2...v3.3.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-11-04 20:35:20 +01:00
Jocelyn Delalande
55bce593f0 Use venv module rather than virtualenv
- simpler to use
- lighter dependency (or no dependency at all, depending on python distribution)
- retrocompatible

virtualenv package from pip to acheive virtual environment feature is no longer
needed, except for projects which need to support py2, which is no longer our
case.

Also, reword "virtualenv" to "virtual environment" in doc, to avoid confusion
with pip package name.

Ref #483
2020-07-26 20:14:59 +02:00
Jocelyn Delalande
48fabc346f Document how to switch python version for 5.x
Focus is on rebuilding venv (which are bound to a specific python minor
version).

Ref #483
Ref #571
2020-07-26 20:14:59 +02:00
dependabot-preview[bot]
879289608b Bump sphinx from 3.1.1 to 3.1.2
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 3.1.1 to 3.1.2.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v3.1.1...v3.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-07-18 00:42:07 +02:00