]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/setup.mdwn
sipb-www / ikiwiki.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
web commit by joey
[ikiwiki.git] / doc / setup.mdwn
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index acb401cfced00cb5106e47f16039710534f909c0..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,51 +30,53 @@ 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 conformatble with its command line.
-
-7. Set up a Subversion [[post-commit]] hook to automatically rebuild your
-   wiki when you commit to it.
-
-               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/ \
-                    /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
-
-   Note that this assumes that your web server will run CGI scripts from
-   your public_html directory. You might need to put it somewhere else
-   depending on your web server configuration.
-
-9. Add links to the CGI to all the pages in your wiki, and update your
-   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) \
-                       --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. 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
+   `--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
+   also getting old to have to manualy rebuild the wiki each time you
+   change a file. Time to introduce setup files. 
+   
+   A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
+   `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`
+   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.
+
+   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 set everything up and update your wiki.
+
+8. Set up [[CGI]] to allow editing the wiki from the web.
+
+   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 
+   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:
+
+       `http://svn.host/trunk/\[[file]]?root=wiki`
+   
+   Then run `ikiwiki --setup ikiwiki.setup` again.
+
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
wiki compiler