X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3d5fb6d44f1190c8326e585cf320b7c117af3898..70d3d2328cc81e21c444d3f3d27d55cb8ac1611a:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 0350aead3..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 @@ -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.