Mark done

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 857a9dbae01bd0323afbc309306c36061544d417..647e8b86f8e9c49157a0095d13374651627a44b0 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,9 +1,28 @@
 This tutorial will walk you through setting up a wiki with ikiwiki.
 
 This tutorial will walk you through setting up a wiki with ikiwiki.
 

-[[toc ]]
+[[!toc ]]

 
 ## [[Download]] and [[install]] ikiwiki.
 
 
 ## [[Download]] and [[install]] ikiwiki.
 

+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.
+
+## 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|apache_cgi]]).)
+

 ## Decide where your wiki's files will go.
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
 ## Decide where your wiki's files will go.
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,


@@ -29,8 +48,8 @@ This will create a simple main page for the wiki.
        $EDITOR index.mdwn
 
 In the editor, you could start by entering a simple page like
        $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="""
+[[!toggle id=page text="this one"]].
+[[!toggleable id=page text="""

        Welcome to your new wiki.
 
        All wikis are supposed to have a \[[SandBox]],
        Welcome to your new wiki.
 
        All wikis are supposed to have a \[[SandBox]],


@@ -71,11 +90,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.
 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
    
 Most of the options, like `wikiname` in the setup file are the same as
 ikiwiki's command line options (documented in [[usage]]. `srcdir` and


@@ -88,12 +112,12 @@ will set everything up.
 
 ## Turn on additional features.
 
 
 ## 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
 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
 is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
 
 There are lots of other configuration options in ikiwiki.setup that you


@@ -110,17 +134,17 @@ 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.
 
 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.
 
 revision control.
 

-[[toggle id=subversion text="Subversion"]]
-[[toggleable id=subversion text="""
+[[!toggle id=subversion text="Subversion"]]
+[[!toggleable id=subversion text="""

        REPOSITORY=~/wikirepo
        ikiwiki-makerepo svn $SRCDIR $REPOSITORY
 """]]
 
        REPOSITORY=~/wikirepo
        ikiwiki-makerepo svn $SRCDIR $REPOSITORY
 """]]
 

-[[toggle id=git text="Git"]]
-[[toggleable id=git text="""
+[[!toggle id=git text="Git"]]
+[[!toggleable id=git text="""

        REPOSITORY=~/wiki.git
        ikiwiki-makerepo git $SRCDIR $REPOSITORY
 
        REPOSITORY=~/wiki.git
        ikiwiki-makerepo git $SRCDIR $REPOSITORY
 


@@ -129,21 +153,20 @@ ikiwiki uses git repositories, and some important caveats
 about using the git repositories.
 """]]
 
 about using the git repositories.
 """]]
 

-[[toggle id=mercurial text="Mercurial"]]
-[[toggleable id=mercurial text="""
+[[!toggle id=mercurial text="Mercurial"]]
+[[!toggleable id=mercurial text="""

        REPOSITORY=$SRCDIR
        ikiwiki-makerepo mercurial $SRCDIR
 """]]
 
        REPOSITORY=$SRCDIR
        ikiwiki-makerepo mercurial $SRCDIR
 """]]
 

-[[toggle id=mercurial text="Bazaar"]]
-[[toggleable id=bazaar text="""
+[[!toggle id=bazaar text="Bazaar"]]
+[[!toggleable id=bazaar text="""

        REPOSITORY=$SRCDIR
        REPOSITORY=$SRCDIR

-       # FIXME: doesn't work yet with bzr

        ikiwiki-makerepo bzr $SRCDIR
 """]]
 
        ikiwiki-makerepo bzr $SRCDIR
 """]]
 

-[[toggle id=tla text="TLA"]]
-[[toggleable id=tla text="""
+[[!toggle id=tla text="TLA"]]
+[[!toggleable id=tla text="""

        REPOSITORY=~/wikirepo
        tla make-archive me@localhost--wiki $REPOSITORY
        tla my-id "<me@localhost>"
        REPOSITORY=~/wikirepo
        tla make-archive me@localhost--wiki $REPOSITORY
        tla my-id "<me@localhost>"


@@ -156,8 +179,8 @@ about using the git repositories.
        tla import
 """]]
 
        tla import
 """]]
 

-[[toggle id=monotone text="Monotone"]]
-[[toggleable id=monotone text="""
+[[!toggle id=monotone text="Monotone"]]
+[[!toggleable id=monotone text="""

        # These instructions are standard instructions to import a directory into monotone
        # and set it up so that you don't need any passwords to use it
        REPOSITORY=~/.ikiwiki/mtn.db
        # These instructions are standard instructions to import a directory into monotone
        # and set it up so that you don't need any passwords to use it
        REPOSITORY=~/.ikiwiki/mtn.db


@@ -165,7 +188,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
        # 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
        mtn db init --db=$REPOSITORY
        mv $SRCDIR $SRCDIR-old
        cd $SRCDIR-old


@@ -184,12 +207,13 @@ about using the git repositories.
 
 ## Configure ikiwiki to use revision control.
 
 
 ## 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. 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`).
+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
 
 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