]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/attachment.mdwn
Merge branch 'master'
[git.ikiwiki.info.git] / doc / plugins / attachment.mdwn
index 019d1c9e4c9bec9a4e62e84f5808c0ed35fb2293..ce04bcd2fce5d8a3983ffa85b7972d87ce06ab95 100644 (file)
@@ -1,4 +1,4 @@
-[[template id=plugin name=conditional core=1 author="[[Joey]]"]]
+[[template id=plugin name=attachment core=0 author="[[Joey]]"]]
 [[tag type/useful]]
 
 This plugin allows files to be uploaded to the wiki over the web.
@@ -20,34 +20,15 @@ Bear in mind that if you let anyone upload a particular kind of file
    contains html as a web page; including running any malicious javascript
    embedded in that page.
 
-To provide a way to combat these abuses, the wiki admin can specify a
-[[ikiwiki/PageSpec]] on their preferences page, to control what types of
-attachments can be uploaded. The regular [[ikiwiki/PageSpec]] syntax is
-expanded with additional tests.
+If you enable this plugin, be sure to lock that down, by entering an
+[[enhanced_PageSpec|ikiwiki/pagespec/attachment]] in the "Allowed
+Attachments" field of the wiki admin's preferences page.
 
-For example, to limit arbitrary files to 50 kilobtes, but allow
-larger mp3 files to be uploaded, a test like this could be used:
-  
-       (*.mp3 and maxsize(15mb)) or (!ispage() and maxsize(50kb))
+This plugin will use the [[cpan File::MimeInfo::Magic]] perl module, if
+available, for mimetype checking.
 
-The following additional tests are available:
-
-* maxsize(size)
-
-  Tests whether the attachment is no larger than the specified size.
-  The size defaults to being in bytes, but "kb", "mb", "gb" etc can be
-  used to specify the units.
-  
-* minsize(size)
-
-  Tests whether the attachment is no smaller than the specified size.
-
-* ispage()
-
-  Tests whether the attachment will be treated by ikiwiki as a wiki page.
-  (Ie, if it has an extension of ".mdwn", or of any other enabled page
-  format).
-
-  So, if you don't want to allow wiki pages to be uploaded as attachments,
-  use `!ispage()` ; if you only want to allow wiki pages to be uploaded
-  as attachments, use `ispage()`.
+The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that
+ikiwiki be configured with a virus scanner program via the `virus_checker`
+option in the setup file. If using `clamav`, with `clamd`, set it to
+"clamdscan -". Or to use clamav without the `clamd` daemon, you
+could set it to "clamscan -".