Merge commit 'upstream/master' into pub/master

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index fe55d8a84d2bf7603f7b979004245625f657a99d..1b8e4b12a723797876c01e598f2d881927834cc7 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,153 +1,208 @@
-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.
+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.

 
 

-   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).
+If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
+If you're not, see the [[download]] and [[install]] pages.

 
 

-   For the purposes of this tutorial, we'll set shell variables
-   for these locations, and use those variables in the commands that follow.
+## Quick start
+
+If you'd like to set up a wiki now, and learn more later, and you have
+ikiwiki 2.60 or better installed, just run this command and answer a couple
+of questions.
+
+       % ikiwiki -setup /etc/ikiwiki/auto.setup
+       What will the wiki be named? mywiki
+       What revision control system to use? git
+       What wiki user (or openid) will be wiki admin? joey
+
+Wait for it to tell you an url for your new wiki.. Done!
+
+(If the CGI doesn't seem to let you edit pages, you might need to
+[[configure_apache|tips/apache_cgi]] or [[configure_lighttpd|tips/lighttpd_cgi]].)
+
+## Decide where your wiki's files will go.
+
+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.
+
+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/
 
        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.
-
-               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.
-
-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:
-
-               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
-
-               # TLA
-               tla add index.mdwn
-               tla commit
-
-               # Mercurial
-               hg add index.mdwn
-               hg commit -m customised index.mdwn
-
-   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]]).
-
-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. 
+Note that ikiwiki owns the working copy directory; do not perform your own
+edits in ikiwiki's working copy.
+
+## Create the beginnings of your wiki.
+
+This will create a simple main page for the wiki.
+
+       mkdir $SRCDIR
+       cd $SRCDIR
+       $EDITOR index.mdwn
+
+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.
+
+       All wikis are supposed to have a \[[SandBox]],
+       so this one does too.
+
+       ----
+
+       This wiki is powered by [ikiwiki](http://ikiwiki.info).
+"""]]

    
    

-   A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
-   `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
+See [[ikiwiki/formatting]] for details about the markup language.
+
+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.
+
+## Build your wiki for the first time.
+
+       ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~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.
+
+## Add content to your wiki.
+
+Continue editing or adding pages and rebuilding the wiki.
+   
+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.
+
+You can experiment with other ikiwiki parameters such as `--wikiname`
+and `--rebuild` too. Get comfortable with its command line (see
+[[usage]]).
+
+## Add a setup file.
+
+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.
+
+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
-   `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. 
+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.
+
+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 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
-   is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
+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
+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
+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.

 
 

-   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]]..
+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.

 
 

-10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].
+Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and
+should be preserved, but not checked into revision control.
+
+The [[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=bazaar 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 "<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
+"""]]
+
+[[!toggle id=monotone text="Monotone"]]
+[[!toggleable id=monotone text="""
+       # This assumes that you have already used "mtn genkey you@hostname".
+       REPOSITORY=~/wiki.monotone
+       ikiwiki-makerepo monotone $SRCDIR $REPOSITORY
+"""]]
+
+## 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, set
+`rcs` to the the revision control system you chose to use. Be sure to set
+`svnrepo` to the directory for your repository, if using subversion.
+Uncomment the configuration for the wrapper for your revision control
+system, and configure the wrapper path appropriately (for Git, it should be
+the path to `hooks/post-update` inside the bare git repository).
+
+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.