rename plugin

[git.ikiwiki.info.git] / doc / plugins / attachment.mdwn

diff --git a/doc/plugins/attachment.mdwn b/doc/plugins/attachment.mdwn
index 184f5b5df55f2a71b1fa53281d8f931d16d45ee0..b04a04ad22467ac79a66d92d407c83b2b67d92e6 100644 (file)
--- a/doc/plugins/attachment.mdwn
+++ b/doc/plugins/attachment.mdwn
@@ -1,5 +1,5 @@
-[[template id=plugin name=conditional core=1 author="[[Joey]]"]]
-[[tag type/useful]]
+[[!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.
 
 
 This plugin allows files to be uploaded to the wiki over the web.
 


@@ -20,45 +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.
 
    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, and by whom. The regular [[ikiwiki/PageSpec]]
-syntax is expanded with additional tests.
+If you enable this plugin, be sure to lock it down, via the
+`allowed_attachments` setup file option. This is a special 
+[[enhanced_PageSpec|ikiwiki/pagespec/attachment]].

 
 

-For example, to limit arbitrary files to 50 kilobytes, but allow
-larger mp3 files to be uploaded by joey, a test like this could be
-used:
-  
-       (user(joey) and *.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()`.
-
-* user(username)
-
-  Tests whether the attachment is being uploaded by a user with the
-  specified username. If openid is enabled, an openid can also be put here.
-
-* ip(address)
-
-  Tests whether the attacment is being uploaded from the specified IP
-  address.
+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 -".