diff options
Diffstat (limited to 'doc/setup.mdwn')
| -rw-r--r-- | doc/setup.mdwn | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 174d6ceb9..9c67c2a6c 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -74,11 +74,16 @@ and `--rebuild` too. Get comfortable with its command line (see 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. 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. + +To generate a setup file, use `ikiwiki --dumpsetup`. You can pass +all the options have you been including at the command line, and they +will be stored in the setup file. + + ikiwiki $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ --dumpsetup ikiwiki.setup + +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. Most of the options, like `wikiname` in the setup file are the same as ikiwiki's command line options (documented in [[usage]]. `srcdir` and @@ -91,12 +96,12 @@ will set everything up. ## Turn on additional features. -Now you have a basic wiki with a configuration file. Time to experiment +Now you have a basic wiki with a setup 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 +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 @@ -113,7 +118,7 @@ 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 +The [[ikiwiki-makerepo]] command automates setting up a wiki in revision control. [[!toggle id=subversion text="Subversion"]] @@ -167,7 +172,7 @@ about using the git repositories. # 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 genkey web@example.com mtn db init --db=$REPOSITORY mv $SRCDIR $SRCDIR-old cd $SRCDIR-old @@ -188,11 +193,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 |