UPGRADE.md

# Upgrade

All instructions to upgrade this project from one release to the next will be
documented in this file. Upgrades must be run sequentially, meaning you should
not skip minor/major releases while upgrading (fix releases can be skipped).

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

For most upgrades, you just need to run the django migrations with
the following command inside your docker container:

`python manage.py migrate`

(Note : in your development environment, you can `make migrate`.)

## [Unreleased]

## [3.3.0] - 2025-05-22

⚠️ For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information.

The footer is now configurable from a customization file. To override the default one, you can
use the `THEME_CUSTOMIZATION_FILE_PATH` environment variable to point to your customization file.
The customization file must be a JSON file and must follow the rules described in the
[theming documentation](docs/theming.md).

## [3.0.0] - 2025-03-28

We are not using the nginx auth request anymore to access the collaboration server (`yProvider`)
The authentication is now managed directly from the yProvider server. 
You must remove the annotation `nginx.ingress.kubernetes.io/auth-url` from the `ingressCollaborationWS`.

This means as well that the yProvider server must be able to access the Django server.
To do so, you must set the `COLLABORATION_BACKEND_BASE_URL` environment variable to the `yProvider`
service.

## [2.2.0] - 2025-02-10

- AI features are now limited to users who are authenticated. Before this release, even anonymous
  users who gained editor access on a document with link reach used to get AI feature.
  IF you want anonymous users to keep access on AI features, you must now define the
  `AI_ALLOW_REACH_FROM` setting to "public".
✨(project) first proof of concept printing pdf from markdown This is a boilerplate inspired from https://github.com/openfun/joanie 2024-01-09 15:30:36 +01:00			`# Upgrade`

			`All instructions to upgrade this project from one release to the next will be`
			`documented in this file. Upgrades must be run sequentially, meaning you should`
			`not skip minor/major releases while upgrading (fix releases can be skipped).`

			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),`
			`and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`

			`For most upgrades, you just need to run the django migrations with`
			`the following command inside your docker container:`

			`python manage.py migrate`

			(Note : in your development environment, you can `make migrate`.)

			`## [Unreleased]`
🔧(backend) make AI feature reach configurable We want to be able to define whether AI features are available to anonymous users who gained editor access on a document, or if we demand that they be authenticated or even if we demand that they gained their editor access via a specific document access. Being authenticated is now the default value. This will change the default behavior on your existing instance (see UPGRADE.md) 2025-02-11 08:45:21 +01:00
🔖(minor) release 3.3.0 Added: - ✨(backend) add endpoint checking media status - ✨(backend) allow setting session cookie age via env var - ✨(backend) allow theme customnization using a configuration file - ✨(frontend) Add a custom callout block to the editor - 🚩(frontend) version MIT only - ✨(backend) integrate maleware_detection from django-lasuite - 🏗️(frontend) Footer configurable - 🩺(CI) add lint spell mistakes - ✨(frontend) create generic theme - 🛂(frontend) block edition to not connected users - 🚸(frontend) Let loader during upload analyze - 🚩(frontend) feature flag on blocking edition Changed: - 📝(frontend) Update documentation - ✅(frontend) Improve tests coverage - ⬆️(docker) upgrade backend image to python 3.13 - ⬆️(docker) upgrade node images to alpine 3.21 Fixed: - 🐛(y-provider) increase JSON size limits for transcription conversion Removed: - 🔥(back) remove footer endpoint 2025-05-22 16:56:19 +02:00			`## [3.3.0] - 2025-05-22`

✏️(project) fix typo Fix and improve typos in the codebase. 2025-05-26 10:27:17 +02:00			⚠️ For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information.
🔖(minor) release 3.3.0 Added: - ✨(backend) add endpoint checking media status - ✨(backend) allow setting session cookie age via env var - ✨(backend) allow theme customnization using a configuration file - ✨(frontend) Add a custom callout block to the editor - 🚩(frontend) version MIT only - ✨(backend) integrate maleware_detection from django-lasuite - 🏗️(frontend) Footer configurable - 🩺(CI) add lint spell mistakes - ✨(frontend) create generic theme - 🛂(frontend) block edition to not connected users - 🚸(frontend) Let loader during upload analyze - 🚩(frontend) feature flag on blocking edition Changed: - 📝(frontend) Update documentation - ✅(frontend) Improve tests coverage - ⬆️(docker) upgrade backend image to python 3.13 - ⬆️(docker) upgrade node images to alpine 3.21 Fixed: - 🐛(y-provider) increase JSON size limits for transcription conversion Removed: - 🔥(back) remove footer endpoint 2025-05-22 16:56:19 +02:00
			`The footer is now configurable from a customization file. To override the default one, you can`
			use the `THEME_CUSTOMIZATION_FILE_PATH` environment variable to point to your customization file.
			`The customization file must be a JSON file and must follow the rules described in the`
			`[theming documentation](docs/theming.md).`

🔖(major) release 3.0.0 Added: - 📄(legal) Require contributors to sign a DCO Changed: - ♻️(frontend) Integrate UI kit - 🏗️(y-provider) manage auth in y-provider app Fixed: - 🐛(backend) compute ancestor_links in get_abilities if needed - 🔒️(back) restrict access to document accesses 2025-03-28 12:11:16 +01:00			`## [3.0.0] - 2025-03-28`

			We are not using the nginx auth request anymore to access the collaboration server (`yProvider`)
			`The authentication is now managed directly from the yProvider server.`
			You must remove the annotation `nginx.ingress.kubernetes.io/auth-url` from the `ingressCollaborationWS`.

			`This means as well that the yProvider server must be able to access the Django server.`
			To do so, you must set the `COLLABORATION_BACKEND_BASE_URL` environment variable to the `yProvider`
			`service.`

			`## [2.2.0] - 2025-02-10`

🔧(backend) make AI feature reach configurable We want to be able to define whether AI features are available to anonymous users who gained editor access on a document, or if we demand that they be authenticated or even if we demand that they gained their editor access via a specific document access. Being authenticated is now the default value. This will change the default behavior on your existing instance (see UPGRADE.md) 2025-02-11 08:45:21 +01:00			`- AI features are now limited to users who are authenticated. Before this release, even anonymous`
			`users who gained editor access on a document with link reach used to get AI feature.`
			`IF you want anonymous users to keep access on AI features, you must now define the`
			`AI_ALLOW_REACH_FROM` setting to "public".