Merge commit 'upstream/master'

[git.ikiwiki.info.git] / IkiWiki / Plugin / amazon_s3.pm

diff --git a/IkiWiki/Plugin/amazon_s3.pm b/IkiWiki/Plugin/amazon_s3.pm
index b7470ca7950da421c91cd0d98b7300b82e86b7b4..597539c13b0f2c218955dc81da2f26dfb7aa6fb4 100644 (file)
--- a/IkiWiki/Plugin/amazon_s3.pm
+++ b/IkiWiki/Plugin/amazon_s3.pm
@@ -42,23 +42,26 @@ sub getopt () { #{{{
 
 sub getsetup () { #{{{
        return
 
 sub getsetup () { #{{{
        return

-                amazon_s3_key_id => {
-                       type => "boolean",
-                       default => "",
+               plugin => {
+                       safe => 0,
+                       rebuild => 0,
+               },
+               amazon_s3_key_id => {
+                       type => "string",
+                       example => "XXXXXXXXXXXXXXXXXXXX",

                        description => "public access key id",
                        safe => 1,
                        rebuild => 0,
                },
                amazon_s3_key_id => {
                        type => "string",
                        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",
                        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,
                        example => "mywiki",
                        description => "globally unique name of bucket to store wiki in",
                        safe => 1,


@@ -66,14 +69,13 @@ sub getsetup () { #{{{
                },
                amazon_s3_prefix => {
                        type => "string",
                },
                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",
                        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,
                        example => "EU",
                        description => "which S3 datacenter to use (leave blank for default)",
                        safe => 1,


@@ -81,8 +83,8 @@ sub getsetup () { #{{{
                },
                amazon_s3_dupindex => {
                        type => "boolean",
                },
                amazon_s3_dupindex => {
                        type => "boolean",

-                       default => 0,
-                       description => "store each index file twice, to allow urls ending in \"/index.html\" and \"/\"",
+                       example => 0,
+                       description => "store each index file twice? (allows urls ending in \"/index.html\" and \"/\")",

                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },