amazon s3 support implemented and kinda working

[ikiwiki.git] / doc / plugins / amazon_s3.mdwn

diff --git a/doc/plugins/amazon_s3.mdwn b/doc/plugins/amazon_s3.mdwn
index 855569b42d849436ca42e3e184fc95edc6173e23..f1887d97072258bf0f29917a94ae338426499112 100644 (file)
--- a/doc/plugins/amazon_s3.mdwn
+++ b/doc/plugins/amazon_s3.mdwn
@@ -11,6 +11,11 @@ modules and an Amazon S3 account to use this plugin.
 
 ## configuration
 
+Important note: You should seriously consider turning off `usedirs` before
+enabling this plugin. If `usedirs` is enabled, every page has to be stored
+in S3 *twice*, as "page/index.html" and as "page/". That will cost you
+money and bandwidth.
+
 This plugin uses the following settings in the setup file:
 
 * `amazon_s3_key_id` - Set to your public access key id.
@@ -35,6 +40,8 @@ Likewise, you will probably want to set the `url` in the setup file.
 The url can use the `foo.s3.amazonaws.com` domain name, or another domain
 name that is a CNAME for it.
 
+The `hardlink` config file setting is not compatible with this plugin.
+
 ## data transfer notes
 
 If you run 'ikiwiki -setup my.setup' to force a rebuild of your wiki, the