ikiwiki.mdwn 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. [[!meta date="2014-05-10"]]
  2. This document will guide you through the process of setting up an online wiki
  3. using ikiwiki. Much of the instructions is general-purpose, but they are
  4. specifically written for use on Debian 7 stable with a Gitolite git server. The
  5. instructions also give hints to users of I2P and home server admins, and assume
  6. you followed the git server tutorial or at least have a similar setup.
  7. Table of Contents
  8. =================
  9. 1. [[!traillink Ikiwiki_Setup]]
  10. 2. [[!traillink Git_Server]]
  11. 3. [[!traillink Right_to_Left]]
  12. 4. [[!traillink Summary]]
  13. 5. [[!traillink Useful_Links]]
  14. If you already somewhat familiar with these tools and just want a quick list of
  15. commands to run in order to setup the wiki, go to the Summary section.
  16. Otherwise, the information in the other sections supplies useful information.
  17. Scenario
  18. ========
  19. I assume you have a computer running Debiab 7 stable (current release at the
  20. time or writing is 7.5), and you want to run a wiki server on it. The wiki will
  21. be managed by 'ikiwiki', the flexible RCS-backed wiki compiler. I also assume
  22. you already have a git server of some sort: either you set up a new one for the
  23. wiki, or you already had one - possibly using Gitolite. Maybe you already have
  24. Gitweb served, which ikiwiki can use for comparing wiki page versions - if you
  25. don't, you can check the git server tutorial for setup instructions.
  26. Also, maybe you want to serve the wiki as an I2P eepsite, or a Tor hidden
  27. service. Or as an eepsite, a Tor hidden service and a regular clearnet website
  28. at the same time. This document doesn't explain how to use them all together,
  29. but it gives hints fr I2P and Tor (I serve my wiki as an eepsite and also a Tor
  30. hidden service, but the links between pages are not modified, so it may not be
  31. the best way to do it).
  32. There are tutorials on the web explaining how to configure Apache and Nginx for
  33. ikiwiki, but not much information for Lighttpd. I use lighttpd, and this
  34. document explains my configuration. It's very simple, but I want to make sure it
  35. is documented on the web so everyone can use and enjoy it.
  36. First we will see how to get ikiwiki running, and then begin to add features and
  37. get closer to the final working setup. We will also see how to use ikiwiki with
  38. gitolite, which is not difficult but probably not the most trivial setup.
  39. There's a ikiwiki tip explaining the issue, but here it is covered in more
  40. depth, providing the exact commands for the suggested setup.
  41. Convention: Command lines beginning with '$' should be run by the specified
  42. user. If no user is specified, you can do them as your own user. Command lines
  43. beginning with '#' should be run as root. You can use `su` to become root, or
  44. prefix these commands with `sudo`.
  45. Let us begin.
  46. Software Details
  47. ================
  48. GNU/Linux distribution used: Debian 7 stable (release 7.5).
  49. Package versions:
  50. git................ 1:1.7.10.4-1+wheezy1
  51. gitolite........... 2.3-1
  52. lighttpd........... 1.4.31-4+deb7u2
  53. gitweb............. 1:1.7.10.4-1+wheezy1
  54. git-daemon-run..... 1:1.7.10.4-1+wheezy1
  55. git-daemon-sysvinit 1:1.7.10.4-1+wheezy1
  56. openssh-server..... 1:6.0p1-4
  57. perl............... 5.14.2-21+deb7u1
  58. I2P................ 0.9.12
  59. ikiwiki............ 3.20120629