add missing setup options, tweak others' display
[ikiwiki.git] / IkiWiki / Plugin / amazon_s3.pm
index b7470ca7950da421c91cd0d98b7300b82e86b7b4..d9279b6800d5df0ea594543f48daf10b0699c5f9 100644 (file)
@@ -43,22 +43,21 @@ sub getopt () { #{{{
 sub getsetup () { #{{{
        return
                 amazon_s3_key_id => {
 sub getsetup () { #{{{
        return
                 amazon_s3_key_id => {
-                       type => "boolean",
-                       default => "",
+                       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 +65,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,
@@ -82,7 +80,7 @@ sub getsetup () { #{{{
                amazon_s3_dupindex => {
                        type => "boolean",
                        default => 0,
                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,
                },
                        safe => 1,
                        rebuild => 1,
                },