urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge commit 'upstream/master' into prv/po 

Conflicts:

	debian/control
master
intrigeri 2009-01-15 20:04:31 +01:00
parent 48de7f9c7b 63fe022602
commit e6992480e2
22 changed files with 471 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
IkiWiki.pm
View File

@ -26,7 +26,7 @@ our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
%pagesources %destsources);
our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
our $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
# Optimisation.
use Memoize;

12
IkiWiki/Setup/Automator.pm
View File

@ -73,8 +73,18 @@ sub import (@) {
print "\n\nSetting up $config{wikiname} ...\n";
# Set up the repository.
# Set up the srcdir.
mkpath($config{srcdir}) || die "mkdir $config{srcdir}: $!";
# Copy in example wiki.
if (exists $config{example}) {
# cp -R is POSIX
# Another reason not to use -a is so that pages such as blog
# posts will not have old creation dates on this new wiki.
system("cp -R $IkiWiki::installdir/share/ikiwiki/examples/$config{example}/* $config{srcdir}");
delete $config{example};
}
# Set up the repository.
delete $config{repository} if ! $config{rcs} || $config{rcs}=~/bzr|mercurial/;
if ($config{rcs}) {
my @params=($config{rcs}, $config{srcdir});

10
Makefile.PL
View File

@ -69,6 +69,15 @@ extra_install:
install -m 644 $$file $(DESTDIR)$(PREFIX)/share/ikiwiki/directives/ikiwiki/directive; \
fi \
done
# Install example sites.
for dir in `cd doc/examples; find -type d ! -regex '.*\.svn.*'`; do \
install -d $(DESTDIR)$(PREFIX)/share/ikiwiki/examples/$$dir; \
done
for file in `cd doc/examples; find -type f ! -regex '.*\.svn.*'`; do \
cp -aL doc/examples/$$file $(DESTDIR)$(PREFIX)/share/ikiwiki/examples/$$file || \
install -m 644 doc/examples/$$file $(DESTDIR)$(PREFIX)/share/ikiwiki/examples/$$file; \
done
for dir in `find templates -follow -type d ! -regex '.*\.svn.*'`; do \
install -d $(DESTDIR)$(PREFIX)/share/ikiwiki/$$dir; \
@ -111,6 +120,7 @@ extra_install:
-install -d $(DESTDIR)/etc/ikiwiki
-install -m 0644 wikilist $(DESTDIR)/etc/ikiwiki
-install -m 0644 auto.setup $(DESTDIR)/etc/ikiwiki
-install -m 0644 auto-blog.setup $(DESTDIR)/etc/ikiwiki
}
}

48
auto-blog.setup 100644
View File

@ -0,0 +1,48 @@
#!/usr/bin/perl
# Ikiwiki setup automator -- blog version.
#
# This setup file causes ikiwiki to create a wiki, containing a blog,
# check it into revision control, generate a setup file for the new
# wiki, and set everything up.
#
# Just run: ikiwiki -setup /etc/ikiwiki/auto-blog.setup
#
# By default, it asks a few questions, and confines itself to the user's home
# directory. You can edit it to change what it asks questions about, or to
# modify the values to use site-specific settings.
require IkiWiki::Setup::Automator;
our $wikiname=IkiWiki::Setup::Automator::ask(
gettext("What will the blog be named?"), gettext("blog"));
our $rcs=IkiWiki::Setup::Automator::ask(
gettext("What revision control system to use?"), "git");
our $admin=IkiWiki::Setup::Automator::ask(
gettext("What wiki user (or openid) will be admin?"), $ENV{USER});
use Net::Domain q{hostfqdn};
our $domain=hostfqdn() || ikiwiki::setup::automator::ask(
gettext("What is the domain name of the web server?"), "");
IkiWiki::Setup::Automator->import(
wikiname => $wikiname,
adminuser => [$admin],
rcs => $rcs,
srcdir => "$ENV{HOME}/$wikiname",
destdir => "$ENV{HOME}/public_html/$wikiname",
repository => "$ENV{HOME}/$wikiname.".($rcs eq "monotone" ? "mtn" : $rcs),
dumpsetup => "$ENV{HOME}/$wikiname.setup",
url => "http://$domain/~$ENV{USER}/$wikiname",
cgiurl => "http://$domain/~$ENV{USER}/$wikiname/ikiwiki.cgi",
cgi_wrapper => "$ENV{HOME}/public_html/$wikiname/ikiwiki.cgi",
adminemail => "$ENV{USER}\@$domain",
add_plugins => [qw{goodstuff websetup comments}],
disable_plugins => [qw{}],
libdir => "$ENV{HOME}/.ikiwiki",
rss => 1,
atom => 1,
syslog => 1,
example => "blog",
comments_pagespec => "posts/* and !*/Discussion",
discussion => 0,
)

3
auto.setup
View File

