====== cleanup Plugin ======

---- plugin ----
description: Perform file cleanup in the wiki
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de
type       : action, helper, admin
lastupdate : 2016-07-06
compatible : weatherwax, binky, Hrun, Detritus, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
depends    : 
conflicts  : 
similar    : clearhistory
tags       : cleanup, maintenance

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-cleanup/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-cleanup/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-cleanup/
donationurl: 

screenshot_img : 
----

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png|A CosmoCode Plugin}}]]

This plugin can automatically or manually search the data directory for old and possibly unused files and delete them to make space available again.

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Usage =====

You can configure some times in the configuration manager. The actual work can be triggered from its own admin page where you can preview the affected files and start the deletion process. The cleanup can be automated by activating it in the configuration.

The following default ages are used in the plugin:

| cache files | 3 months |
| old page revisions | 2 months |
| old media revisions | 1 month |
| orphaned page meta data | 3 months |
| orphaned media meta data | 2 months |
| stale lock files | 30 minutes |

Please note: for cache files it is not possible to determine if a cache file is still in use. On systems where access times (atime) are available the configured time will be used to see when a cache file was last accessed. If atimes are not available the last modification date is used instead. This means it can happen that cache files get deleted that were still in use. However DokuWiki will simply recreate these files.

On large wikis the search process may take a long time and might time out before finishing. The automated process can optionally be run from command line by running the provided ''cron.php'' script.

===== See also =====

  * [[tips:maintenance]]