Project

General

Profile

Feature #44426 » 0003-Document-the-bootsnap-cache-in-doc-INSTALL.patch

Go MAEDA, 2026-09-07 12:00

View differences:

doc/INSTALL
117 117
SSL enforcement, or custom Active Job adapters. Restart the application
118 118
after editing this file.
119
== Boot cache
120

  
121
Redmine uses bootsnap to speed up its startup. On the first start it writes
122
a cache of compiled Ruby files and resolved load paths under tmp/cache, and
123
later starts reuse it. The cache can be deleted at any time by running:
124
  bin/rails tmp:cache:clear
125

  
126
It is rebuilt on the next start.
127

  
128
If tmp/cache is on slow storage, such as a network file system, reading the
129
cache can take longer than the work it saves, and startup gets slower
130
instead of faster. In that case, move the cache to local storage by setting
131
the environment variable BOOTSNAP_CACHE_DIR to a directory that the user
132
running Redmine can write to, for example:
133
  BOOTSNAP_CACHE_DIR=/var/cache/redmine bin/rails server -e production
134

  
135
The cache then lives in a "bootsnap" subdirectory there, which
136
`bin/rails tmp:cache:clear` does not remove; delete it yourself when you
137
want to clear the cache.
138

  
139
Alternatively, start Redmine without the cache by setting DISABLE_BOOTSNAP=1:
140
  DISABLE_BOOTSNAP=1 bin/rails server -e production
141

  
119 142
== Database server configuration
120 143
When using MySQL with Redmine 5.1.1 or later, it is necessary to change
(3-3/3)