X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d9e347079e8c6517a08025dc632c09d44106b3f5..5d602a840763a1d552730ddee55361104e31c71b:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index a5c2082d6..9fc37c0b1 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -4,9 +4,13 @@ This tutorial will walk you through setting up a wiki with ikiwiki. ## Install ikiwiki -If you're using Debian or Ubuntu, ikiwiki is an `aptitude install ikiwiki` away. +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 sandboxed [[Docker image|https://github.com/elecnix/ikiwiki-docker]] +with ikiwiki pre-installed or this other [[one|https://github.com/dgsb/docker-ikiwiki]] which will use a volume to access a local git repository +for the wiki content. + ## Create your wiki All it takes to create a fully functional wiki using ikiwiki is running @@ -16,11 +20,11 @@ For more control, advanced users may prefer to set up a wiki [[by_hand|byhand]]. """]] - % ikiwiki -setup /etc/ikiwiki/auto.setup + % ikiwiki --setup /etc/ikiwiki/auto.setup Or, set up a blog with ikiwiki, run this command instead. - % ikiwiki -setup /etc/ikiwiki/auto-blog.setup + % ikiwiki --setup /etc/ikiwiki/auto-blog.setup `librpc-xml-perl` and `python-docutils` dependencies are needed. @@ -39,7 +43,7 @@ Then, wait for it to tell you an url for your new site.. destdir: ~/public_html/foo repository: ~/foo.git To modify settings, edit ~/foo.setup and then run: - ikiwiki -setup ~/foo.setup + ikiwiki --setup ~/foo.setup Done! @@ -103,11 +107,11 @@ 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 + % ikiwiki --setup foo.setup Alternatively, you can ask ikiwiki to change settings in the file for you: - % ikiwiki -changesetup foo.setup -plugin goodstuff + % ikiwiki --changesetup foo.setup --plugin goodstuff See [[usage]] for more options. @@ -136,10 +140,17 @@ them and re-checkout from the new repository location. 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 +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_: + +- 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.