web commit by joey: test logged in commit

[git.ikiwiki.info.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index a4632dba1d3fe385f3eac3b0a0522af09672b7c0..acb401cfced00cb5106e47f16039710534f909c0 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -4,7 +4,10 @@ optional support for commits from the web.
 
 1. [[Install]] ikiwiki.
 
-               apt-get install ikiwiki
+               apt-get install ikiwiki # soon
+
+   Ikiwiki requires [[MarkDown]] be installed, and also uses the following
+   perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
 
 2. Create the subversion repository for your wiki.
 
@@ -15,7 +18,7 @@ optional support for commits from the web.
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
-4. Create some files them into subversion.
+4. Create some files and add them into subversion.
 
                echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
                echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
@@ -24,8 +27,9 @@ optional support for commits from the web.
 
 5. Build your wiki for the first time.
 
-               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
-                       --url=http://host/~you/wiki/
+               ikiwiki --verbose ~/wikiwc/ \
+                  /usr/lib/ikiwiki/templates ~/public_html/wiki/ \
+                  --url=http://host/~you/wiki/
 
    Replace the url with the right url to your wiki. You should now
    be able to visit the url and see your page that you created earlier.
@@ -37,13 +41,15 @@ optional support for commits from the web.
 7. Set up a Subversion [[post-commit]] hook to automatically rebuild your
    wiki when you commit to it.
 
-               ikiwiki ~/wikiwc/ ~/public_html/wiki/ \
+               ikiwiki ~/wikiwc/ \
+                    /usr/lib/ikiwiki/templates ~/public_html/wiki/ \
                        --url=http://host/~you/wiki/ --wrapper
                mv ikiwiki-wrap /svn/wikirepo/hooks/post-commit
 
 8. Set up a [[CGI]] to allow editing the wiki from the web.
 
-               ikiwiki ~/wikiwc/ ~/public_html/wiki/ \
+               ikiwiki ~/wikiwc/ \
+                    /usr/lib/ikiwiki/templates ~/public_html/wiki/ \
                        --url=http://host/~you/wiki/ --wrapper --cgi
                chmod 6755 ikiwiki-wrap
                mv wrapper ~/public_html/wiki/ikiwki.cgi
@@ -56,13 +62,16 @@ optional support for commits from the web.
    post-commit hook to add such links when updating the wiki in the
    future. Note the use of the [[WrapperParamsTrick]].
 
-               ikiwiki $(/svn/wikirepo/hooks/post-commit --params) --rebuild
                ikiwiki $(/svn/wikirepo/hooks/post-commit --params) \
-                       --cgiurl=http://host/~you/wiki/ikiwiki.cgi \
-                       --wrapper
+                       --cgiurl=http://host/~you/wiki/ikiwiki.cgi --wrapper
                mv ikiwiki-wrap /svn/wikirepo/hooks/post-commit
+               ikiwiki $(/svn/wikirepo/hooks/post-commit --params) --rebuild
 
    Be sure to change the cgiurl to the actual url to the wiki.cgi you
    installed in step 9.
 
-10. Enjoy your new wiki!
+10. Add [[PageHistory]] links to the top of pages. This requires you to have setup [[ViewCVS]] or something similar to access your [[Subversion]] repository.  The --historyurl parameter makes ikiwiki add the links, and in that url, "[[]]" is replaced with the name of the file to view. So repeat step 9 to rebuild the wiki post commit wrapper and wiki, adding a historyurl something like this one:
+
+                --historyurl='http://svn.host/trunk/[[]]?root=wiki'
+
+11. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
\ No newline at end of file