nextcloud / nextcloud/documentation

Clarify time until Nextcloud's maintenance mode takes effect

Open
#9,184 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop enhancement feature: caching feature: install and update feature: occ good first issue manual: admin
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

In the documentation for creating nextcloud backups you suggest to enable the maintenance mode before starting with the backup process to prevent data inconsistencies.

According to my experience activating the maintenance mode does not always have immediate effect. Only after waiting the time configured in the php configuration value
opcache.revalidate_freq
you can be sure that your nextcloud instance is really running in maintenance mode.

I suggest you should clarify this in the documentation, as automated backups taken by scripts might otherwise not be consistent, if the copying of files or the creation of a database dump is started immediately after enabling Nextcloud's maintenance mode (i.e., before it is effectively enabled). Another solution might be that the
php occ maintenance:mode --on
command blocks until maintenance mode is effectively enabled.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the backup documentation at docs.nextcloud.com/server/stable/admin_manual/maintenance/backup.html and review how it currently describes enabling maintenance mode. Check the interaction between php's opcache.revalidate_freq and php occ maintenance:mode --on; done means the backup instructions clearly explain when maintenance mode is effective and how scripts should account for that delay.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.