Skip to content

docs(admin): document HTTP 503 to simulate maintenance for clients #15734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
whoalin1 wants to merge 1 commit into from
Closed

docs(admin): document HTTP 503 to simulate maintenance for clients #15734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions admin_manual/maintenance/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,22 @@ Maintenance
package_upgrade
migrating
migrating_owncloud


Simulating maintenance mode for clients
---------------------------------------

When Nextcloud is fully stopped or taken offline for infrastructure work, it can
no longer serve its normal status payload that tells desktop and mobile clients
the instance is in maintenance mode.

In that situation, configure the reverse proxy or load balancer to answer
client-facing Nextcloud endpoints with **HTTP 503 Service Unavailable**. Clients
treat a 503 the same way as Nextcloud's built-in maintenance mode and will back
off instead of surfacing hard sync errors.

Examples of endpoints clients hit include ``status.php``, ``index.php``, and
WebDAV / OCS URLs under your Nextcloud base path.

For application-level maintenance while PHP is still running, prefer
``occ maintenance:mode --on`` (see :doc:`../configuration_server/config_sample_php_parameters`).
Loading