X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8973ba4723e115c87075793fabae07c92ceb6490..c142dba356b757facd6684a99623c58430b7221e:/doc/setup.mdwn?ds=inline diff --git a/doc/setup.mdwn b/doc/setup.mdwn index dd1a9be8c..c6005fb5d 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -1,142 +1,154 @@ -So you want to set up your own wiki using ikiwiki? This tutorial will walk -you through setting up a wiki that is stored in [[Subversion]], [[Git]], -[[TLA]] or [[Mercurial]], and that has optional support for commits from the web. - -1. [[Install]] ikiwiki. See [[download]] for where to get it. - -2. Create the master rcs repository for your wiki. - - # Subversion - svnadmin create /svn/wikirepo - svn mkdir file:///svn/wikirepo/trunk -m create - - # Git - mkdir /git/wikirepo - cd /git/wikirepo - git init-db - # Git requires something be in the repo to start with. - cp /usr/share/ikiwiki/basewiki/index.mdwn . - git add . - git commit -m create -a - # No need to keep files in the master repository; so at this - # stage, you may want to remove all files (except .git) to - # save disk space. - - # TLA - mkdir /tla - tla make-archive me@localhost--wiki /tla/wikirepo - tla my-id "" - - # Mercurial - hg init /hg/wikirepo - -3. Check out the repository to make the working copy that ikiwiki will use. - - # Subversion - svn co file:///svn/wikirepo/trunk ~/wikiwc - - # Git - # Create a local clone to save disk space and also to - # optimize performance. See git-clone(1). - git clone -l -s /git/wikirepo ~/wikiwc - - # TLA - mkdir ~/wikiwc - cd ~/wikiwc - tla archive-setup me@localhost--wiki/wiki--0 - tla init-tree me@localhost--wiki/wiki--0 - # Edit {arch}/=tagging-method and change the precious - # line to add the .ikiwiki directory to the regexp. - tla import - - # Mercurial - # Mercurial uses a single repo approach, so no need to - # clone anything. Because the following examples - # refer to the ~/wikiwc working copy we symlink it: - ln -s /hg/wikirepo ~/wikiwc - -4. Build your wiki for the first time. - - ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \ - --url=http://host/~you/wiki/ - - Replace the url with the real url to your wiki. You should now - be able to visit the url and see your wiki. - -5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are - used if you don't have a custom version, so let's start by making a - custom version of the wiki's index page: - - cd ~/wikiwc - cp /usr/share/ikiwiki/basewiki/index.mdwn . - $EDITOR index.mdwn - - # Subversion - svn add index.mdwn - svn commit -m customised index.mdwn - - # Git - git add index.mdwn - git commit -m customised index.mdwn - git push origin - - # TLA - tla add index.mdwn - tla commit - - # Mercurial - hg add index.mdwn - hg commit -m customised index.mdwn - - You can also add any files you like from scratch of course. - -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]]). - -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. - - If you want to use something other than subversion, comment out the - subversion configuration, and uncomment and edit the configuration for - your chosen RCS. - - Note that the default file has a block to configure a [[post-commit]] - wrapper to update the wiki. You need to uncomment the related block for - whatever RCS you use and comment out the other rcs blocks. - - When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it - will set everything up and update your wiki. - -8. Set up [[CGI]] to allow editing the wiki from the web. - - 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! - -9. Add [[PageHistory]] links to the top of pages. This requires you to have - setup a repository browser. For Subversion, you may use [[ViewCVS]] or - something similar to access your [[Subversion]] repository. For Git, - [[Gitweb]] can be used, etc. +This tutorial will walk you through setting up a wiki with ikiwiki. + +[[!toc ]] + +## 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. + +You may also want to try out a [[Docker image|https://github.com/elecnix/ikiwiki-docker]] with ikiwiki pre-installed. + +## Create your wiki + +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 + +Or, set up a blog with ikiwiki, run this command instead. + + % ikiwiki --setup /etc/ikiwiki/auto-blog.setup + +`librpc-xml-perl` and `python-docutils` dependencies are needed. + +Either way, it will ask you a couple of questions. + + 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: + +Then, wait for it to tell you an url for your new site.. + + 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 + +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 + +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 "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 + +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. - 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 ucomment the appropriate `historyurl` setting and edit - it for your setup. + % 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. - Then run `ikiwiki --setup ikiwiki.setup` again. + % 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.