Skip to content

Commit 7374653

Browse files
docs: Document maintenance mode
Add maintenance mode documentation to the advanced configuration guide, including how to enable and disable it with the root-level maint.txt file. Also fix the configuration overview bullet list formatting so the lists render correctly in the generated documentation. Assisted-by: OpenAI Codex (GPT-5)
1 parent 7bc264f commit 7374653

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

docs/source/ADVANCED-CONFIGURATION.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,34 @@ LibreBooking ignores the custom version and logs an error.
131131
132132
git describe --tags --long > config/custom-version.txt
133133
134+
Maintenance Mode
135+
----------------
136+
137+
LibreBooking can be placed into maintenance mode by creating a file named
138+
``maint.txt`` in the root directory of the installation.
139+
140+
When ``<INSTALL_DIR>/maint.txt`` exists, normal page rendering is replaced
141+
with a maintenance notice. This is useful during upgrades, database
142+
migrations, or other planned maintenance windows where users should not use
143+
the application.
144+
145+
**Enable maintenance mode**
146+
147+
.. code-block:: bash
148+
149+
touch maint.txt
150+
151+
**Disable maintenance mode**
152+
153+
.. code-block:: bash
154+
155+
rm maint.txt
156+
157+
The contents of ``maint.txt`` are not used. LibreBooking only checks whether
158+
the file exists. The maintenance notice text comes from the
159+
``MaintenanceNotice`` language string and can be customized with
160+
``config/lang-overrides.php``.
161+
134162
Application Advanced Settings
135163
-----------------------------
136164

docs/source/CONFIGURATION.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Basic Configuration
99
For new installations and common settings, see :doc:`BASIC-CONFIGURATION`.
1010

1111
This covers:
12+
1213
- Essential settings to get started
1314
- Database configuration
1415
- Email setup
@@ -22,10 +23,12 @@ Advanced Configuration
2223
For detailed configuration and advanced features, see :doc:`ADVANCED-CONFIGURATION`.
2324

2425
This covers:
26+
2527
- All configuration options in detail
2628
- Advanced email and logging settings
2729
- Schedule and reservation behavior
2830
- Security headers and authentication providers
31+
- Maintenance mode
2932
- API configuration
3033
- Plugin system
3134
- Performance tuning

0 commit comments

Comments
 (0)