2006-11-20 23:57:20 +01:00
|
|
|
This tutorial will walk you through setting up a wiki with ikiwiki.
|
2006-03-11 01:40:34 +01:00
|
|
|
|
2008-07-21 13:32:31 +02:00
|
|
|
[[!toc ]]
|
2007-11-24 23:17:24 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
## [[Download]] and [[install]] ikiwiki
|
2006-03-12 03:21:02 +01:00
|
|
|
|
2008-05-06 01:14:33 +02:00
|
|
|
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.
|
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
## Create your wiki
|
2008-07-27 07:39:11 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
All it takes to create a fully functional wiki using ikiwiki is running
|
|
|
|
one command.
|
2009-01-13 01:09:29 +01:00
|
|
|
[[!template id=note text="""
|
|
|
|
For more control, advanced users may prefer to set up a wiki
|
|
|
|
[[by_hand|byhand]].
|
|
|
|
"""]]
|
2008-07-27 07:39:11 +02:00
|
|
|
|
2008-07-27 22:07:36 +02:00
|
|
|
% ikiwiki -setup /etc/ikiwiki/auto.setup
|
2009-01-12 23:16:01 +01:00
|
|
|
|
|
|
|
Or, set up a blog with ikiwiki, run this command instead.
|
|
|
|
|
|
|
|
% ikiwiki -setup /etc/ikiwiki/auto-blog.setup
|
|
|
|
|
|
|
|
Either way, it will ask you a couple of questions.
|
|
|
|
|
|
|
|
What will the wiki be named? foo
|
2008-07-27 07:39:11 +02:00
|
|
|
What revision control system to use? git
|
2009-01-12 23:16:01 +01:00
|
|
|
What wiki user (or openid) will be admin? joey
|
|
|
|
Choose a password:
|
2008-07-27 07:39:11 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
Then, wait for it to tell you an url for your new site..
|
2008-07-27 07:39:11 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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
|
2008-07-27 07:39:11 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
Done!
|
2006-11-20 12:02:27 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
## 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.
|
|
|
|
|
|
|
|
You can log in using the wiki user and password (or the openid)
|
|
|
|
that you told it to set up earlier. That user is an admin, so you can
|
|
|
|
go to the Preferences page and click on "Wiki Setup" to further
|
|
|
|
configure the wiki.
|
|
|
|
|
|
|
|
(If the web interface doesn't seem to allow editing or login, you may
|
|
|
|
need to configure [[apache|tips/apache_cgi]] or
|
|
|
|
[[lighttpd|tips/lighttpd_cgi]].)
|
2006-11-20 12:02:27 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
## Checkout and edit wiki source
|
2006-11-20 12:02:27 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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]].
|
2006-11-20 12:02:27 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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.
|
2007-02-13 23:07:45 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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.)
|
2006-03-11 01:40:34 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
git clone foo.git foo.src
|
|
|
|
svn checkout file://`pwd`/foo.svn/trunk foo.src
|
|
|
|
bzr clone foo foo.src
|
|
|
|
hg clone foo foo.src
|
|
|
|
# TODO monotone, tla
|
2006-06-02 07:32:20 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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.
|
2006-09-06 22:31:55 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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.
|
2006-11-20 23:57:20 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
Once the commit reaches the repository, ikiwiki will notice it, and
|
|
|
|
automatically update the wiki with your changes.
|
2006-11-20 23:57:20 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
## Customizing 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.
|
|
|
|
|
|
|
|
If you log in as the admin user you configured earlier, and go to
|
|
|
|
your Preferences page, you can click on "Wiki Setup" to customize many
|
|
|
|
wiki settings and plugins.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
After making changes to this file, you need to tell ikiwiki to use it:
|
|
|
|
|
|
|
|
% ikiwiki -setup foo.setup
|
|
|
|
|
|
|
|
## 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.
|
2006-03-11 01:40:34 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
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. There are three steps to
|
|
|
|
this process.
|
2006-03-11 01:40:34 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
1. Move the destination directory and repository around.
|
2006-03-29 20:21:01 +02:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
% mv public_html/foo /srv/web/foo.com
|
|
|
|
% mv foo.git /srv/git/foo.git
|
2006-11-22 06:03:22 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
2. Create a new source directory checkout. 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.
|
2006-03-13 20:29:21 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
% rm -rf foo
|
|
|
|
% git clone /src/git/foo.git
|
2007-11-16 19:22:40 +01:00
|
|
|
|
2009-01-12 23:16:01 +01:00
|
|
|
3. 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.
|
2007-11-16 19:22:40 +01:00
|
|
|
|
2007-11-24 23:19:45 +01:00
|
|
|
## Enjoy your new wiki!
|
2007-11-16 19:22:40 +01:00
|
|
|
|
|
|
|
Add yourself to [[IkiWikiUsers]]. And check out
|
|
|
|
the [[tips]] to find out how to get more out of ikiwiki.
|