@ -17,7 +17,7 @@ our $wikiname=IkiWiki::Setup::Automator::ask(
our $rcs=IkiWiki::Setup::Automator::ask(
gettext("What revision control system to use?"), "git");
our $admin=IkiWiki::Setup::Automator::ask(
gettext("What wiki user (or openid) will be wiki admin?"), $ENV{USER});
gettext("What wiki user (or openid) will be admin?"), $ENV{USER});
use Net::Domain q{hostfqdn};
our $domain=hostfqdn() || ikiwiki::setup::automator::ask(
gettext("What is the domain name of the web server?"), "");
@ -40,5 +40,4 @@ IkiWiki::Setup::Automator->import(
rss => 1,
atom => 1,
syslog => 1,
hardlink => 1,
)

7
debian/changelog vendored
View File

@ -12,7 +12,12 @@ ikiwiki (3.02) UNRELEASED; urgency=low
that take a page name parameter. Previously, match_created_before(),
match_created_after(), match_sourcepage(), and match_destpage()
did not support that, and the docs were not clear.
* pinger: Get whole url, don't just head.
* pinger: Get whole url, don't just head, avoids problems on
the nostromo web server.
* Recommend libterm-readline-gnu-perl since that makes auto.setup
behave better.
* Add auto-blog.setup, which will set up an ikiwiki instance tuned for use
in blogging.
-- Joey Hess <joeyh@debian.org> Tue, 06 Jan 2009 15:02:52 -0500

2
debian/control vendored
View File

@ -13,7 +13,7 @@ Vcs-Browser: http://git.ikiwiki.info/?p=ikiwiki
Package: ikiwiki
Architecture: all
Depends: ${perl:Depends}, libtext-markdown-perl | markdown, libhtml-scrubber-perl, libhtml-template-perl, libhtml-parser-perl, liburi-perl
Recommends: gcc | c-compiler, libc6-dev | libc-dev, subversion | git-core (>= 1:1.5.0) | tla | bzr (>= 0.91) | mercurial | monotone (>= 0.38), libxml-simple-perl, libnet-openid-consumer-perl, liblwpx-paranoidagent-perl, libtimedate-perl, libcgi-formbuilder-perl (>= 3.05), libcgi-session-perl (>= 4.14-1), libmail-sendmail-perl, libauthen-passphrase-perl
Recommends: gcc | c-compiler, libc6-dev | libc-dev, subversion | git-core (>= 1:1.5.0) | tla | bzr (>= 0.91) | mercurial | monotone (>= 0.38), libxml-simple-perl, libnet-openid-consumer-perl, liblwpx-paranoidagent-perl, libtimedate-perl, libcgi-formbuilder-perl (>= 3.05), libcgi-session-perl (>= 4.14-1), libmail-sendmail-perl, libauthen-passphrase-perl, libterm-readline-gnu-perl
Suggests: viewvc | gitweb | viewcvs, libsearch-xapian-perl, xapian-omega (>= 1.0.5), librpc-xml-perl, libtext-wikiformat-perl, python, python-docutils, polygen, tidy, libhtml-tree-perl, libxml-feed-perl, libmailtools-perl, perlmagick, libfile-mimeinfo-perl, libcrypt-ssleay-perl, liblocale-gettext-perl (>= 1.05-1), libtext-typography-perl, libtext-csv-perl, libdigest-sha1-perl, graphviz, libnet-amazon-s3-perl, sparkline-php, texlive, dvipng, po4a, gettext
Conflicts: ikiwiki-plugin-table
Replaces: ikiwiki-plugin-table

4
debian/preinst vendored
View File

@ -14,3 +14,7 @@ if [ "$1" = upgrade ] && dpkg --compare-versions "$2" lt 1.2; then
fi
fi
fi
if [ "$1" = upgrade ] && dpkg --compare-versions "$2" lt 3.02; then
# replaced by symlink
rm -rf /usr/share/doc/ikiwiki/examples
fi

3
debian/rules vendored
View File

