X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c03adfbaeeb26ebb3f65bd916446555c63b8d8b1..376944cb026945ab597db01eb1e3aea4fa320007:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 5332555f1..9d7aecabd 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -1,140 +1,202 @@ This tutorial will walk you through setting up a wiki with ikiwiki. -1. [[Install]] ikiwiki. See [[download]] for where to get it. +[[toc ]] -2. Decide where your wiki's files will go. +## [[Download]] and [[install]] ikiwiki. - As a wiki compiler, ikiwiki builds a wiki from files in a source - directory, and outputs the files to a destination directory. +## Decide where your wiki's files will go. - For the purposes of this tutorial, we'll set shell variables - for these locations, and use those variables in the commands that follow. +As a wiki compiler, ikiwiki builds a wiki from files in a source directory, +and outputs the files to a destination directory. If you keep your wiki in +a version control system, the source directory will contain a working copy +checked out from the version control system. - SRCDIR=~/wikiwc - DESTDIR=~/public_html/wiki/ +For the purposes of this tutorial, we'll set shell variables +for these locations, and use those variables in the commands that follow. -3. Create the beginnings of your wiki. + SRCDIR=~/wikiwc + DESTDIR=~/public_html/wiki/ - This will create a simple main page for the wiki. +Note that ikiwiki owns the working copy directory; do not perform your own +edits in ikiwiki's working copy. - mkdir $SRCDIR - cd $SRCDIR - $EDITOR index.mdwn +## Create the beginnings of your wiki. - In the editor, you could start by entering a simple page like this one: +This will create a simple main page for the wiki. - Welcome to your new wiki. - All wikis are supposed to have a [[SandBox]], so this one does too. - ---- - This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net). + mkdir $SRCDIR + cd $SRCDIR + $EDITOR index.mdwn - See [[HelpOnFormatting]] for details about the markup language. +In the editor, you could start by entering a simple page like +[[toggle id=page text="this one"]]. +[[toggleable id=page text=""" + Welcome to your new wiki. - Note that several standard wiki pages will be added to your wiki, from - files in `/usr/share/ikiwiki/basewiki/`, so your wiki will automatically - get a [[SandBox]], and some other useful pages. + All wikis are supposed to have a \[[SandBox]], + so this one does too. -4. Build your wiki for the first time. + ---- - ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/ + This wiki is powered by [ikiwiki](http://ikiwiki.info). +"""]] + +See [[ikiwiki/formatting]] for details about the markup language. - Replace the url with the real url to your wiki. You should now - be able to visit the url and see your wiki. +Note that several [[standard_wiki_pages|basewiki]] will be added to your +wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will +automatically get a [[SandBox]], and some other useful pages. -5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding - the wiki. You can play around with other ikiwiki parameters such as - `--wikiname` and `--rebuild` too. Get comfortable with its command line - (see [[usage]]). +## Build your wiki for the first time. -6. 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. 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. Make sure that these are pointing to the right directories, and - read through and configure the rest of the file to your liking. + ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ - When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it - will set everything up. +Replace the url with the real url to your wiki. You should now +be able to visit the url and see your wiki. -7. Turn on additional features. +## Add content to your wiki. - Now you have a basic wiki with a configuration file. Time to experiment - with ikiwiki's many features. +Continue editing or adding pages and rebuilding the wiki. - 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 - is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done! +To quickly get started on a common task like blogging with ikiwiki, you +can copy in files from the [[examples]]. The examples are located in +`doc/examples/` in the ikiwiki source package. - There are lots of other configuration options in ikiwiki.setup that you - can uncomment, configure, and enable by re-running - `ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the - [[plugins]].. +You can experiment with other ikiwiki parameters such as `--wikiname` +and `--rebuild` too. Get comfortable with its command line (see +[[usage]]). -8. Put your wiki in revision control. +## Add a setup file. - At this point you might want to check your wiki in to a revision control - system you can get history of past changes and revert edits. Depending - on the revision control system you choose, the way this is done varies. - - There's little that's ikiwiki specific about these instructions; this is - just how you put a directory under revision control using the various - systems ikiwiki supports: +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. Time to +introduce setup files. - # Subversion - REPOSITORY=~/wikirepo - svnadmin create $REPOSITORY - svn import $SRCDIR file://$REPOSITORY/trunk -m "initial import" - rm -rf $SRCDIR - svn co file://$REPOSITORY/trunk $SRCDIR - - # Git - REPOSITORY=~/wikirepo - mkdir $REPOSITORY - cd $REPOSITORY - git init-db - cp -a $SRCDIR/* . - git add . - git commit -m "initial import" -a - rm -rf $SRCDIR - git clone -l -s $REPOSITORY $SRCDIR - - # TLA - REPOSITORY=~/wikirepo - tla make-archive me@localhost--wiki $REPOSITORY - tla my-id "" - cd $SRCDIR - tla archive-setup me@localhost--wiki/wiki--0 - tla init-tree me@localhost--wiki/wiki--0 - # Edit {arch}/=tagging-method and change the precious - # line to add the .ikiwiki directory to the regexp. - tla add * - tla import - - # Mercurial - REPOSITORY=$SRCDIR - hg init $REPOSITORY - -9. 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. +A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from +`doc/ikiwiki.setup` in the ikiwiki sources), and edit it. Note that this +file should *not* be put in your wiki's directory with the rest of the +files. A good place to put it is in a ~/.ikiwiki/ subdirectory. - 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 - control system to commit them, and the wiki will automatically update. - And in the web interface, RecentChanges should work, and files changed - by web users will also be committed using revision control. +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. Make sure that these are pointing to the right directories, and +read through and configure the rest of the file to your liking. -10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]. +When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it +will set everything up. + +## Turn on additional features. + +Now you have a basic wiki with a configuration file. Time to experiment +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 +is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done! + +There are lots of other configuration options in ikiwiki.setup that you +can uncomment, configure, and enable by re-running +`ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the +[[plugins]].. + +## Put your wiki in revision control. + +At this point you might want to check your wiki in to a revision control +system so you can keep track of changes and revert edits. Depending +on the revision control system you choose, the way this is done varies. + +Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and +should be preserved, but not checked into revision control. + +The new [[ikiwiki-makerepo]] command automates setting up a wiki in +revision control. + +[[toggle id=subversion text="Subversion"]] +[[toggleable id=subversion text=""" + REPOSITORY=~/wikirepo + ikiwiki-makerepo svn $SRCDIR $REPOSITORY +"""]] + +[[toggle id=git text="Git"]] +[[toggleable id=git text=""" + REPOSITORY=~/wiki.git + ikiwiki-makerepo git $SRCDIR $REPOSITORY + +Please see [[rcs/git]] for detailed documentation about how +ikiwiki uses git repositories, and some important caveats +about using the git repositories. +"""]] + +[[toggle id=mercurial text="Mercurial"]] +[[toggleable id=mercurial text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo mercurial $SRCDIR +"""]] + +[[toggle id=mercurial text="Bazaar"]] +[[toggleable id=bazaar text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo bzr $SRCDIR +"""]] + +[[toggle id=tla text="TLA"]] +[[toggleable id=tla text=""" + REPOSITORY=~/wikirepo + tla make-archive me@localhost--wiki $REPOSITORY + tla my-id "" + cd $SRCDIR + tla archive-setup me@localhost--wiki/wiki--0 + tla init-tree me@localhost--wiki/wiki--0 + # Edit {arch}/=tagging-method and change the precious + # line to add the .ikiwiki directory to the regexp. + tla add * + tla import +"""]] + +[[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@machine.company.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 +"""]] + +## 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. 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 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 +control system to commit them, and the wiki will automatically update. +And in the web interface, RecentChanges should work, and files changed +by web users will also be committed using revision control. + +## Enjoy your new wiki! + +Add yourself to [[IkiWikiUsers]]. And check out +the [[tips]] to find out how to get more out of ikiwiki.