web commit by joey

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index cc830c0b965f06063fa6d3b1702e2dcf326bb7e3..e9c690f4558961ebd5e061a96337fb9140f7c601 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -8,6 +8,7 @@ optional support for commits from the web.
 
    Ikiwiki requires [[MarkDown]] be installed, and also uses the following
    perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
 
    Ikiwiki requires [[MarkDown]] be installed, and also uses the following
    perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`

+   `Mail::SendMail` `Time::Duration`

 
 2. Create the subversion repository for your wiki.
 
 
 2. Create the subversion repository for your wiki.
 


@@ -18,7 +19,9 @@ optional support for commits from the web.
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 

-4. Create some files and add them into subversion.
+4. Create some files and add them into subversion. Or you might copy the
+   files from /usr/share/ikiwiki/basewiki and check those in to get a
+   head start on creating your wiki.

 
                echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
                echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
 
                echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
                echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn


@@ -27,16 +30,16 @@ 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/ \
-                  /usr/lib/ikiwiki/templates ~/public_html/wiki/ \
-                  --url=http://host/~you/wiki/
+               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
+                       --url=http://host/~you/wiki/

 
 

-   Replace the url with the right url to your wiki. You should now
+   Replace the url with the real url to your wiki. You should now

    be able to visit the url and see your page that you created earlier.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    the wiki. You can play around with other ikiwiki parameters such as
    be able to visit the url and see your page that you created earlier.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    the wiki. You can play around with other ikiwiki parameters such as

-   --wikiname too. Get confortable with its command line.
+   `--wikiname` and `--rebuild` too. Get comfortable with its command line
+   (see [[usage]]).

 
 7. By now you should be getting tired of typing in all the command line
    options each time you change something in your wiki's setup. And it's
 
 7. By now you should be getting tired of typing in all the command line
    options each time you change something in your wiki's setup. And it's


@@ -47,31 +50,32 @@ optional support for commits from the web.
    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
    
    Most of the options, like `wikiname` in the setup file are the same as
    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
    
    Most of the options, like `wikiname` in the setup file are the same as

-   ikiwiki's command line options (documented in [[usage]]. `srcdir`,
-   `templatedir` and `destdir` are the three directories you specify when
+   ikiwiki's command line options (documented in [[usage]]. `srcdir`
+   and `destdir` are the two directories you specify when

    running ikiwiki by hand. `svnrepo` is the path to your subversion 
    repository. Make sure that all of these are pointing to the right
    directories, and read through and configure the rest of the file to your
    liking.
 
    running ikiwiki by hand. `svnrepo` is the path to your subversion 
    repository. Make sure that all of these are pointing to the right
    directories, and read through and configure the rest of the file to your
    liking.
 

-   Note that the default file will enable a [[post-commit]] hook to
-   update the wiki, but has cgi support turned off.
+   Note that the default file has a block to configure a svn wrapper. This
+   sets up a [[post-commit]] hook to update the wiki.

 
 

-   When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it will
-   generate the subversion [[post-commit]] hook and update your wiki.
+   When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
+   will set everything up and update your wiki.

 
 8. Set up [[CGI]] to allow editing the wiki from the web.
 
 
 8. Set up [[CGI]] to allow editing the wiki from the web.
 

-   Just edit ikiwiki.setup, change cgiwrapper to 1, and optioanlly anonok
-   to 1, run `ikiwiki --setup ikiwiki.setup`, and you're done!
+   Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
+   sure the filename for the cgi wrapper is ok, run 
+   `ikiwiki --setup ikiwiki.setup`, and you're done!

 
 9. 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` setting makes ikiwiki add the links, and 
 
 9. 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` setting makes ikiwiki add the links, and 

-   in that url, "[[]]" is replaced with the name of the file to view. So
+   in that url, "\[[file]]" is replaced with the name of the file to view. So

    edit ikiwiki.setup and set `historyurl` to something like this:
 
    edit ikiwiki.setup and set `historyurl` to something like this:
 

-       `http://svn.host/trunk/[[]]?root=wiki`
+       `http://svn.host/trunk/\[[file]]?root=wiki`

    
    Then run `ikiwiki --setup ikiwiki.setup` again.
 
    
    Then run `ikiwiki --setup ikiwiki.setup` again.