aboutsummaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/amazon_s3.pm
diff options
context:
space:
mode:
Diffstat (limited to 'IkiWiki/Plugin/amazon_s3.pm')
-rw-r--r--IkiWiki/Plugin/amazon_s3.pm12
1 files changed, 5 insertions, 7 deletions
diff --git a/IkiWiki/Plugin/amazon_s3.pm b/IkiWiki/Plugin/amazon_s3.pm
index 9cb74fb1e..d9279b680 100644
--- a/IkiWiki/Plugin/amazon_s3.pm
+++ b/IkiWiki/Plugin/amazon_s3.pm
@@ -44,21 +44,20 @@ sub getsetup () { #{{{
return
amazon_s3_key_id => {
type => "string",
- default => "",
+ example => "XXXXXXXXXXXXXXXXXXXX",
description => "public access key id",
safe => 1,
rebuild => 0,
},
amazon_s3_key_id => {
type => "string",
- default => "",
- description => "file holding secret key",
+ example => "$ENV{HOME}/.s3_key",
+ description => "file holding secret key (must not be readable by others!)",
safe => 0, # ikiwiki reads this file
rebuild => 0,
},
amazon_s3_bucket => {
type => "string",
- default => "",
example => "mywiki",
description => "globally unique name of bucket to store wiki in",
safe => 1,
@@ -66,14 +65,13 @@ sub getsetup () { #{{{
},
amazon_s3_prefix => {
type => "string",
- default => "wiki/",
+ example => "wiki/",
description => "a prefix to prepend to each page name",
safe => 1,
rebuild => 1,
},
amazon_s3_location => {
type => "string",
- default => "",
example => "EU",
description => "which S3 datacenter to use (leave blank for default)",
safe => 1,
@@ -82,7 +80,7 @@ sub getsetup () { #{{{
amazon_s3_dupindex => {
type => "boolean",
default => 0,
- description => "store each index file twice? (to allow urls ending in \"/index.html\" and \"/\")",
+ description => "store each index file twice? (allows urls ending in \"/index.html\" and \"/\")",
safe => 1,
rebuild => 1,
},