testing

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 3494fd016d7f11b9d2d1c746c1fbbc40f49a7362..9ffba0014a89e4646eda7c47bd857f8152ad6190 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,68 +1,152 @@
-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.
-
-1. [[Install]] ikiwiki.
-
-               apt-get install ikiwiki
-
-2. Create the subversion repository for your wiki.
-
-               svnadmin create /svn/wikirepo
-               svn mkdir file:///svn/wikirepo/trunk -m create
-
-3. Check out the repository to make the working copy that ikiwiki will use.
-
-               svn co file:///svn/wikirepo/trunk ~/wikiwc
-
-4. Create some files and add them into subversion.
-
-               echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
-               echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
-               svn add ~/wikiwc/*.mdwn
-               svn commit ~/wikiwc -m add
+So you want to set up your own wiki using ikiwiki? This tutorial will walk
+you through setting up a wiki that is stored in [[Subversion]], [[Git]],
+[[TLA]] or [[Mercurial]], and that has optional support for commits from the web.
+
+1. [[Install]] ikiwiki. See [[download]] for where to get it.
+
+2. Decide where your wiki's files will go.
+
+   Pick three directories for respectively the repository (contains
+   the "master copy" and history); working copy (checked-out
+   files from the repository); and web pages (served by the web server).
+
+   For the purposes of this tutorial, we'll set shell variables
+   for these locations, and use those variables in the commands that follow.
+
+               REPOSITORY=~/wikirepo
+               SRCDIR=~/wikiwc
+               DESTDIR=~/public_html/wiki/
+
+3. Create the master rcs repository for your wiki.
+
+               # Subversion
+               svnadmin create $REPOSITORY
+               svn mkdir file://$REPOSITORY/trunk -m create
+                
+               # Git
+               mkdir $REPOSITORY
+               cd $REPOSITORY
+               git init-db
+               # Git requires something be in the repo to start with.
+               cp /usr/share/ikiwiki/basewiki/index.mdwn .
+               git add .
+               git commit -m create -a
+               # No need to keep files in the master repository; so at this
+               # stage, you may want to remove all files (except .git) to
+               # save disk space.
+
+               # TLA
+               mkdir $REPOSITORY
+               tla make-archive me@localhost--wiki $REPOSITORY
+               tla my-id "<me@localhost>"
+
+               # Mercurial
+               hg init $REPOSITORY
+
+4. Check out the repository to make the working copy that ikiwiki will use
+   as its source directory.
+
+               # Subversion
+               svn co file://$REPOSITORY/trunk ~/wikiwc
+                
+               # Git
+               # Create a local clone to save disk space and also to
+               # optimize performance. See git-clone(1).
+               git clone -l -s $REPOSITORY $SRCDIR
+
+               # TLA
+               mkdir $SRCDIR
+               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 import
+
+               # Mercurial
+               # Mercurial uses a single repo approach, so no need to
+               # clone anything. Because the following examples
+               # refer to $SRCDIR, we symlink it:
+               ln -s $REPOSITORY $SRCDIR

 
 5. Build your wiki for the first time.
 
 
 5. Build your wiki for the first time.
 

-               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
-                       --url=http://host/~you/wiki/
-
-   Replace the url with the right url to your wiki. You should now
-   be able to visit the url and see your page that you created earlier.
-
-6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
-   the wiki. You can play around with other ikiwiki parameters such as
-   --wikiname too. Get conformatble with its command line.
+               ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/

 
 

-7. Set up a Subversion [[post-commit]] hook to automatically rebuild your
-   wiki when you commit to it.
+   Replace the url with the real url to your wiki. You should now
+   be able to visit the url and see your wiki.

 
 

-               ikiwiki ~/wikiwc/ ~/public_html/wiki/ \
-                       --url=http://host/~you/wiki/ --wrapper
-               mv ikiwiki-wrap /svn/wikirepo/hooks/post-commit
+6. 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:

 
 

-8. Set up a [[CGI]] to allow editing the wiki from the web.
+               cd $SRCDIR
+               cp /usr/share/ikiwiki/basewiki/index.mdwn .
+               $EDITOR index.mdwn
+                
+               # Subversion
+               svn add index.mdwn
+               svn commit -m customised index.mdwn
+                
+               # Git
+               git add index.mdwn
+               git commit -m customised index.mdwn
+               git push origin

 
 

-               ikiwiki ~/wikiwc/ ~/public_html/wiki/ \
-                       --url=http://host/~you/wiki/ --wrapper --cgi
-               chmod 6755 ikiwiki-wrap
-               mv wrapper ~/public_html/wiki/ikiwki.cgi
+               # TLA
+               tla add index.mdwn
+               tla commit

 
 

-   Note that this assumes that your web server will run CGI scripts from
-   your public_html directory. You might need to put it somewhere else
-   depending on your web server configuration.
+               # Mercurial
+               hg add index.mdwn
+               hg commit -m customised index.mdwn

 
 

-9. Add links to the CGI to all the pages in your wiki, and update your
-   post-commit hook to add such links when updating the wiki in the
-   future. Note the use of the [[WrapperParamsTrick]].
+   You can also add any files you like from scratch of course. Use the same
+   command as in step 5 to rebuild the wiki.

 
 

-               ikiwiki $(/svn/wikirepo/hooks/post-commit --params) --rebuild
-               ikiwiki $(/svn/wikirepo/hooks/post-commit --params) \
-                       --cgiurl=http://host/~you/wiki/ikiwiki.cgi \
-                       --wrapper
-               mv ikiwiki-wrap /svn/wikirepo/hooks/post-commit
-
-   Be sure to change the cgiurl to the actual url to the wiki.cgi you
-   installed in step 9.
-
-10. Enjoy your new wiki!
+7. Repeat steps 5 and 6 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]]).
+
+8. 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. 
+   
+   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. `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.
+
+   If you want to use something other than subversion, comment out the
+   subversion configuration, and uncomment and edit the configuration for
+   your chosen RCS. Note that the default file has a block to configure a
+   [[post-commit]] wrapper to update the wiki. You need to uncomment the
+   related block for whatever RCS you use and comment out the other rcs
+   blocks.
+
+   When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
+   will set everything up and update your wiki.
+
+9. 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]]..
+
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].