add --setup, --wrappermode

[ikiwiki.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 7e454435d27bac8fd292f162fbcff17a6764cf7c..541131cf9a881278f0291024c27e502281e95ed2 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -4,7 +4,10 @@ optional support for commits from the web.
 
 1. [[Install]] ikiwiki.
 
 
 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.
 
 
 2. Create the subversion repository for your wiki.
 


@@ -24,8 +27,9 @@ optional support for commits from the web.
 
 5. Build your wiki for the first time.
 
 
 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.
 
    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.
 
 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.
 
                        --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
                        --url=http://host/~you/wiki/ --wrapper --cgi
                chmod 6755 ikiwiki-wrap
                mv wrapper ~/public_html/wiki/ikiwki.cgi


@@ -66,6 +72,6 @@ optional support for commits from the web.
 
 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:
 
 
 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/doc/[[]]?root=wiki'
+                --historyurl='http://svn.host/trunk/[[]]?root=wiki'

 
 

-11. Enjoy your new wiki!
\ No newline at end of file
+11. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]