X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/491847ed5311123b3ce58c636451c56a2a0f191b..3827d7227a717b47adfc766ffe30225b02b1dfaf:/doc/setup.mdwn?ds=inline diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 7e8973bbc..9fc37c0b1 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -1,197 +1,156 @@ This tutorial will walk you through setting up a wiki with ikiwiki. -[[toc ]] +[[!toc ]] -## [[Download]] and [[install]] ikiwiki. +## Install ikiwiki -## Decide where your wiki's files will go. +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. -As a wiki compiler, ikiwiki builds a wiki from files in a source directory, -and outputs the files to a destination directory. If you keep your wiki in -a version control system, the source directory will contain a working copy -checked out from the version control system. +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. -For the purposes of this tutorial, we'll set shell variables -for these locations, and use those variables in the commands that follow. +## Create your wiki - SRCDIR=~/wikiwc - DESTDIR=~/public_html/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]]. +"""]] -Note that ikiwiki owns the working copy directory; do not perform your own -edits in ikiwiki's working copy. + % ikiwiki --setup /etc/ikiwiki/auto.setup -## Create the beginnings of your wiki. +Or, set up a blog with ikiwiki, run this command instead. -This will create a simple main page for the wiki. + % ikiwiki --setup /etc/ikiwiki/auto-blog.setup - mkdir $SRCDIR - cd $SRCDIR - $EDITOR index.mdwn +`librpc-xml-perl` and `python-docutils` dependencies are needed. -In the editor, you could start by entering a simple page like -[[toggle id=page text="this one"]]. -[[toggleable id=page text=""" - Welcome to your new wiki. +Either way, it will ask you a couple of questions. - All wikis are supposed to have a \[[SandBox]], - so this one does too. + 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.. - This wiki is powered by [ikiwiki](http://ikiwiki.info). -"""]] - -See [[HelpOnFormatting]] for details about the markup language. + 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 -Note that several [[standard_wiki_pages|basewiki]] will be added to your -wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will -automatically get a [[SandBox]], and some other useful pages. +Done! -## Build your wiki for the first time. +## Using the web interface - ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ +Now you can go to the url it told you, and edit pages in your new wiki +using the web interface. -Replace the url with the real url to your wiki. You should now -be able to visit the url and see your wiki. +(If the web interface doesn't seem to allow editing or login, you may +need to [[configure_the_web_server|tips/dot_cgi]].) -## Add content to your wiki. +## Checkout and edit wiki source -Continue editing or adding pages and rebuilding the wiki. - -To quickly get started on a common task like blogging with ikiwiki, you -can copy in files from the [[examples]]. The examples are located in -`doc/examples/` in the ikiwiki source package. +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]]. -You can experiment with other ikiwiki parameters such as `--wikiname` -and `--rebuild` too. Get comfortable with its command line (see -[[usage]]). +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.) -## Add a setup file. +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.) -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. 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. Note that this -file should *not* be put in your wiki's directory with the rest of the -files. A good place to put it is in a ~/.ikiwiki/ subdirectory. - -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. Make sure that these are pointing to the right directories, and -read through and configure the rest of the file to your liking. + 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 -When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it -will set everything up. +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. -## Turn on additional features. +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. -Now you have a basic wiki with a configuration file. Time to experiment -with ikiwiki's many features. - -Let's first enable a key wiki feature and 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! +Once the commit reaches the repository, ikiwiki will notice it, and +automatically update the wiki with your changes. -There are lots of other configuration options in ikiwiki.setup that you -can uncomment, configure, and enable by re-running -`ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the -[[plugins]].. +## Customizing the wiki -## Put your wiki in revision control. +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. -At this point you might want to check your wiki in to a revision control -system so you can keep track of changes and revert edits. Depending -on the revision control system you choose, the way this is done varies. +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. -Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and -should be preserved, but not checked into revision control. +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. -The new [[ikiwiki-makerepo]] command automates setting up a wiki in -revision control. +After making changes to this file, you need to tell ikiwiki to use it: -[[toggle id=subversion text="Subversion"]] -[[toggleable id=subversion text=""" - REPOSITORY=~/wikirepo - ikiwiki-makerepo svn $SRCDIR $REPOSITORY -"""]] + % ikiwiki --setup foo.setup -[[toggle id=git text="Git"]] -[[toggleable id=git text=""" - REPOSITORY=~/wiki.git - ikiwiki-makerepo git $SRCDIR $REPOSITORY +Alternatively, you can ask ikiwiki to change settings in the file for you: - Please see [[rcs/git]] for detailed documentation about how - ikiwiki uses git repositories, and some important caveats - about using the git repositories. -"""]] + % ikiwiki --changesetup foo.setup --plugin goodstuff -[[toggle id=mercurial text="Mercurial"]] -[[toggleable id=mercurial text=""" - REPOSITORY=$SRCDIR - ikiwiki-makerepo mercurial $SRCDIR -"""]] +See [[usage]] for more options. -[[toggle id=tla text="TLA"]] -[[toggleable id=tla text=""" - REPOSITORY=~/wikirepo - tla make-archive me@localhost--wiki $REPOSITORY - tla my-id "" - cd $SRCDIR - 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 add * - tla import -"""]] +## Customizing file locations -[[toggle id=monotone text="Monotone"]] -[[toggleable id=monotone text=""" - # These instructions are standard instructions to import a directory into monotone - # and set it up so that you don't need any passwords to use it - REPOSITORY=~/.ikiwiki/mtn.db - BRANCH=com.company.wikiname - # remember the password you use in the next step and - # substitute it for 'wikiKeyPass' in the get_passphrase() hook below - # note the you should never generate two monotone keys with the same name - mtn genkey web@machine.company.com - mtn db init --db=$REPOSITORY - mv $SRCDIR $SRCDIR-old - cd $SRCDIR-old - echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore - mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import" - cd .. - mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR - mv $SRCDIR-old/.ikiwiki $SRCDIR - cat << EOF > $SRCDIR/_MTN/monotonerc - function get_passphrase (branchname) - return "wikiKeyPass" - end - EOF - rm -r $SRCDIR-old -"""]] +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. -## Configure ikiwiki to use revision control. +First, move the destination directory and repository around. + + % mv public_html/foo /srv/web/foo.com + % mv foo.git /srv/git/foo.git -Once your wiki is checked in to the revision control system, -you should configure ikiwiki to use revision control. Edit your -ikiwiki.setup, and uncomment the lines for the revision control system -you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using -subversion. Uncomment the block for the wrapper for your revision -control system, and configure the wrapper path in that block -appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`). +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 /srv/git/foo.git -Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more. -Now you should be able to edit files in $SRCDIR, and use your revision -control system to commit them, and the wiki will automatically update. -And in the web interface, RecentChanges should work, and files changed -by web users will also be committed using revision control. +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_: + +- 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.