DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:cleanup

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin:cleanup [2015-11-02 08:29]
175.171.152.104 created
plugin:cleanup [2020-08-05 10:32] (current)
LMS23
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description:  +description: Perform file cleanup in the wiki 
-author     :   +author     : Andreas Gohr  
-email      :   +email      : dokuwiki@cosmocode.de 
-type       :  +type       : action, helper, admin 
-lastupdate : 2015-11-02 +lastupdate : 2016-07-06 
-compatible : +compatible : weatherwax, binky, Hrun, Detritus, Frusterick Manners, 2018-04-22 "Greebo", Hogfather
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : +tags       : cleanup, maintenance
  
-downloadurl: # eg. http://github.com//dokuwiki-plugin-cleanup/zipball/master +downloadurl: https://github.com/cosmocode/dokuwiki-plugin-cleanup/zipball/master 
-bugtracker : # eg. http://github.com//dokuwiki-plugin-cleanup/issues +bugtracker : https://github.com/cosmocode/dokuwiki-plugin-cleanup/issues 
-sourcerepo : # eg. http://github.com//dokuwiki-plugin-cleanup/+sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-cleanup/
 donationurl:  donationurl: 
  
Line 21: Line 21:
 ---- ----
  
-//:!: This template contains various hints on how to fill in data (formatted in italics)Be sure to remove the hints and unwanted sections (Egthe Syntax/Example section for non-syntax plugins.//+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|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 ===== ===== Installation =====
  
-//[First, last and only chance to warn users before installing (some has already done that before reading this)]// +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- +
-:!: **External requirements:** This plugin requires the following additional components that must be installed separately:  +
-  * [[A banana]] +
-  * [[Another banana]] +
- +
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually. +
- +
-===== Examples/Usage ===== +
- +
-//[Most people learn by example, so this goes first]// +
- +
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin. +
- +
-A simple box: +
- +
-  <box> the box contents </box> +
- +
-Some more complex boxes +
- +
-  <box 80% round orange|a title> the box contents</box> +
-  <box 50% left blue>the box contents</box|a caption> +
-  <box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption> +
- +
-//[Pictures showing the rendered result will help users to understand]// +
- +
-===== Syntax ===== +
- +
-//[Complete syntax]// +
- +
-Basic syntax: +
-<code>{{actionlink>action|title}}</code> +
-  * **action** can be one of this: +
-    * //edit//    --- edit/create/show +
-    * //history// --- old revisions +
- +
-===== Configuration and Settings ===== +
- +
-//[also CSS style tips]// +
- +
-===== Development ===== +
- +
-//[downloadable blocks, development comments]// +
- +
-=== Change Log === +
- +
-//[preferable GitHub RSS feed or similar]// +
- +
-  * **2009-01-01** +
-    * Initial release +
- +
-=== Known Bugs and Issues === +
- +
-//[this section might not be needed in case of external bug manager, or use RSS feed]// +
- +
-=== ToDo/Wish List ===+
  
-//[developers roadmap]//+===== Usage =====
  
-===== FAQ =====+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.
  
-//[discussions should ideally be deleted and turned into FAQ entries along the way]//+The following default ages are used in the plugin:
  
-===== Discussion =====+| 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 |
  
-//Could be placed on an external page (e.g. plugin:pluginname:discussion) to have distinction between user comments and author docs//+Please notefor cache files it is not possible to determine if a cache file is still in use. On systems where access times (atimeare available the configured time will be used to see when 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]]
plugin/cleanup.1446449373.txt.gz · Last modified: 2015-11-02 08:29 by 175.171.152.104