📝 Documentation: upgrade to 4.9.0

[Millefeuille42]

Breaking/Important changes

📂 Plugins

💥 Breaking change if you have activated any official backend plugin:

• tracim_backend_autoinvite
• tracim_backend_child_removal
• tracim_backend_parent_access

Due to #6252, official plugins have been changed and must be updated.
Best way to update them is to delete them and enable them. See: https://github.com/tracim/tracim/blob/develop/backend/official_plugins/README.md.
Don't forget to backup them if you made any custom changes.

Unofficial plugins must be updated. You can find some related information here: #6252.

🗄️ Migration

A new database migration add_period_to_summary_mail.
Depending on your environment, you might need to apply it manually with alembic upgrade head.
In a docker environment, it will be applied automatically.

🔧 Configuration update

⚙️ development.ini

💥 Breaking change: update the parameter email.notification.type_on_invitation

Location:

• On default install, backend/development.ini
• On docker install, /{docker-volume}/etc/development.ini

What has changed:

1. app.enabled now has new default value including contents/logbook.
   Related environment variable name : TRACIM_APP__ENABLED
2. email.notification.type_on_invitation doesn't allow the value summary anymore and now allow 3 new values: hourly, daily, weekly. New default value is daily.

Todo:

In development.ini, if app.enabled isn't commented, add contents/logbook to the list, to enable the new app.
Eg.:

app.enabled = contents/thread,contents/file,contents/html-document,contents/folder,contents/kanban,contents/todo,contents/logbook,agenda,share_content,upload_permission,gallery

In development.ini, if email.notification.type_on_invitation isn't commented and if the value is summary, replace it with daily. The behavior will be the same.

🐋 Docker

• The app logbook has also been added to Dockerfile env var DEFAULT_APP_LIST
• The path to development.ini with the var: ENV TRACIM_CONFIG__FILEPATH="/etc/tracim/development.ini" is set in the Dockerfile. It allows tracimcli to be used without specifying the config path with -c option.

🕮 color.json

💥 Mandatory if you have activated the app content/logbook in development.ini

Location:

• On default install, frontend/dist/assets/branding/color.json
• On docker /{docker-volume}/etc/branding/color.json

What has changed:
Added "contents/logbook": "#ff4081", to source file frontend/dist/assets/branding.sample/color.json.

Todo:
If you haven't changed this file, you can delete it and start Tracim, it'll be automatically recreated.
If you have changed it, manually add "contents/logbook": "#ff4081", to your color.json. You can set the color value you want.
Eg.:

{
  "primary": "#2f7d30",
  "sidebar": "#f3f3f3",
  "sidebar/logo": "#f3f3f3",
  "sidebar/font": "#252525",
  "contents/html-document": "#00CC00",
  "contents/thread": "#428BCA",
  "contents/file": "#ffa500",
  "contents/folder": "#414548",
  "contents/kanban": "#197474",
  "contents/logbook": "#ff4081",
  "agenda": "#0b166a",
  "gallery": "#999999"
}

✉️ send_summary_mails.sh

💥 Breaking change if you use the summary mail feature.

Location:

• On default install, tools_docker/Debian_Uwsgi/send_summary_mails.sh
• On docker /{docker-volume}/etc/send_summary_mails.sh

What has changed:
Tracimcli command periodic send-summary-mails to send summary mails has its parameters --since replaced with --email_notification_type. The new possible values are hourly, daily or weekly.

Todo:
If you haven't changed this file, you can delete it and start Tracim, it'll be automatically recreated.
If you have changed it, manually update the tracimcli command
Eg.:

tracimcli periodic send-summary-mails --email_notification_type $1

✉️ summary_body_html.mak

Location:
backend/tracim_backend/templates/mail/summary_body_html.mak

What has changed:
A new variable email_notification_type_string has been added to the mail template. It aims to display a different string depending on the mail summary configuration of the user. Previously, only a mail every 24h could be configured, now, a mail every hours, day or week can be configured.

If you set a custom mail template for the summary mail by changing the config email.notification.summary.template.html: You can update it.

⌛ cron_task_tracim_send_summary_mails

Location:

• On default install, tools_docker/Debian_Uwsgi/cron_task_tracim_send_summary_mails
• On docker /{docker-volume}/etc/cron_task_tracim_send_summary_mails

What has changed:
With the new periods for the summary mail, we now need 3 cron, one for each periods, instead of one.

Todo:
If you haven't changed this file, you can delete it and start Tracim, it'll be automatically recreated.
If you have changed it, manually update it. It should create 3 cron jobs, one each hours, one each day and one each week.
Eg.:

0 * * * * root /etc/tracim/send_summary_mails.sh hourly >> /var/tracim/logs/cron_task_tracim_send_summary_mails.log 2>&1
0 0 * * * root /etc/tracim/send_summary_mails.sh daily >> /var/tracim/logs/cron_task_tracim_send_summary_mails.log 2>&1
0 0 * * 0 root /etc/tracim/send_summary_mails.sh weekly >> /var/tracim/logs/cron_task_tracim_send_summary_mails.log 2>&1

🛣️ API Update

New routes:

• DELETE /api/workspaces/{workspace_id}/contents/{content_id}/permanently
• GET /api/workspaces/${spaceId}/role
• PUT /api/workspaces/{workspace_id}/threads/{content_id}/namespace

🖥️ New dependencies

New python dependencies have been added. They are listed in backend/requirements.txt and must be installed.

pyopenssl==24.0.0
cryptography==42.0.3
pysaml2==7.3.1
xmlschema==2.5.1
elementpath==4.1.5
async-timeout==4.0.3
redis==4.6.0
beaker @ git+https://github.com/algoo/beaker.git