aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-05-07 23:15:43 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-05-07 23:15:43 -0400
commit9e6a4ccfddab3fc90ac8ce63522047fe85aeefcd (patch)
treed762f79bf34122e7b33a226237272383434e8f8d /doc
parent939885d5563129b69d9019f11e931a65141f01f8 (diff)
downloadikiwiki-9e6a4ccfddab3fc90ac8ce63522047fe85aeefcd.tar
ikiwiki-9e6a4ccfddab3fc90ac8ce63522047fe85aeefcd.tar.gz
amazon s3 support implemented and kinda working
pruning not yet implemented, however
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki.setup12
-rw-r--r--doc/plugins/amazon_s3.mdwn7
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index a151050e7..997dcd18e 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -171,4 +171,16 @@ use IkiWiki::Setup::Standard {
# For use with the pinger plugin, how many seconds to wait before
# timing out.
#pinger_timeout => 15.
+
+ # For use with the amazon S3 plugin, your public access key id.
+ #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+ # And a file holding your secret key. This file *must* not be
+ # readable by others!
+ #amazon_s3_key_file => "/home/me/.hide/.s3_key
+ # The globally unique name of the bucket to use to store the wiki.
+ #amazon_s3_bucket => "mywiki",
+ # A prefix to prepend to each page name.
+ #amazon_s3_prefix => "wiki/",
+ # Uncomment to use the S3 European datacenter.
+ #amazon_s3_location => "EU",
}
diff --git a/doc/plugins/amazon_s3.mdwn b/doc/plugins/amazon_s3.mdwn
index 855569b42..f1887d970 100644
--- 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