doc/setup.mdwn

   1 This tutorial will walk you through setting up a wiki with ikiwiki.
   2
   3 [[!toc ]]
   4
   5 ## Install ikiwiki
   6
   7 If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
   8 If you're not, see the [[download]] and [[install]] pages.
   9
  10 ## Create your wiki
  11
  12 All it takes to create a fully functional wiki using ikiwiki is running
  13 one command.
  14 [[!template id=note text="""
  15 For more control, advanced users may prefer to set up a wiki
  16 [[by_hand|byhand]].
  17 """]]
  18
  19         % ikiwiki -setup /etc/ikiwiki/auto.setup
  20
  21 Or, set up a blog with ikiwiki, run this command instead.
  22
  23         % ikiwiki -setup /etc/ikiwiki/auto-blog.setup
  24
  25 Either way, it will ask you a couple of questions.
  26
  27         What will the wiki be named? foo
  28         What revision control system to use? git
  29         What wiki user (or openid) will be admin? joey
  30         Choose a password:
  31
  32 Then, wait for it to tell you an url for your new site..
  33
  34         Successfully set up foo:
  35                 url:         http://example.com/~joey/foo
  36                 srcdir:      ~/foo
  37                 destdir:     ~/public_html/foo
  38                 repository:  ~/foo.git
  39         To modify settings, edit ~/foo.setup and then run:
  40                 ikiwiki -setup ~/foo.setup
  41
  42 Done!
  43
  44 ## Using the web interface
  45
  46 Now you can go to the url it told you, and edit pages in your new wiki
  47 using the web interface.
  48
  49 (If the web interface doesn't seem to allow editing or login, you may
  50 need to [[configure_the_web_server|tips/dot_cgi]].)
  51
  52 ## Checkout and edit wiki source
  53
  54 Part of the fun of using ikiwiki is not being limited to using the
  55 web for editing pages, and instead using your favorite text editor and
  56 [[Revision_Control_System|rcs]].
  57
  58 To do this, you need to check out a copy of the source to your wiki.
  59 (You should avoid making changes directly to the `srcdir`, as that
  60 checkout is reserved for use by ikiwiki itself.)
  61
  62 Depending on which [[Revision_Control_System|rcs]] you chose to use,
  63 you can run one of these commands to check out your own copy of your wiki's
  64 source. (Remember to replace "foo" with the real directory name.)
  65
  66         git clone foo.git foo.src
  67         svn checkout file://`pwd`/foo.svn/trunk foo.src
  68         cvs -d `pwd`/foo get -P ikiwiki
  69         bzr clone foo foo.src
  70         hg clone foo foo.src
  71         darcs get foo foo.src
  72         # TODO monotone, tla
  73
  74 Now to edit pages by hand, go into the directory you checked out (ie,
  75 "foo.src"), and fire up your text editor to edit `index.mdwn` or whatever
  76 other page you want to edit. If you chose to set up a blog, there is even a
  77 sample first post in `posts/first_post.mdwn` that you can edit.
  78
  79 Once you've edited a page, use your revision control system to commit
  80 the changes. For distributed revision control systems, don't forget to push
  81 your commit.
  82
  83 Once the commit reaches the repository, ikiwiki will notice it, and
  84 automatically update the wiki with your changes.
  85
  86 ## Customizing the wiki
  87
  88 There are lots of things you can configure to customize your wiki.
  89 These range from changing the wiki's name, to enabling [[plugins]],
  90 to banning users and locking pages.
  91
  92 If you log in as the admin user you configured earlier, and go to
  93 your Preferences page, you can click on "Setup" to customize many
  94 wiki settings and plugins.
  95
  96 Some settings cannot be configured on the web, for security reasons or
  97 because misconfiguring them could break the wiki. To change these settings,
  98 you can manually edit the setup file, which is named something like
  99 "foo.setup". The file lists all available configuration settings
 100 and gives a brief description of each.
 101
 102 After making changes to this file, you need to tell ikiwiki to use it:
 103
 104         % ikiwiki -setup foo.setup
 105
 106 Alternatively, you can ask ikiwiki to change settings in the file for you:
 107
 108         % ikiwiki -changesetup foo.setup -plugin goodstuff
 109
 110 See [[usage]] for more options.
 111
 112 ## Customizing file locations
 113
 114 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
 115 and outputs the files to a destination directory. The source directory is
 116 a working copy checked out from the version control system repository.
 117
 118 When you used `auto.setup`, ikiwiki put the source directory, destination
 119 directory, and repository in your home directory, and told you the location
 120 of each. Those locations were chosen to work without customization, but you
 121 might want to move them to different directories.
 122
 123 First, move the destination directory and repository around.
 124
 125         % mv public_html/foo /srv/web/foo.com
 126         % mv foo.git /srv/git/foo.git
 127
 128 If you moved the repository to a new location, checkouts pointing at the
 129 old location won't work, and the easiest way to deal with this is to delete
 130 them and re-checkout from the new repository location.
 131
 132         % rm -rf foo
 133         % git clone /src/git/foo.git
 134
 135 Finally, edit the setup file. Modify the settings for `srcdir`, `destdir`,
 136 `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
 137 you moved things. Remember to run `ikiwiki -setup` after editing the
 138 setup file.
 139
 140 ## Enjoy your new wiki!
 141
 142 Add yourself to [[IkiWikiUsers]]. And check out
 143 the [[tips]] to find out how to get more out of ikiwiki.