X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c56618133cc3e0106e75b63cf91906037ea629ea..7baa6320e0dfb97bde1af3a3bbc46ace53f19093:/doc/setup.mdwn?ds=sidebyside diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 565711111..2989485f9 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -7,6 +7,21 @@ This tutorial will walk you through setting up a wiki with ikiwiki. 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. +## Quick start + +If you'd like to set up a wiki now, and learn more later, just run this command +and answer a couple of questions. + + % ikiwiki -setup /etc/ikiwiki/auto.setup + What will the wiki be named? mywiki + What revision control system to use? git + What wiki user (or openid) will be wiki admin? joey + +Wait for it to tell you an url for your new wiki.. Done! + +(If the CGI doesn't seem to let you edit pages, you might need to +[[configure_apache|apache_cgi]]).) + ## Decide where your wiki's files will go. As a wiki compiler, ikiwiki builds a wiki from files in a source directory, @@ -101,7 +116,7 @@ with ikiwiki's many features. Let's first enable a key wiki feature and 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 +settings for the `cgi_wrapper`, make sure the filename for the cgi wrapper is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done! There are lots of other configuration options in ikiwiki.setup that you @@ -193,11 +208,11 @@ about using the git repositories. Once your wiki is checked in to the revision control system, you should configure ikiwiki to use revision control. Edit your -ikiwiki.setup, and uncomment the lines for the revision control system +ikiwiki.setup, set `rcs` to the the revision control system you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using -subversion. Uncomment the block for the wrapper for your revision -control system, and configure the wrapper path in that block -appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`). +subversion. Uncomment the configuration for the wrapper for your revision +control system, and configure the wrapper path appropriately +(for Git, it should be `$REPOSITORY/hooks/post-update`). Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more. Now you should be able to edit files in $SRCDIR, and use your revision