format

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index b3620fb3ca265fb43c3987810ee3e11d1995ebf9..52ef204fceb48077137c5c70261071fd8b4871a6 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,57 +1,87 @@
 So you want to set up your own wiki using ikiwiki? This tutorial will walk
 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]], or
-[[TLA]], and that has optional support for commits from the web.
+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.
 
 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 

-2. Create the master rcs repository for your wiki.
+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
 
                # Subversion

-               svnadmin create /svn/wikirepo
-               svn mkdir file:///svn/wikirepo/trunk -m create
+               svnadmin create $REPOSITORY
+               svn mkdir file://$REPOSITORY/trunk -m create

                 
                # Git
                 
                # Git

-               mkdir /git/wikirepo
-               cd /git/wikirepo
+               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
                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
 
                # TLA

-               mkdir /tla
-               tla make-archive me@localhost--wiki /tla/wikirepo
+               mkdir $REPOSITORY
+               tla make-archive me@localhost--wiki $REPOSITORY

                tla my-id "<me@localhost>"
 
                tla my-id "<me@localhost>"
 

-3. Check out the repository to make the working copy that ikiwiki will use.
+               # Mercurial
+               hg init $REPOSITORY
+
+4. Check out the repository to make the working copy that ikiwiki will use
+   as its source directory.

 
                # Subversion
 
                # Subversion

-               svn co file:///svn/wikirepo/trunk ~/wikiwc
+               svn co file://$REPOSITORY/trunk ~/wikiwc

                 
                # Git
                 
                # Git

-               git clone /git/wikirepo ~/wikiwc
+               # Create a local clone to save disk space and also to
+               # optimize performance. See git-clone(1).
+               git clone -l -s $REPOSITORY $SRCDIR

 
                # TLA
 
                # TLA

-               mkdir ~/wikiwc
-               cd ~/wikiwc
+               mkdir $SRCDIR
+               cd $SRCDIR

                tla archive-setup me@localhost--wiki/wiki--0
                tla init-tree me@localhost--wiki/wiki--0
                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
 
                tla import
 

-4. Build your wiki for the first time.
+               # 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.

 
 

-               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
+               ikiwiki --verbose $SRCDIR $DESTDIR \

                        --url=http://host/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now
    be able to visit the url and see your wiki.
 
                        --url=http://host/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now
    be able to visit the url and see your wiki.
 

-5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
+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:
 
    used if you don't have a custom version, so let's start by making a
    custom version of the wiki's index page:
 

-               cd ~/wikiwc
+               cd $SRCDIR

                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                $EDITOR index.mdwn
                 
                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                $EDITOR index.mdwn
                 


@@ -68,14 +98,19 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
                tla add index.mdwn
                tla commit
 
                tla add index.mdwn
                tla commit
 

-   You can also add any files you like from scratch of course.
+               # Mercurial
+               hg add index.mdwn
+               hg commit -m customised index.mdwn

 
 

-6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
+   You can also add any files you like from scratch of course. Use the same
+   command as in step 5 to rebuild the 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]]).
 
    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
+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. 
    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. 


@@ -90,32 +125,29 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 
    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 git, comment out the subversion stuff, uncomment and
-   edit the git stuff.
-
-   Note that the default file has a block to configure an [[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.
+   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.
 
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.
 

-8. 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. Turn on additional features.

 
 

-9. Add [[PageHistory]] links to the top of pages. This requires you to have
-   setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
-   something similar to access your [[Subversion]] repository.  For Git,
-   [[Gitweb]] can be used.
+   Now you have a basic wiki with a configuration file. Time to experiment
+   with ikiwiki's many features. 

    
    

-   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 ucomment the appropriate `historyurl` setting and edit
-   it for your setup.
-   
-   Then run `ikiwiki --setup ikiwiki.setup` again.
+   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]]
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].