web commit by http://joey.kitenet.net/

[git.ikiwiki.info.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 40370a863176d349cb8d64d1b1fe30cb0a1965fa..5332555f1ceebe8a5838969522b09b397798ab38 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,83 +1,140 @@
-So you want to set up your own wiki using ikiwiki? This turorial will walk
-you through setting up a wiki that is stored in [[Subversion]] and that has
-optional support for commits from the web.
+This tutorial will walk you through setting up a wiki with ikiwiki.

 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 
 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 

-   Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-   perl modules: `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or
-   newer) `HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`
-   (libtimedate-perl), `HTML::Scrubber`
+2. Decide where your wiki's files will go.

 
 

-2. Create the subversion repository for your wiki.
+   As a wiki compiler, ikiwiki builds a wiki from files in a source
+   directory, and outputs the files to a destination directory.

 
 

-               svnadmin create /svn/wikirepo
-               svn mkdir file:///svn/wikirepo/trunk -m create
+   For the purposes of this tutorial, we'll set shell variables
+   for these locations, and use those variables in the commands that follow.

 
 

-3. Check out the repository to make the working copy that ikiwiki will use.
+               SRCDIR=~/wikiwc
+               DESTDIR=~/public_html/wiki/

 
 

-               svn co file:///svn/wikirepo/trunk ~/wikiwc
+3. Create the beginnings of your wiki.

 
 

-4. Build your wiki for the first time.
+   This will create a simple main page for the wiki.

 
 

-               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
-                       --url=http://host/~you/wiki/
+               mkdir $SRCDIR
+               cd $SRCDIR
+               $EDITOR index.mdwn

 
 

-   Replace the url with the real url to your wiki. You should now
-   be able to visit the url and see your wiki.
+   In the editor, you could start by entering a simple page like this one:
+
+               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).

 
 

-5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
-   used if you don't have a custom version, so let's start by making a
-   custom version of the wiki's index page:
+   See [[HelpOnFormatting]] for details about the markup language.
+
+   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.
+
+4. Build your wiki for the first time.

 
 

-               cp /usr/share/ikiwiki/basewiki/index.mdwn ~/wikiwc
-               svn add ~/wikiwc/index.mdwn
-               $EDITOR ~/wikiwc/index.mdwn
-               svn commit ~/wikiwc/index.mdwn -m customised
+               ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/

 
 

-   You can also add any files you like from scratch of course.
+   Replace the url with the real url to your wiki. You should now
+   be able to visit the url and see your wiki.

 
 

-6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
+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]]).
 
    the wiki. You can play around with other ikiwiki parameters such as
    `--wikiname` and `--rebuild` too. Get comfortable with its command line
    (see [[usage]]).
 

-7. 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. And it's
-   also getting old to have to manualy rebuild the wiki each time you
-   change a file. Time to introduce setup files. 
+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
    
    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from

-   `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
+   `doc/ikiwiki.setup` in the ikiwiki sources), and edit it.

    
    Most of the options, like `wikiname` in the setup file are the same as
    
    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. `svnrepo` is the path to your subversion 
-   repository. Make sure that all of these are pointing to the right
-   directories, and read through and configure the rest of the file to your
-   liking.
-
-   Note that the default file has a block to configure a svn wrapper. This
-   sets up a [[post-commit]] hook to update the wiki.
+   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.

 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it

-   will set everything up and update your wiki.
+   will set everything up.

 
 

-8. Set up [[CGI]] to allow editing the wiki from the web.
+7. Turn on additional features.

 
 

-   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!
+   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!

 
 

-9. Add [[PageHistory]] links to the top of pages. This requires you to have
-   setup [[ViewCVS]] or something similar to access your [[Subversion]]
-   repository.  The `historyurl` setting makes ikiwiki add the links, and 
-   in that url, "\[[file]]" is replaced with the name of the file to view. So
-   edit ikiwiki.setup and set `historyurl` to something like this:
+   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]]..

 
 

-       `http://svn.host/trunk/\[[file]]?root=wiki`
+8. Put your wiki in revision control.
+
+   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:
+   
+               # 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 "<me@localhost>"
+               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. 

    
    

-   Then run `ikiwiki --setup ikiwiki.setup` again.
+   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.

 
 

-10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].