[[!toc ]]
-## [[Download]] and [[install]] ikiwiki
+## 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.
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]].
+"""]]
% ikiwiki -setup /etc/ikiwiki/auto.setup
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]].)
+need to [[configure_the_web_server|tips/dot_cgi]].)
## Checkout and edit wiki source
[[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.
+(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
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
# TODO monotone, tla
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
+your Preferences page, you can click on "Setup" to customize many
wiki settings and plugins.
Some settings cannot be configured on the web, for security reasons or
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.
-
-1. Move the destination directory and repository around.
+might want to move them to different directories.
+First, move the destination directory and repository around.
+
% mv public_html/foo /srv/web/foo.com
% mv foo.git /srv/git/foo.git
-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.
-
+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 /src/git/foo.git
-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.
+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!