@ -25,8 +25,9 @@ binary-indep: build
dh_clean -k
$(MAKE) pure_install DESTDIR=$(shell pwd)/debian/ikiwiki
dh_installdocs html
dh_installexamples doc/examples/*
dh_link usr/share/ikiwiki/examples usr/share/doc/ikiwiki/examples
dh_link usr/share/common-licenses/GPL-2 usr/share/doc/ikiwiki/html/GPL
dh_installexamples
dh_installchangelogs
dh_compress -X html
dh_fixperms

9
doc/examples/blog.mdwn
View File

@ -1,11 +1,12 @@
This is an [[example_blog|index]]. Just copy the blog subdirectory into
your wiki to quickly get started blogging with ikiwiki.
your wiki to quickly get started blogging with ikiwiki.
Or, run this command to set up a blog with ikiwiki.
% ikiwiki -setup /etc/ikiwiki/auto-blog.setup
Some additional configuration you might want to do:
* Change the name of the blog, by editing `index.mdwn` and changing
the `title`.
* Make sure to configure ikiwiki to generate RSS or Atom feeds.
* Make sure you have the tag plugin enabled, and tag posts using it. An

11
doc/examples/blog/index.mdwn
View File

@ -1,14 +1,13 @@
[[!meta title="example blog"]]
[[!pagestats pages="./tags/*"]]
Welcome to my blog. Have a look at the most recent posts below, or
browse the tag cloud on the right. An archive of all [[posts]] is also
available.
Welcome to my blog.
Have a look at the most recent posts below, or browse the tag cloud on the
right. An archive of all [[posts]] is also available.
[[!inline pages="./posts/* and !*/Discussion" show="10"
actions=yes rootpage="posts"]]
----
This wiki is powered by [ikiwiki](http://ikiwiki.info).
This blog is powered by [ikiwiki](http://ikiwiki.info).

2
doc/examples/blog/posts/first_post.mdwn
View File

@ -1,4 +1,4 @@
This is the first post to this example blog. To add new posts, just add
files to the blog/posts/ subdirectory, or use the web form.
files to the posts/ subdirectory, or use the web form.
[[!tag tags/tech]]

2
doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn
View File

@ -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.

287
doc/setup.mdwn
View File

@ -2,205 +2,132 @@ 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.
## 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.
[[!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
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!
## 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.
(If the web interface doesn't seem to allow editing or login, you may
need to configure [[configure_the_web_server|tips/dot_cgi]].)
## Checkout and edit wiki source
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]].
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.)
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.)
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
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.
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.
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. 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.
and outputs the files to a destination directory. The source directory is
a working copy checked out from the version control system repository.
For the purposes of this tutorial, we'll set shell variables
for these locations, and use those variables in the commands that follow.
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.
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).
"""]]
First, move the destination directory and repository around.
See [[ikiwiki/formatting]] for details about the markup language.
% mv public_html/foo /srv/web/foo.com
% mv foo.git /srv/git/foo.git
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.
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.
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.
% rm -rf foo
% git clone /src/git/foo.git
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 "<me@localhost>"
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.
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!

189
doc/setup/byhand.mdwn 100644
View File

@ -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 "<me@localhost>"
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.

25
doc/tips/apache_cgi.mdwn
View File

@ -1,25 +0,0 @@
Many ikiwiki examples name the [[cgi]] "ikiwiki.cgi", and put it somewhere
like `~/public_html/ikiwiki.cgi`, or `/var/www/wiki/ikiwiki.cgi`.
If you follow those examples, 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`.

50
doc/tips/dot_cgi.mdwn 100644
View File

@ -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.

2
doc/tips/laptop_wiki_with_git.mdwn
View File

@ -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

15
doc/tips/lighttpd_cgi.mdwn
View File

@ -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.

5
doc/todo/configurable_timezones.mdwn
View File

@ -3,3 +3,8 @@ It would be nice if the sure could set the timezone of the wiki, and have ikiwik
This is nice for shared hosting, and other situation where the user doesn't have control over the server timezone.
> [[done]] via the ENV setting in the setup file. --[[Joey]]
Example (ikiwiki.setup):
ENV => { TZ => "Europe/Sofia" }

22
doc/todo/pingback_support.mdwn 100644
View File

@ -0,0 +1,22 @@
A "pingback" is a system whereby URLs you might reference in a blog post are
contacted by the blog publishing software at publishing time (i.e., once) so
that they might update a list of "pingbacks" to the URL. The originating
URL's blog software might then display a list of pingbacks, or an excerpt of
the text from your blog, perhaps interleaved with comments, etc.
At a technical level, external URLs are extracted from your blog post by the
blogging software, fetched, inspected for information to determine whether the
remote server is configured to support pingbacks (look for link tags, or HTTP
headers) and the relevant pingback URL sent an XML-RPC packet.
There are other technologies to achieve the same thing: trackbacks predate
pingbacks but are more vulnerable to spam due to design problems.
The spec for pingbacks is at <http://www.hixie.ch/specs/pingback/pingback>.
I would like to somehow use pingbacks in conjunction with ikiwiki. I suppose
this could be achieved using a commit hook and some external software in which
case I will consider this done with an entry in [[tips]]; otherwise a
[[plugins|plugin]] to implement pingbacks would be great.
-- [[Jon]] (Wed Jan 14 13:48:47 GMT 2009)

2
pm_filter
View File

@ -7,7 +7,7 @@ BEGIN {
}
if (/INSTALLDIR_AUTOREPLACE/) {
$_=qq{my \$installdir="$prefix";};
$_=qq{our \$installdir="$prefix";};
}
elsif (/VERSION_AUTOREPLACE/) {
$_=qq{our \$version="$ver";};