]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/setup.mdwn
situation where rebuild needed
[git.ikiwiki.info.git] / doc / setup.mdwn
index 0350aead3c421ffac9339af51dadda20493c6359..9fc37c0b11bcd7d7e084af6b61e81f9ff1f79a46 100644 (file)
@@ -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 <code><a href="http://www.debian.org/doc/manuals/debian-reference/ch02.en.html#_basic_package_management_operations">apt-get</a> install ikiwiki</code> 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
@@ -107,7 +111,7 @@ After making changes to this file, you need to tell ikiwiki to use it:
 
 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.
 
@@ -143,3 +147,10 @@ setup file.
 
 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.