X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c56618133cc3e0106e75b63cf91906037ea629ea..ac8e8f5ad7387a815cb0eb1b0a662694c86f2439:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 565711111..1b8e4b12a 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -7,6 +7,22 @@ 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, and you have +ikiwiki 2.60 or better installed, 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|tips/apache_cgi]] or [[configure_lighttpd|tips/lighttpd_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 +117,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 @@ -165,39 +181,20 @@ about using the git repositories. [[!toggle id=monotone text="Monotone"]] [[!toggleable id=monotone text=""" - # These instructions are standard instructions to import a directory into monotone - # and set it up so that you don't need any passwords to use it - REPOSITORY=~/.ikiwiki/mtn.db - BRANCH=com.company.wikiname - # remember the password you use in the next step and - # substitute it for 'wikiKeyPass' in the get_passphrase() hook below - # note the you should never generate two monotone keys with the same name - mtn genkey web@example.com - mtn db init --db=$REPOSITORY - mv $SRCDIR $SRCDIR-old - cd $SRCDIR-old - echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore - mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import" - cd .. - mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR - mv $SRCDIR-old/.ikiwiki $SRCDIR - cat << EOF > $SRCDIR/_MTN/monotonerc - function get_passphrase (branchname) - return "wikiKeyPass" - end - EOF - rm -r $SRCDIR-old + # This assumes that you have already used "mtn genkey you@hostname". + REPOSITORY=~/wiki.monotone + ikiwiki-makerepo monotone $SRCDIR $REPOSITORY """]] ## Configure ikiwiki to use revision control. -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 -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`). +Once your wiki is checked in to the revision control system, you should +configure ikiwiki to use revision control. Edit your ikiwiki.setup, set +`rcs` to the the revision control system you chose to use. Be sure to set +`svnrepo` to the directory for your repository, if using subversion. +Uncomment the configuration for the wrapper for your revision control +system, and configure the wrapper path appropriately (for Git, it should be +the path to `hooks/post-update` inside the bare git repository). 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