-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.
+[[!toc ]]
- apt-get install ikiwiki # soon
+## Install ikiwiki
- Ikiwiki requires [[MarkDown]] be installed, and also uses the following
- perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
- `Mail::SendMail` `Time::Duration`
+If you're using Debian or Ubuntu, ikiwiki is an <code><a href="http://www.debian.org/doc/manuals/debian-reference/ch02.en.html#_basic_package_management_operations">apt-get</a> install ikiwiki</code> away.
+If you're not, see the [[download]] and [[install]] pages.
-2. Create the subversion repository for your wiki.
+## Create your wiki
- svnadmin create /svn/wikirepo
- svn mkdir file:///svn/wikirepo/trunk -m create
+All it takes to create a fully functional wiki using ikiwiki is running
+one command.
+[[!template id=note text="""
+For more control, advanced users may prefer to set up a wiki
+[[by_hand|byhand]].
+"""]]
-3. Check out the repository to make the working copy that ikiwiki will use.
+ % ikiwiki --setup /etc/ikiwiki/auto.setup
- svn co file:///svn/wikirepo/trunk ~/wikiwc
+Or, set up a blog with ikiwiki, run this command instead.
-4. Create some files and add them into subversion. Or you might copy the
- files from /usr/share/ikiwiki/basewiki and check those in to get a
- head start on creating your wiki.
+ % ikiwiki --setup /etc/ikiwiki/auto-blog.setup
- 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
+`librpc-xml-perl` and `python-docutils` dependencies are needed.
-5. Build your wiki for the first time.
+Either way, it will ask you a couple of questions.
- ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
- --url=http://host/~you/wiki/
+ What will the wiki be named? foo
+ What revision control system to use? git
+ What wiki user (or openid) will be admin? joey
+ Choose a password:
- Replace the url with the real url to your wiki. You should now
- be able to visit the url and see your page that you created earlier.
+Then, wait for it to tell you an url for your new site..
-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` and `--rebuild` too. Get comfortable with its command line
- (see [[usage]]).
+ Successfully set up foo:
+ url: http://example.com/~joey/foo
+ srcdir: ~/foo
+ destdir: ~/public_html/foo
+ repository: ~/foo.git
+ To modify settings, edit ~/foo.setup and then run:
+ ikiwiki --setup ~/foo.setup
-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.
-
- 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.
+Done!
+
+## Using the web interface
+
+Now you can go to the url it told you, and edit pages in your new wiki
+using the web interface.
+
+(If the web interface doesn't seem to allow editing or login, you may
+need to [[configure_the_web_server|tips/dot_cgi]].)
+
+## Checkout and edit wiki source
+
+Part of the fun of using ikiwiki is not being limited to using the
+web for editing pages, and instead using your favorite text editor and
+[[Revision_Control_System|rcs]].
+
+To do this, you need to check out a copy of the source to your wiki.
+(You should avoid making changes directly to the `srcdir`, as that
+checkout is reserved for use by ikiwiki itself.)
+
+Depending on which [[Revision_Control_System|rcs]] you chose to use,
+you can run one of these commands to check out your own copy of your wiki's
+source. (Remember to replace "foo" with the real directory name.)
+
+ git clone foo.git foo.src
+ svn checkout file://`pwd`/foo.svn/trunk foo.src
+ cvs -d `pwd`/foo get -P ikiwiki
+ bzr clone foo foo.src
+ hg clone foo foo.src
+ darcs get foo.darcs foo.src
+ # TODO monotone, tla
+
+Now to edit pages by hand, go into the directory you checked out (ie,
+"foo.src"), and fire up your text editor to edit `index.mdwn` or whatever
+other page you want to edit. If you chose to set up a blog, there is even a
+sample first post in `posts/first_post.mdwn` that you can edit.
+
+Once you've edited a page, use your revision control system to commit
+the changes. For distributed revision control systems, don't forget to push
+your commit.
+
+Once the commit reaches the repository, ikiwiki will notice it, and
+automatically update the wiki with your changes.
+
+## Customizing the wiki
- Note that the default file has a block to configure a svn wrapper. This
- sets up a [[post-commit]] hook to update the wiki.
+There are lots of things you can configure to customize your wiki.
+These range from changing the wiki's name, to enabling [[plugins]],
+to banning users and locking pages.
- When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
- will set everything up and update your wiki.
+If you log in as the admin user you configured earlier, and go to
+your Preferences page, you can click on "Setup" to customize many
+wiki settings and plugins.
-8. Set up [[CGI]] to allow editing the wiki from the web.
+Some settings cannot be configured on the web, for security reasons or
+because misconfiguring them could break the wiki. To change these settings,
+you can manually edit the setup file, which is named something like
+"foo.setup". The file lists all available configuration settings
+and gives a brief description of each.
- 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!
+After making changes to this file, you need to tell ikiwiki to use it:
-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:
+ % ikiwiki --setup foo.setup
- `http://svn.host/trunk/\[[file]]?root=wiki`
+Alternatively, you can ask ikiwiki to change settings in the file for you:
+
+ % ikiwiki --changesetup foo.setup --plugin goodstuff
+
+See [[usage]] for more options.
+
+## Customizing file locations
+
+As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
+and outputs the files to a destination directory. The source directory is
+a working copy checked out from the version control system repository.
+
+When you used `auto.setup`, ikiwiki put the source directory, destination
+directory, and repository in your home directory, and told you the location
+of each. Those locations were chosen to work without customization, but you
+might want to move them to different directories.
+
+First, move the destination directory and repository around.
- Then run `ikiwiki --setup ikiwiki.setup` again.
+ % mv public_html/foo /srv/web/foo.com
+ % mv foo.git /srv/git/foo.git
+
+If you moved the repository to a new location, checkouts pointing at the
+old location won't work, and the easiest way to deal with this is to delete
+them and re-checkout from the new repository location.
+
+ % rm -rf foo
+ % git clone /srv/git/foo.git
+
+Finally, edit the setup file. Modify the settings for `srcdir`, `destdir`,
+`url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
+you moved things. Remember to run `ikiwiki --setup` after editing the
+setup file.
+
+## Enjoy your new wiki!
+
+Add yourself to [[IkiWikiUsers]]. And check out
+the [[tips]] to find out how to get more out of ikiwiki.
+
+----
+
+_Notes_:
-10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
+- If you are searching for the file where the users are stored, it's in `your_repository/.ikiwiki/userdb`. The one which is in YOUR REPOSITORY, it cannot be found into your `~/.ikiwiki`.
+- If you want to enable a plugin you **WILL HAVE** to add it to the `add_plugins` array in the `*.setup` file (or to use the `--plugin` switch while calling `ikiwiki`). Uncommenting the plugin options/configuration fields in the setup is not **ALWAYS** sufficient. You have been warned.