From a86cbb8b9fde2211aca283e74f4f24ec84777860 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 17:16:01 -0500 Subject: rewrote This rewritten setup page starts with auto.setup and explains basic customisation and use after that has set up a wiki. It's much easier to follow than the old method, with less things to learn. (Downside: Less it learned.) --- doc/setup.mdwn | 275 +++++++++++++++++++++------------------------------------ 1 file changed, 103 insertions(+), 172 deletions(-) (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 1b8e4b12a..32e430ec7 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -2,205 +2,136 @@ This tutorial will walk you through setting up a wiki with ikiwiki. [[!toc ]] -## [[Download]] and [[install]] ikiwiki. +## [[Download]] and [[install]] ikiwiki 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. -## Quick start +## Create your wiki -If you'd like to set up a wiki now, and learn more later, and you have -ikiwiki 2.60 or better installed, just run this command and answer a couple -of questions. +All it takes to create a fully functional wiki using ikiwiki is running +one command. % ikiwiki -setup /etc/ikiwiki/auto.setup - What will the wiki be named? mywiki + +Or, set up a blog with ikiwiki, run this command instead. + + % ikiwiki -setup /etc/ikiwiki/auto-blog.setup + +Either way, it will ask you a couple of questions. + + What will the wiki be named? foo What revision control system to use? git - What wiki user (or openid) will be wiki admin? joey + What wiki user (or openid) will be admin? joey + Choose a password: -Wait for it to tell you an url for your new wiki.. Done! +Then, wait for it to tell you an url for your new site.. -(If the CGI doesn't seem to let you edit pages, you might need to -[[configure_apache|tips/apache_cgi]] or [[configure_lighttpd|tips/lighttpd_cgi]].) + 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 -## Decide where your wiki's files will go. +Done! -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. +## Using the web interface + +Now you can go to the url it told you, and edit pages in your new wiki +using the web interface. + +You can log in using the wiki user and password (or the openid) +that you told it to set up earlier. That user is an admin, so you can +go to the Preferences page and click on "Wiki Setup" to further +configure the wiki. + +(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]].) -For the purposes of this tutorial, we'll set shell variables -for these locations, and use those variables in the commands that follow. +## Checkout and edit wiki source - SRCDIR=~/wikiwc - DESTDIR=~/public_html/wiki/ +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]]. -Note that ikiwiki owns the working copy directory; do not perform your own -edits in ikiwiki's working copy. +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. -## Create the beginnings of your wiki. +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.) -This will create a simple main page for the wiki. + git clone foo.git foo.src + svn checkout file://`pwd`/foo.svn/trunk foo.src + bzr clone foo foo.src + hg clone foo foo.src + # TODO monotone, tla - mkdir $SRCDIR - cd $SRCDIR - $EDITOR index.mdwn +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. -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. +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. - All wikis are supposed to have a \[[SandBox]], - so this one does too. +Once the commit reaches the repository, ikiwiki will notice it, and +automatically update the wiki with your changes. - ---- +## Customizing the wiki + +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. + +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 +wiki settings and plugins. + +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. + +After making changes to this file, you need to tell ikiwiki to use it: + + % ikiwiki -setup foo.setup + +## Customizing file locations + +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. - This wiki is powered by [ikiwiki](http://ikiwiki.info). -"""]] - -See [[ikiwiki/formatting]] for details about the markup language. +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. -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. +1. Move the destination directory and repository around. -## Build your wiki for the first time. + % mv public_html/foo /srv/web/foo.com + % mv foo.git /srv/git/foo.git - ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ +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. -Replace the url with the real url to your wiki. You should now -be able to visit the url and see your wiki. + % rm -rf foo + % git clone /src/git/foo.git -## Add content to your wiki. - -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. - -You can experiment with other ikiwiki parameters such as `--wikiname` -and `--rebuild` too. Get comfortable with its command line (see -[[usage]]). - -## Add a setup file. - -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. - -To generate a setup file, use `ikiwiki --dumpsetup`. You can pass -all the options have you been including at the command line, and they -will be stored in the setup file. - - ikiwiki $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ --dumpsetup ikiwiki.setup - -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. - -When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it -will set everything up. - -## Turn on additional features. - -Now you have a basic wiki with a setup 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 -settings for the `cgi_wrapper`, make sure the filename for the cgi wrapper -is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done! - -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]].. - -## Put your wiki in revision control. - -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. - -Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and -should be preserved, but not checked into revision control. - -The [[ikiwiki-makerepo]] command automates setting up a wiki in -revision control. - -[[!toggle id=subversion text="Subversion"]] -[[!toggleable id=subversion text=""" - REPOSITORY=~/wikirepo - ikiwiki-makerepo svn $SRCDIR $REPOSITORY -"""]] - -[[!toggle id=git text="Git"]] -[[!toggleable id=git text=""" - REPOSITORY=~/wiki.git - ikiwiki-makerepo git $SRCDIR $REPOSITORY - -Please see [[rcs/git]] for detailed documentation about how -ikiwiki uses git repositories, and some important caveats -about using the git repositories. -"""]] - -[[!toggle id=mercurial text="Mercurial"]] -[[!toggleable id=mercurial text=""" - REPOSITORY=$SRCDIR - ikiwiki-makerepo mercurial $SRCDIR -"""]] - -[[!toggle id=bazaar text="Bazaar"]] -[[!toggleable id=bazaar text=""" - REPOSITORY=$SRCDIR - ikiwiki-makerepo bzr $SRCDIR -"""]] - -[[!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 -"""]] - -[[!toggle id=monotone text="Monotone"]] -[[!toggleable id=monotone text=""" - # This assumes that you have already used "mtn genkey you@hostname". - REPOSITORY=~/wiki.monotone - ikiwiki-makerepo monotone $SRCDIR $REPOSITORY -"""]] - -## Configure ikiwiki to use revision control. - -Once your wiki is checked in to the revision control system, you should -configure ikiwiki to use revision control. Edit your ikiwiki.setup, set -`rcs` to the the revision control system you chose to use. Be sure to set -`svnrepo` to the directory for your repository, if using subversion. -Uncomment the configuration for the wrapper for your revision control -system, and configure the wrapper path appropriately (for Git, it should be -the path to `hooks/post-update` inside the bare git repository). - -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. +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. ## Enjoy your new wiki! -- cgit v1.2.3 From b70c64d3f8c150abacbd5d3330409d8280a4f53f Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 19:09:29 -0500 Subject: add byhand document, containing the old setup document --- doc/setup.mdwn | 4 ++ doc/setup/byhand.mdwn | 189 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 193 insertions(+) create mode 100644 doc/setup/byhand.mdwn (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 32e430ec7..7f2661ec0 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -11,6 +11,10 @@ If you're not, see the [[download]] and [[install]] pages. 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]]. +"""]] % ikiwiki -setup /etc/ikiwiki/auto.setup diff --git a/doc/setup/byhand.mdwn b/doc/setup/byhand.mdwn new file mode 100644 index 000000000..9a2e1f3e9 --- /dev/null +++ b/doc/setup/byhand.mdwn @@ -0,0 +1,189 @@ +This tutorial will walk you through setting up a wiki with ikiwiki, +doing everything by hand. [[Setup]] has an easier method, but with less +control. + +[[!toc ]] + +## Decide where your wiki's files will go. + +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. + +For the purposes of this tutorial, we'll set shell variables +for these locations, and use those variables in the commands that follow. + + SRCDIR=~/wikiwc + DESTDIR=~/public_html/wiki/ + +Note that ikiwiki owns the working copy directory; do not perform your own +edits in ikiwiki's working copy. + +## Create the beginnings of your wiki. + +This will create a simple main page for the wiki. + + mkdir $SRCDIR + cd $SRCDIR + $EDITOR index.mdwn + +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. + + All wikis are supposed to have a \[[SandBox]], + so this one does too. + + ---- + + This wiki is powered by [ikiwiki](http://ikiwiki.info). +"""]] + +See [[ikiwiki/formatting]] for details about the markup language. + +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. + +## Build your wiki for the first time. + + ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ + +Replace the url with the real url to your wiki. You should now +be able to visit the url and see your wiki. + +## Add content to your wiki. + +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. + +You can experiment with other ikiwiki parameters such as `--wikiname` +and `--rebuild` too. Get comfortable with its command line (see +[[usage]]). + +## Add a setup file. + +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. + +To generate a setup file, use `ikiwiki --dumpsetup`. You can pass +all the options have you been including at the command line, and they +will be stored in the setup file. + + ikiwiki $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ --dumpsetup ikiwiki.setup + +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. + +When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it +will set everything up. + +## Turn on additional features. + +Now you have a basic wiki with a setup 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 +settings for the `cgi_wrapper`, make sure the filename for the cgi wrapper +is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done! + +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]].. + +## Put your wiki in revision control. + +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. + +Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and +should be preserved, but not checked into revision control. + +The [[ikiwiki-makerepo]] command automates setting up a wiki in +revision control. + +[[!toggle id=subversion text="Subversion"]] +[[!toggleable id=subversion text=""" + REPOSITORY=~/wikirepo + ikiwiki-makerepo svn $SRCDIR $REPOSITORY +"""]] + +[[!toggle id=git text="Git"]] +[[!toggleable id=git text=""" + REPOSITORY=~/wiki.git + ikiwiki-makerepo git $SRCDIR $REPOSITORY + +Please see [[rcs/git]] for detailed documentation about how +ikiwiki uses git repositories, and some important caveats +about using the git repositories. +"""]] + +[[!toggle id=mercurial text="Mercurial"]] +[[!toggleable id=mercurial text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo mercurial $SRCDIR +"""]] + +[[!toggle id=bazaar text="Bazaar"]] +[[!toggleable id=bazaar text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo bzr $SRCDIR +"""]] + +[[!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 +"""]] + +[[!toggle id=monotone text="Monotone"]] +[[!toggleable id=monotone text=""" + # This assumes that you have already used "mtn genkey you@hostname". + REPOSITORY=~/wiki.monotone + ikiwiki-makerepo monotone $SRCDIR $REPOSITORY +"""]] + +## Configure ikiwiki to use revision control. + +Once your wiki is checked in to the revision control system, you should +configure ikiwiki to use revision control. Edit your ikiwiki.setup, set +`rcs` to the the revision control system you chose to use. Be sure to set +`svnrepo` to the directory for your repository, if using subversion. +Uncomment the configuration for the wrapper for your revision control +system, and configure the wrapper path appropriately (for Git, it should be +the path to `hooks/post-update` inside the bare git repository). + +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. + +## Enjoy your new wiki! + +Add yourself to [[IkiWikiUsers]]. And check out +the [[tips]] to find out how to get more out of ikiwiki. -- cgit v1.2.3 From 68b8fd508f25705ca12327e3064a93ebeece7c7a Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 19:17:05 -0500 Subject: update --- doc/setup.mdwn | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 7f2661ec0..e0757f4e9 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -2,7 +2,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki. [[!toc ]] -## [[Download]] and [[install]] ikiwiki +## Install ikiwiki 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. @@ -46,11 +46,6 @@ Done! Now you can go to the url it told you, and edit pages in your new wiki using the web interface. -You can log in using the wiki user and password (or the openid) -that you told it to set up earlier. That user is an admin, so you can -go to the Preferences page and click on "Wiki Setup" to further -configure the wiki. - (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]].) @@ -62,8 +57,8 @@ web for editing pages, and instead using your favorite text editor and [[Revision_Control_System|rcs]]. 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. +(You should avoid making changes directly to the `srcdir`, as that +checkout is reserved for use by ikiwiki itself.) 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 -- cgit v1.2.3 From f90d1f335d5013a4d142c2cbcdf9e8803d4bf3ed Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 19:24:48 -0500 Subject: formatting --- doc/setup.mdwn | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index e0757f4e9..6382c06b2 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -116,16 +116,16 @@ this process. 1. 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. - % rm -rf foo - % git clone /src/git/foo.git +> % rm -rf foo +> % git clone /src/git/foo.git 3. Edit the setup file. Modify the settings for `srcdir`, `destdir`, `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where -- cgit v1.2.3 From d612de09404a3d51091d3c48d69ea16fd70517ea Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 19:26:10 -0500 Subject: formatting try again --- doc/setup.mdwn | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 6382c06b2..89143bd8d 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -115,17 +115,17 @@ might want to move them to different directories. There are three steps to this process. 1. 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. - -> % rm -rf foo -> % git clone /src/git/foo.git + + % rm -rf foo + % git clone /src/git/foo.git 3. Edit the setup file. Modify the settings for `srcdir`, `destdir`, `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where -- cgit v1.2.3 From 1c4357b13ef9f505fe150ee5f24bdc9540fa1f1b Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 19:28:33 -0500 Subject: formatting, again --- doc/setup.mdwn | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) (limited to 'doc/setup.mdwn') diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 89143bd8d..8d4d55cab 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -111,26 +111,24 @@ 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. 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 /src/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! -- cgit v1.2.3 From 756197f30fb735f92a44527fce2689a9c0ab058e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 12 Jan 2009 20:01:03 -0500 Subject: combine two pages --- ...ki__44___gitosis_and_apache2_in_Debian_Sid.mdwn | 2 +- doc/setup.mdwn | 3 +- doc/tips/apache_cgi.mdwn | 25 ----------- doc/tips/dot_cgi.mdwn | 50 ++++++++++++++++++++++ doc/tips/laptop_wiki_with_git.mdwn | 2 +- doc/tips/lighttpd_cgi.mdwn | 15 ------- 6 files changed, 53 insertions(+), 44 deletions(-) delete mode 100644 doc/tips/apache_cgi.mdwn create mode 100644 doc/tips/dot_cgi.mdwn delete mode 100644 doc/tips/lighttpd_cgi.mdwn (limited to 'doc/setup.mdwn') diff --git a/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn b/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn index d42a5c704..fa8b5010e 100644 --- a/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn +++ b/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn @@ -43,7 +43,7 @@ In the end, I did the following. I created a directory /srv/ikiwiki/ which is ow ## cgi_wrapper -I do not understand those wrappers completely. The cgi is a script, which can be called by a webserver, e. g. [[Apache_2|/tips/apache_cgi]]. But www-data is normally not allowed to write to the source directory (which is owned by gitosis or push to the repository). Therefore it should be run as the user gitosis. And because cgi scripts can not be made suid, I wrapper (in this case a C program) is created (cgi\_wrapper) which can be made suid and therefore be run as the user gitosis. Is this correct? +I do not understand those wrappers completely. The cgi is a script, which can be called by a webserver, e. g. [[Apache_2|/tips/dot_cgi]]. But www-data is normally not allowed to write to the source directory (which is owned by gitosis or push to the repository). Therefore it should be run as the user gitosis. And because cgi scripts can not be made suid, I wrapper (in this case a C program) is created (cgi\_wrapper) which can be made suid and therefore be run as the user gitosis. Is this correct? > It seems to me like you understand the wrapper pretty well. It's main reson to exist is to safely be suid, yes. diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 8d4d55cab..89444c9a8 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -47,8 +47,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 -need to configure [[apache|tips/apache_cgi]] or -[[lighttpd|tips/lighttpd_cgi]].) +need to configure [[configure_the_web_server|tips/dot_cgi]].) ## Checkout and edit wiki source diff --git a/doc/tips/apache_cgi.mdwn b/doc/tips/apache_cgi.mdwn deleted file mode 100644 index 3ceb0e182..000000000 --- a/doc/tips/apache_cgi.mdwn +++ /dev/null @@ -1,25 +0,0 @@ -It's common to name the [[cgi]] "ikiwiki.cgi", and put it somewhere -like `~/public_html/ikiwiki.cgi`, or `/var/www/wiki/ikiwiki.cgi`. - -If you do that, you may find that when trying to edit a page in your wiki, -you see the raw contents of the ikiwiki.cgi program. Or get a permission -denied problem. - -This is because apache is generally not configured to run cgi scripts -unless they're in `/usr/lib/cgi-bin/`. While you can put ikiwiki.cgi in -there if you like, here's how to configure apache (version 2) to run `.cgi` -programs from anywhere. - -These instructions are for Debian systems, but the basic apache -configuration should work anywhere. - -* Edit /etc/apache2/apache2.conf and add a line like this: - - AddHandler cgi-script .cgi - -* Find the "Options" line for the directory where you've put the - ikiwiki.cgi, and add "ExecCGI" to the list of options. For example, if - ikiwiki.cgi is in /var/www/, edit `/etc/apache2/sites-enabled/000-default` - and add it to the "Options" line in the "Directory /var/www/" stanza. - Or, if you've put it in a `~/public_html`, edit - `/etc/apache2/mods-available/userdir.conf`. diff --git a/doc/tips/dot_cgi.mdwn b/doc/tips/dot_cgi.mdwn new file mode 100644 index 000000000..fbc3d8bbc --- /dev/null +++ b/doc/tips/dot_cgi.mdwn @@ -0,0 +1,50 @@ +It's common to name the [[cgi]] "ikiwiki.cgi", and put it somewhere +like `~/public_html/ikiwiki.cgi`, or `/var/www/wiki/ikiwiki.cgi`. + +If you do that, you may find that when trying to edit a page in your wiki, +you see the raw contents of the ikiwiki.cgi program. Or get a permission +denied problem. + +This is because web servers are generally not configured to run cgi scripts +unless they're in `/usr/lib/cgi-bin/`. While you can put ikiwiki.cgi in +there if you like, it's better to configure your web server to +run `.cgi` programs from anywhere. + +These instructions are for Debian systems, but the basic +configuration changes should work anywhere. + +## apache 2 + +* Edit /etc/apache2/apache2.conf and add a line like this: + + AddHandler cgi-script .cgi + +* Find the "Options" line for the directory where you've put the + ikiwiki.cgi, and add "ExecCGI" to the list of options. For example, if + ikiwiki.cgi is in /var/www/, edit `/etc/apache2/sites-enabled/000-default` + and add it to the "Options" line in the "Directory /var/www/" stanza. + Or, if you've put it in a `~/public_html`, edit + `/etc/apache2/mods-available/userdir.conf`. + +## lighttpd + +Here is how to enable cgi on [lighttpd](http://www.lighttpd.net/) and +configure it in order to execute ikiwiki.cgi wherever it is located. + +* Activate cgi by linking `/etc/lighttpd/conf-available/10-cgi.conf` into `/etc/lighttpd/conf-enabled` ([doc](http://trac.lighttpd.net/trac/wiki/Docs%3AModCGI)). + +* Create `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` and add a line like this: + + cgi.assign = ( "ikiwiki.cgi" => "", ) + +* Activate ikiwiki-cgi by linking `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` into `/etc/lighttpd/conf-enabled`. + +* Restart lighttpd server with something like `/etc/init.d/lighttpd restart`. + +Note that the first part enables cgi server wide but depending on default +configuration, it may be not enough. The second part creates a specific +rule that allow `ikiwiki.cgi` to be executed. + +**Warning:** I only use this on my development server (offline). I am not +sure of how secure this approach is. If you have any thought about it, feel +free to let me know. diff --git a/doc/tips/laptop_wiki_with_git.mdwn b/doc/tips/laptop_wiki_with_git.mdwn index 998ac7443..9758beb80 100644 --- a/doc/tips/laptop_wiki_with_git.mdwn +++ b/doc/tips/laptop_wiki_with_git.mdwn @@ -15,7 +15,7 @@ for setting up ikiwiki with git. Next, `git clone` the source (`$REPOSITORY`, not `$SRCDIR`) from the server to the laptop. -Now, set up a [[web_server|apache_cgi]] on your laptop, if it doesn't +Now, set up a [[web_server|dot_cgi]] on your laptop, if it doesn't already have one. Now you need to write a setup file for ikiwiki on the laptop. Mostly this diff --git a/doc/tips/lighttpd_cgi.mdwn b/doc/tips/lighttpd_cgi.mdwn deleted file mode 100644 index 5504b0658..000000000 --- a/doc/tips/lighttpd_cgi.mdwn +++ /dev/null @@ -1,15 +0,0 @@ -Here is how to enable cgi on [lighttpd](http://www.lighttpd.net/) and configure it in order to execute ikiwiki.cgi wherever it is located. - -* Activate cgi by linking `/etc/lighttpd/conf-available/10-cgi.conf` into `/etc/lighttpd/conf-enabled` ([doc](http://trac.lighttpd.net/trac/wiki/Docs%3AModCGI)). - -* Create `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` and add a line like this: - - cgi.assign = ( "ikiwiki.cgi" => "", ) - -* Activate ikiwiki-cgi by linking `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` into `/etc/lighttpd/conf-enabled`. - -* Restart lighttpd server with something like `/etc/init.d/lighttpd restart`. - -Note that the first part enables cgi server wide but depending on default configuration, it may be not enough. The second part creates a specific rule that allow `ikiwiki.cgi` to be executed. - -**Warning:** I only use this on my development server (offline). I am not sure of how secure this approach is. If you have any thought about it, feel free to let me know. -- cgit v1.2.3