diff options
Diffstat (limited to 'ikiwiki.setup')
| -rw-r--r-- | ikiwiki.setup | 296 |
1 files changed, 192 insertions, 104 deletions
diff --git a/ikiwiki.setup b/ikiwiki.setup index 20ce485b..89130e2b 100644 --- a/ikiwiki.setup +++ b/ikiwiki.setup @@ -1,9 +1,10 @@ #!/usr/bin/perl -# Setup file for ikiwiki. # +# Setup file for ikiwiki. +# # Passing this to ikiwiki --setup will make ikiwiki generate # wrappers and build the wiki. -# +# # Remember to re-run ikiwiki --setup any time you edit this file. require IkiWiki::Setup::Standard; @@ -38,7 +39,9 @@ IkiWiki::Setup::Standard->import({ # users who are wiki admins adminuser => [qw{tschwinge}], # users who are banned from the wiki - banned_users => [], + banned_users => [qw{AlbertF bernhart ColetCris flamberian jasclaine + http://calvinyoung.myopenid.com/ + http://hilarybunton.myopenid.com/}], # where the source of the wiki is located srcdir => $srcdir, # where to build the wiki @@ -47,7 +50,7 @@ IkiWiki::Setup::Standard->import({ url => 'http://www.bddebian.com:8888/~hurd-web', # url to the ikiwiki.cgi cgiurl => 'http://www.bddebian.com:8888/cgi-bin/hurd-web-ikiwiki.cgi', - # cgi wrapper to generate + # filename of cgi wrapper to generate cgi_wrapper => $cgi_wrapper, # mode for cgi_wrapper (can safely be made suid) cgi_wrappermode => '06755', @@ -57,22 +60,26 @@ IkiWiki::Setup::Standard->import({ add_plugins => [qw{goodstuff cutpaste editdiff edittemplate favicon html sidebar table txt copyright license texinfo}], # plugins to disable disable_plugins => [], - # location of template files + # additional directory to search for template files templatedir => $srcdir.'/.templates', # base wiki source location #underlaydir => '/usr/share/ikiwiki/basewiki', - # display verbose messages when building? + # display verbose messages? verbose => 1, # log to syslog? syslog => 0, # create output files named page/index.html? usedirs => 1, # use '!'-prefixed preprocessor directives? - prefix_directives => 0, + prefix_directives => 1, # use page/index.mdwn source files indexpages => 0, # enable Discussion pages? discussion => 1, + # name of Discussion pages + discussionpage => 'Discussion', + # generate HTML5? (experimental) + html5 => 0, # only send cookies over SSL connections? sslcookie => 0, # extension to use for new pages @@ -91,17 +98,26 @@ IkiWiki::Setup::Standard->import({ hardlink => 1, # force ikiwiki to use a particular umask #umask => 022, + # group for wrappers to run in + #wrappergroup => 'ikiwiki', # extra library and plugin directory libdir => $srcdir.'/.library', # environment variables ENV => {}, - # regexp of source files to ignore - #exclude => '\\.wav$', + # regexp of normally excluded files to include + #include => '^\\.htaccess$', + # regexp of files that should be skipped + #exclude => '^(*\\.private|Makefile)$', # specifies the characters that are allowed in source filenames wiki_file_chars => '-[:alnum:]+/.:_', # allow symlinks in the path leading to the srcdir (potentially insecure) #allow_symlinks_before_srcdir => 0, + ###################################################################### + # core plugins + # (editpage, git, htmlscrubber, inline, link, meta) + ###################################################################### + # git plugin # git hook to generate git_wrapper => $git_wrapper, @@ -113,43 +129,13 @@ IkiWiki::Setup::Standard->import({ #untrusted_committers => [], # gitweb url to show file history ([[file]] substituted) historyurl => 'http://www.bddebian.com:8888/gitweb/?p=hurd-web;a=history;f=[[file]]', - # gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], [[sha1_commit]] and [[file]] substituted) + # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted) diffurl => 'http://www.bddebian.com:8888/gitweb/?p=hurd-web;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]', # where to pull and push changes (set to empty string to disable) gitorigin_branch => $gitorigin_branch, # branch that the wiki is stored in gitmaster_branch => 'master', - # aggregate plugin - # enable aggregation to internal pages? - #aggregateinternal => 0, - # allow aggregation to be triggered via the web? - #aggregate_webtrigger => 0, - - # anonok plugin - # PageSpec to limit which pages anonymous users can edit - #anonok_pagespec => '*/discussion', - - # attachment plugin - # enhanced PageSpec specifying what attachments are allowed - #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)', - # virus checker program (reads STDIN, returns nonzero if virus found) - #virus_checker => 'clamdscan -', - - # bzr plugin - # bzr post-commit hook to generate - #bzr_wrapper => '', - # mode for bzr_wrapper (can safely be made suid) - #bzr_wrappermode => '06755', - # url to show file history, using loggerhead ([[file]] substituted) - #historyurl => '', - # url to view a diff, using loggerhead ([[file]] and [[r2]] substituted) - #diffurl => 'http://example.com/revision?start_revid=[[r2]]#[[file]]-s', - - # calendar plugin - # base of the archives hierarchy - #archivebase => 'archives', - # htmlscrubber plugin # PageSpec specifying pages not to scrub #htmlscrubber_skip => '!*/Discussion', @@ -166,77 +152,144 @@ IkiWiki::Setup::Standard->import({ # urls to ping (using XML-RPC) on feed update pingurl => [], - # listdirectives plugin - # directory in srcdir that contains directive descriptions - #directive_description_dir => 'ikiwiki/directive', + ###################################################################### + # auth plugins + # (anonok, blogspam, httpauth, lockedit, moderatedcomments, + # opendiscussion, openid, passwordauth, signinedit) + ###################################################################### + + # anonok plugin + # PageSpec to limit which pages anonymous users can edit + #anonok_pagespec => '*/discussion', + + # blogspam plugin + # PageSpec of pages to check for spam + #blogspam_pagespec => 'postcomment(*)', + # options to send to blogspam server + #blogspam_options => 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10', + # blogspam server XML-RPC url + #blogspam_server => '', + + # httpauth plugin + # url to redirect to when authentication is needed + #cgiauthurl => 'http://example.com/wiki/auth/ikiwiki.cgi', + # PageSpec of pages where only httpauth will be used for authentication + #httpauth_pagespec => '!*/Discussion', # lockedit plugin # PageSpec controlling which pages are locked #locked_pages => '!*/Discussion', + # moderatedcomments plugin + # PageSpec matching users or comment locations to moderate + #moderate_pagespec => '*', + + # passwordauth plugin + # a password that must be entered when signing up for an account + #account_creation_password => 's3cr1t', + # cost of generating a password using Authen::Passphrase::BlowfishCrypt + #password_cost => 8, + + ###################################################################### + # format plugins + # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, + # txt) + ###################################################################### + + # highlight plugin + # types of source files to syntax highlight + #tohighlight => '.c .h .cpp .pl .py Makefile:make', + # mdwn plugin # enable multimarkdown features? #multimarkdown => 0, - # mercurial plugin - # mercurial post-commit hook to generate - #mercurial_wrapper => '', - # mode for mercurial_wrapper (can safely be made suid) - #mercurial_wrappermode => '06755', - # url to hg serve'd repository, to show file history ([[file]] substituted) - #historyurl => 'http://example.com:8000/log/tip/[[file]]', - # url to hg serve'd repository, to show diff ([[file]] and [[r2]] substituted) - #diffurl => 'http://localhost:8000/?fd=[[r2]];file=[[file]]', + # po plugin + # master language (non-PO files) + #po_master_language => { + # code => 'en', + # name => 'English' + #}, + # slave languages (PO files) + #po_slave_languages => { + # de => 'Deutsch', + # es => 'Español', + # fr => 'Français' + #}, + # PageSpec controlling which pages are translatable + #po_translatable_pages => '* and !*/Discussion', + # internal linking behavior (default/current/negotiated) + #po_link_to => 'current', - # mirrorlist plugin - # list of mirrors - #mirrorlist => {}, + ###################################################################### + # web plugins + # (attachment, comments, editdiff, edittemplate, getsource, + # google, mirrorlist, remove, rename, repolist, search, + # websetup, wmd) + ###################################################################### - # openid plugin - # an url where users can signup for an OpenID - #openidsignup => 'http://myopenid.com/', + # attachment plugin + # enhanced PageSpec specifying what attachments are allowed + #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)', + # virus checker program (reads STDIN, returns nonzero if virus found) + #virus_checker => 'clamdscan -', - # passwordauth plugin - # a password that must be entered when signing up for an account - #account_creation_password => 's3cr1t', - # cost of generating a password using Authen::Passphrase::BlowfishCrypt - #password_cost => 8, + # comments plugin + # PageSpec of pages where comments are allowed + #comments_pagespec => 'blog/* and !*/Discussion', + # PageSpec of pages where posting new comments is not allowed + #comments_closed_pagespec => 'blog/controversial or blog/flamewar', + # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12" + #comments_pagename => '', + # Interpret directives in comments? + #comments_allowdirectives => 0, + # Allow anonymous commenters to set an author name? + #comments_allowauthor => 0, + # commit comments to the VCS + #comments_commit => 1, - # pinger plugin - # how many seconds to try pinging before timing out - #pinger_timeout => 15, + # getsource plugin + # Mime type for returned source. + #getsource_mimetype => 'text/plain; charset=utf-8', - # prettydate plugin - # format to use to display date - #prettydateformat => '%X, %B %o, %Y', + # mirrorlist plugin + # list of mirrors + #mirrorlist => {}, - # recentchanges plugin - # name of the recentchanges page - recentchangespage => 'recent_changes', - # number of changes to track - recentchangesnum => 100, + # repolist plugin + # URIs of repositories containing the wiki's source + #repositories => [qw{svn://svn.example.org/wiki/trunk}], # search plugin # path to the omega cgi program #omega_cgi => '/usr/lib/cgi-bin/omega/omega', - # svn plugin - # subversion repository location - #svnrepo => '/svn/wiki', - # path inside repository where the wiki is located - #svnpath => 'trunk', - # svn post-commit hook to generate - #svn_wrapper => '/svn/wikirepo/hooks/post-commit', - # mode for svn_wrapper (can safely be made suid) - #svn_wrappermode => '04755', - # viewvc url to show file history ([[file]] substituted) - #historyurl => 'http://svn.example.org/trunk/[[file]]', - # viewvc url to show a diff ([[file]], [[r1]], and [[r2]] substituted) - #diffurl => 'http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]', + # websetup plugin + # list of plugins that cannot be enabled/disabled via the web interface + #websetup_force_plugins => [], + # list of additional setup field keys to treat as unsafe + #websetup_unsafe => [], + # show unsafe settings, read-only, in web interface? + #websetup_show_unsafe => 1, - # tag plugin - # parent page tags are located under - #tagbase => 'tag', + ###################################################################### + # widget plugins + # (calendar, color, conditional, cutpaste, date, format, fortune, + # graphviz, haiku, img, linkmap, listdirectives, map, more, + # orphans, pagecount, pagestats, poll, polygen, postsparkline, + # progress, shortcut, sparkline, table, template, teximg, toc, + # toggle, version) + ###################################################################### + + # calendar plugin + # base of the archives hierarchy + #archivebase => 'archives', + # PageSpec of pages to include in the archives; used by ikiwiki-calendar command + #archive_pagespec => 'posts/* and !*/Discussion', + + # listdirectives plugin + # directory in srcdir that contains directive descriptions + #directive_description_dir => 'ikiwiki/directive', # teximg plugin # Should teximg use dvipng to render, or dvips and convert? @@ -252,19 +305,54 @@ IkiWiki::Setup::Standard->import({ # LaTeX postfix for teximg plugin #teximg_postfix => '\\end{document}', - # tla plugin - # tla post-commit hook to generate - #tla_wrapper => '', - # mode for tla_wrapper (can safely be made suid) - #tla_wrappermode => '06755', - # url to show file history ([[file]] substituted) - #historyurl => '', - # url to show a diff ([[file]] and [[rev]] substituted) - #diffurl => '', + ###################################################################### + # other plugins + # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, + # favicon, goodstuff, htmlbalance, localstyle, pagetemplate, + # pingee, pinger, prettydate, recentchanges, recentchangesdiff, + # relativedate, rsync, sidebar, smiley, sortnaturally, tag, + # testpagespec, underlay) + ###################################################################### - # websetup plugin - # list of plugins that cannot be enabled/disabled via the web interface - #websetup_force_plugins => [], - # show unsafe settings, read-only, in web interface? - #websetup_show_unsafe => 1, + # aggregate plugin + # enable aggregation to internal pages? + #aggregateinternal => 1, + # allow aggregation to be triggered via the web? + #aggregate_webtrigger => 0, + + # camelcase plugin + # list of words to not turn into links + #camelcase_ignore => [], + + # pinger plugin + # how many seconds to try pinging before timing out + #pinger_timeout => 15, + + # prettydate plugin + # format to use to display date + #prettydateformat => '%X, %B %o, %Y', + + # recentchanges plugin + # name of the recentchanges page + recentchangespage => 'recent_changes', + # number of changes to track + recentchangesnum => 100, + + # rsync plugin + # command to run to sync updated pages + #rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/', + + # sidebar plugin + # show sidebar page on all pages? + #global_sidebars => 1, + + # tag plugin + # parent page tags are located under + tagbase => 'tag', + # autocreate new tag pages? + #tag_autocreate => 1, + + # underlay plugin + # extra underlay directories to add + #add_underlays => '', }) |