DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:maintenance

maintenance Plugin

Compatible with DokuWiki

Weatherwax

plugin Locks the site from writing and runs a maintenance script

Last updated on
2013-11-03
Provides
Admin, Action
Repository
Source

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Installation

Go to the Plugin Manager and download this plugin with the download URL above, and it's done.

Examples/Usage

1. Lock the site and run a custom maintenance script

  1. Go to the “maintenance plugin” page in the backend.
  2. Click on the “Lock” button to lock the site from writing.
  3. Log in your server and run some scripts, and wait until they are finished.
  4. Click on the “Unlock” button to unlock the site.

2. Run a pre-defined maintenance script and lock the site until it's finished

  1. Go to the config manager and make plugin»maintenance»script point to your custom script. (See bin/sample.sh for an example)
  2. Go to the “maintenance plugin” page in the backend and click on the “Start” button to run the script, the site is automatically locked and will be unlocked when it's finished.
  3. If something seems to go wrong, you can click on the “Stop” button to kill the script previously started.

3. Run a pre-defined maintenance script periodically and lock the site every time until it's finished

  1. Go to the config manager and make plugin»maintenance»script point to your custom script.
  2. Check the plugin»maintenance»script_auto button and set plugin»maintenance»script_auto_interval to an interval you like.
  3. The maintenance script will run automatically (and locks the site until it's finished) once your site is visited and it hadn't been run during the past interval seconds.
  4. It is advised that your maintenance script is set to sleep for a certain time until it's a rather non-busy time.

4. Other notice

  1. This plugin is designed under the Unix system, and is not guaranteed to work on Windows or other OS.

Change Log

Known Bugs and Issues

FAQ

Discussion

plugin/maintenance.txt · Last modified: 2016-01-13 14:32 by Aleksandr