update

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 9e4d00726120592b8d7a3cb1c164a2b38bbc1858..c773855830eb7d0ea842666683ea154eb49da29c 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -8,6 +8,7 @@
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
+       adminemail => 'me@myhost',
        
        # Be sure to customise these..
        srcdir => "/path/to/source",
@@ -22,6 +23,7 @@ use IkiWiki::Setup::Standard {
        # Whether to integrate with svn.
        svn => 1,
        svnrepo => "/svn/wiki",
+       svnpath => "trunk",
 
        wrappers => [
                {
@@ -31,6 +33,8 @@ use IkiWiki::Setup::Standard {
                        # what you want.
                        wrapper => "/svn/wiki/hooks/post-commit",
                        wrappermode => "04755",
+                       # Enable mail notifications of commits.
+                       notify => 1,
                },
                #{
                #       # The cgi wrapper.

diff --git a/doc/news/email_subscriptions.mdwn b/doc/news/email_subscriptions.mdwn
new file mode 100644 (file)
index 0000000..7d242c0
--- /dev/null
+++ b/doc/news/email_subscriptions.mdwn
@@ -0,0 +1,21 @@
+ikiwiki now supports subscribing to pages on wikis with a subversion
+backend. Subscribers will be mailed commit diffs.
+
+Some changes are needed to ikiwiki configs to support this:
+
+* A new `--adminemail` config option has been added, that is used for both
+  this and for sending user subscription mails, so should be configured on
+  any wiki that uses either feature. 
+* `--svnpath` needs to be set to location of your wiki inside its
+  subversion repository. It defaults to "trunk", which will work for many
+  layouts.
+* A new `--notify` config option should be passed to ikiwiki when it's run
+  as a svn commit hook, to enable it sending the subscription mails.
+* `--svnrepo` is actually supported and used now, so should be set to the
+  subversion repository directory.
+
+[[ikiwiki.setup]] has been updated accordingly.
+
+This is the last major change planned before the first official release of
+ikiwiki. The main remaining issue blocking that release is the resolution
+of what to do about HTML XSS [[security]] issues.

diff --git a/doc/security.mdwn b/doc/security.mdwn
index 1ab80e47f203fa5286bea99a48b1a6179ddca7f7..a8f8f20acdc3cbfa134fd416cf61e6dd41a33974 100644 (file)
--- a/doc/security.mdwn
+++ b/doc/security.mdwn
@@ -102,7 +102,8 @@ been no problem yet.
 
 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
 system() at all, and the only use of backticks is on data supplied by the
-wiki admin and untainted filenames. And it runs with taint checks on of course..
+wiki admin and untainted filenames. And it runs with taint checks on of
+course..
 
 ## cgi data security
 
@@ -129,7 +130,8 @@ If you care, you can use https, I suppose.
 
 # Fixed holes
 
-_(Unless otherwise noted, these were discovered and immediatey fixed by the ikiwiki developers.)_
+_(Unless otherwise noted, these were discovered and immediatey fixed by the
+ikiwiki developers.)_
 
 ## destination directory file replacement
 

diff --git a/doc/todo/mailnotification.mdwn b/doc/todo/done/mailnotification.mdwn
similarity index 96%
rename from doc/todo/mailnotification.mdwn
rename to doc/todo/done/mailnotification.mdwn
index 85814100878887a095e047fa086945a74a859d93..50ecfe30b40360afc5212105f9e01c5f08b53d5d 100644 (file)
--- a/doc/todo/mailnotification.mdwn
+++ b/doc/todo/done/mailnotification.mdwn
@@ -52,3 +52,6 @@ should be safe. --[[WillThompson]])
      into a folder.
 
   --[[BrandenRobinson]]
+
+  I'm deferring these nicities until there's some demonstrated demand
+  --[[Joey]].

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 89c30d56e147ca4ab848ddb2d8c0d3de55541704..ca805ce3350df747a0dfa531680c662b972de84d 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -92,6 +92,11 @@ These options configure the wiki.
 
   Specify a mode to chmod the wrapper to after creating it.
 
+* --notify
+
+  Enable email notification of commits. This should be used when running
+  ikiwiki as a [[Subversion]] [[post-commit]] hook.
+
 * --svn, --nosvn
 
   Enable or disable use of [[subversion]]. If subversion is enabled, the
@@ -104,6 +109,17 @@ These options configure the wiki.
 
   Subversion is enabled by default.
 
+* --svnrepo /svn/wiki
+
+  Specify the location of the svn repository for the wiki. This is required
+  for using --notify with [[subversion]].
+
+* --svnpath trunk
+
+  Specify the path inside your svn reporistory where the wiki is located.
+  This defaults to trunk; change it if your wiki is at some other location
+  inside the repository.
+
 * --anonok, --noanonok
 
   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
@@ -129,6 +145,10 @@ These options configure the wiki.
   "\[[file]]" is replaced with the file to browse. It's common to use
   [[ViewCVS]] for this.
 
+* --adminemail you@yourhost
+
+  Specifies the email address that ikiwiki should use for sending email.
+
 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 
   Specifies the url to link to for a diff of changes to a page. In the url,