X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/73d7635bcbf4fe48527697e61481e32b8ac99a5e..04498cdeb486a518ef9ed2464cb95f734b48c6bd:/doc/setup.mdwn?ds=sidebyside diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 03fed3aa9..ce51faa6d 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -4,7 +4,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki. ## Install ikiwiki -If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away. +If you're using Debian or Ubuntu, ikiwiki is an apt-get install ikiwiki away. If you're not, see the [[download]] and [[install]] pages. ## Create your wiki @@ -16,11 +16,13 @@ For more control, advanced users may prefer to set up a wiki [[by_hand|byhand]]. """]] - % ikiwiki -setup /etc/ikiwiki/auto.setup + % ikiwiki --setup /etc/ikiwiki/auto.setup Or, set up a blog with ikiwiki, run this command instead. - % ikiwiki -setup /etc/ikiwiki/auto-blog.setup + % ikiwiki --setup /etc/ikiwiki/auto-blog.setup + +`librpc-xml-perl` and `python-docutils` dependencies are needed. Either way, it will ask you a couple of questions. @@ -37,7 +39,7 @@ Then, wait for it to tell you an url for your new site.. destdir: ~/public_html/foo repository: ~/foo.git To modify settings, edit ~/foo.setup and then run: - ikiwiki -setup ~/foo.setup + ikiwiki --setup ~/foo.setup Done! @@ -68,6 +70,7 @@ source. (Remember to replace "foo" with the real directory name.) cvs -d `pwd`/foo get -P ikiwiki bzr clone foo foo.src hg clone foo foo.src + darcs get foo.darcs foo.src # TODO monotone, tla Now to edit pages by hand, go into the directory you checked out (ie, @@ -100,7 +103,13 @@ and gives a brief description of each. After making changes to this file, you need to tell ikiwiki to use it: - % ikiwiki -setup foo.setup + % ikiwiki --setup foo.setup + +Alternatively, you can ask ikiwiki to change settings in the file for you: + + % ikiwiki --changesetup foo.setup --plugin goodstuff + +See [[usage]] for more options. ## Customizing file locations @@ -123,11 +132,11 @@ old location won't work, and the easiest way to deal with this is to delete them and re-checkout from the new repository location. % rm -rf foo - % git clone /src/git/foo.git + % git clone /srv/git/foo.git Finally, edit the setup file. Modify the settings for `srcdir`, `destdir`, `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where -you moved things. Remember to run `ikiwiki -setup` after editing the +you moved things. Remember to run `ikiwiki --setup` after editing the setup file. ## Enjoy your new wiki!