Skip to content

Commit 09c5bab

Browse files
authored
docs(admin): document HTTP 503 to simulate maintenance for clients
Signed-off-by: whoalin1 <whoalin414@gmail.com>
1 parent 2de9481 commit 09c5bab

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

‎admin_manual/maintenance/index.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,22 @@ Maintenance
1313
package_upgrade
1414
migrating
1515
migrating_owncloud
16+
17+
18+
Simulating maintenance mode for clients
19+
---------------------------------------
20+
21+
When Nextcloud is fully stopped or taken offline for infrastructure work, it can
22+
no longer serve its normal status payload that tells desktop and mobile clients
23+
the instance is in maintenance mode.
24+
25+
In that situation, configure the reverse proxy or load balancer to answer
26+
client-facing Nextcloud endpoints with **HTTP 503 Service Unavailable**. Clients
27+
treat a 503 the same way as Nextcloud's built-in maintenance mode and will back
28+
off instead of surfacing hard sync errors.
29+
30+
Examples of endpoints clients hit include ``status.php``, ``index.php``, and
31+
WebDAV / OCS URLs under your Nextcloud base path.
32+
33+
For application-level maintenance while PHP is still running, prefer
34+
``occ maintenance:mode --on`` (see :doc:`../configuration_server/config_sample_php_parameters`).

0 commit comments

Comments
 (0)