Project

General

Profile

Actions

Feature #41754

open

Add asset precompilation instructions to doc/INSTALL and doc/UPGRADING

Added by Go MAEDA 5 days ago. Updated 1 day ago.

Status:
New
Priority:
Normal
Category:
Documentation
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Resolution:

Description

This patch enhances the doc/INSTALL and doc/UPGRADING documentation to include steps for asset precompilation.

With the introduction of Propshaft in Redmine 6.0.0, stylesheets, JavaScript, and images must be compiled. If assets are not precompiled correctly, especially when deploying Redmine in a sub-URI, browsers will fail to load these resources.

This patch adds precompilation instructions to both the installation and upgrade guides to help administrators ensure a smooth setup of Redmine.


Files


Related issues

Related to Redmine - Defect #41734: wrong url for assets in public/assetsNew

Actions
Actions #1

Updated by Go MAEDA 5 days ago

  • Related to Defect #41734: wrong url for assets in public/assets added
Actions #2

Updated by Holger Just 5 days ago

Quoting from Redmine 6.0.0 is now available:

Assets are automatically recompiled in production mode when updates are found in order to not require an additional command, but you can disable this behavior from configuration (config.assets.redmine_detect_update)

Thus, I believe the currently intended approach is NOT to require precompilation.

However, as the assets may be recompiled on each start of Redmine (or only when performing a request? Marius, could you confirm this?), users may have to set the environment variable on each invocation.

We could/should however document how to precompile assets.

Actions #3

Updated by Go MAEDA 5 days ago

  • Target version changed from 6.0.2 to Candidate for next minor release

Holger Just wrote in #note-2:

Quoting from Redmine 6.0.0 is now available:

Assets are automatically recompiled in production mode when updates are found in order to not require an additional command, but you can disable this behavior from configuration (config.assets.redmine_detect_update)

Thus, I believe the currently intended approach is NOT to require precompilation.

Oh, I didn't know config.assets.redmine_detect_update.
I have to update the patch.

Actions #4

Updated by Marius BĂLTEANU 3 days ago

Holger Just wrote in #note-2:

Quoting from Redmine 6.0.0 is now available:

However, as the assets may be recompiled on each start of Redmine (or only when performing a request? Marius, could you confirm this?), users may have to set the environment variable on each invocation.

In production mode, only on startup it will compile/recompile the assets.

Actions #5

Updated by Marius BĂLTEANU 3 days ago

Go MAEDA wrote in #note-3:

Holger Just wrote in #note-2:

Quoting from Redmine 6.0.0 is now available:

Oh, I didn't know config.assets.redmine_detect_update.
I have to update the patch.

Yes, I think we should update the docs and RedmineInstall to mention about this configuration flag together with a recommendation. I don't find useful to disable this behaviour for a simple installation with one server.

Actions #6

Updated by Marius BĂLTEANU 1 day ago

  • Assignee set to Marius BĂLTEANU
  • Target version changed from Candidate for next minor release to 6.0.2
Actions

Also available in: Atom PDF