updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 89143bd8d53abb86593452b91a180033b7b106ff..9fc37c0b11bcd7d7e084af6b61e81f9ff1f79a46 100644 (file)
--- 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
 
 
 ## Install ikiwiki
 

-If you're using Debian or Ubuntu, ikiwiki is an `apt-get 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.
 
 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
 ## Create your wiki
 
 All it takes to create a fully functional wiki using ikiwiki is running


@@ -16,11 +20,13 @@ For more control, advanced users may prefer to set up a wiki
 [[by_hand|byhand]].
 """]]
 
 [[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.
 
 
 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.

 
 Either way, it will ask you a couple of questions.
 
 
 Either way, it will ask you a couple of questions.
 


@@ -37,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:
                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! 
 
 
 Done! 
 


@@ -47,8 +53,7 @@ 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
 using the web interface.
 
 (If the web interface doesn't seem to allow editing or login, you may

-need to configure [[apache|tips/apache_cgi]] or 
-[[lighttpd|tips/lighttpd_cgi]].)
+need to [[configure_the_web_server|tips/dot_cgi]].)

 
 ## Checkout and edit wiki source
 
 
 ## Checkout and edit wiki source
 


@@ -66,8 +71,10 @@ 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
 
        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
        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,
        # TODO monotone, tla
 
 Now to edit pages by hand, go into the directory you checked out (ie,


@@ -89,7 +96,7 @@ 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
 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 "Wiki Setup" to customize many
+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
 wiki settings and plugins.
 
 Some settings cannot be configured on the web, for security reasons or


@@ -100,7 +107,13 @@ and gives a brief description of each.
 
 After making changes to this file, you need to tell ikiwiki to use it:
 
 
 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
+
+See [[usage]] for more options.

 
 ## Customizing file locations
 
 
 ## Customizing file locations
 


@@ -111,28 +124,33 @@ 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
 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. There are three steps to
-this process.
+might want to move them to different directories.

 
 

-1. Move the destination directory and repository around.
+First, move the destination directory and repository around.

    
    

-       % mv public_html/foo /srv/web/foo.com
-       % mv foo.git /srv/git/foo.git
+       % mv public_html/foo /srv/web/foo.com
+       % mv foo.git /srv/git/foo.git

 
 

-2. Create a new source directory checkout. 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.
+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.

    
    

-       % rm -rf foo
-       % git clone /src/git/foo.git
+       % rm -rf foo
+       % git clone /srv/git/foo.git

 
 

-3. 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.
+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.
 
 ## 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.