summaryrefslogtreecommitdiff
path: root/ikiwiki_nb.setup
blob: de710dc5ada7e86eed90419cd0b295c035edf5eb (plain)
  1. #!/usr/bin/perl
  2. # Configuration file for ikiwiki.
  3. # Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
  4. # build the wiki.
  5. #
  6. # Remember to re-run ikiwiki --setup any time you edit this file.
  7. use IkiWiki::Setup::Standard {
  8.     wikiname => "MyWiki",
  9.     #adminuser => ["yourname", ],
  10.     adminemail => 'me@example.org',
  11.     # Be sure to customise these..
  12.     srcdir => $ENV{'HOME'} . "/private_webdata/samplewiki/content_dummy",
  13.     destdir => $ENV{'HOME'} . "/public_websites/wiki.example.org",
  14.     url => "http://wiki.example.org",
  15.     cgiurl => "http://wiki.example.org/ikiwiki.cgi",
  16.     templatedir => $ENV{'HOME'} . "/private_webdata/samplewiki/templates_nonedit_l10n/nb",
  17.     underlaydirs => [
  18.         $ENV{'HOME'} . "/private_webdata/samplewiki/content",
  19.         #$ENV{'HOME'} . "/private_webdata/samplewiki/smiley_l10n/nb",
  20.         $ENV{'HOME'} . "/private_webdata/samplewiki/basewiki_nonedit_l10n/nb",
  21.         ],
  22.     # Some plugins (smiley in particular) need non-localized master underlay
  23.     underlaydir => $ENV{'HOME'} . "/private_webdata/samplewiki/basewiki_nonedit",
  24.     # Subversion stuff.
  25.     #rcs => "svn",
  26.     #historyurl => "http://svn.example.org/trunk/[[file]]",
  27.     #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
  28.     #svnrepo => "/svn/wiki",
  29.     #svnpath => "trunk",
  30.     # Git stuff.
  31.     #rcs => "git",
  32.     #historyurl => "http://git.example.org/?p=samplewiki_content.git;a=history;f=[[file]]", # ;hb=master
  33.     #diffurl => "http://git.example.org/?p=samplewiki_content.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  34.     #gitorigin_branch => "samplewiki",
  35.     #gitmaster_branch => "master",
  36.     # Tla stuff.
  37.     #rcs => "tla"
  38.     #historyurl => ??,
  39.     #diffurl => ??,
  40.     # Mercurial stuff.
  41.     #rcs => "mercurial",
  42.     #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
  43.     #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  44.     # Bazaar stuff.
  45.     #rcs => "bzr",
  46.     #historyurl => "", 
  47.     #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  48.     # Monotone stuff
  49.     #rcs => "monotone",
  50.     #mtnkey => "web\@machine.company.com",
  51.     #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
  52.     #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  53.     # Set if you want the wiki to sync on update and commit.
  54.     #mtnsync => 0,
  55.     # The path to your workspace (defaults to the srcdir itself)
  56.     # e.g. use if your srcdir is a subdirectory of the workspace.
  57.     #mtnrootdir => "path/to/root/of/workspace",
  58.     wrappers => [
  59.         #{
  60.         #   # The cgi wrapper.
  61.         #   cgi => 1,
  62.         #   wrapper => $ENV{'HOME'} . "/public_cgi/wiki.example.org/ikiwiki.cgi",
  63.         #   wrappermode => "06755",
  64.         #},
  65.         #{
  66.         #   # The svn post-commit wrapper.
  67.         #   # Note that this will overwrite any existing
  68.         #   # post-commit hook script, which may not be
  69.         #   # what you want.
  70.         #   wrapper => "/svn/wikirepo/hooks/post-commit",
  71.         #   wrappermode => "04755",
  72.         #   # Log to syslog since svn post-commit hooks
  73.         #   # hide output and errors.
  74.         #   syslog => 1,
  75.         #},
  76.         #{
  77.         #   # The git post-update wrapper.
  78.         #   # Note that this will overwrite any existing
  79.         #   # post-update hook script, which may not be
  80.         #   # what you want.
  81.         #   wrapper => $ENV{'HOME'} . "/public_websites/git.example.org/samplewiki_content.git/hooks/post-update-ikiwiki",
  82.         #   wrappermode => "06755",
  83.         #},
  84.         #{
  85.         #   # The monotone netsync hook.
  86.         #   wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  87.         #   wrappermode => "06755",
  88.         #},
  89.     ],
  90.     # Default to generating rss feeds for pages with feeds?
  91.     #rss => 1,
  92.     # Default to generating atom feeds for pages with feeds?
  93.     #atom => 1,
  94.     # Allow generating feeds even if not generated by default?
  95.     #allowrss => 1,
  96.     #allowatom => 1,
  97.     # Urls to ping with XML-RPC when feeds are updated
  98.     #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  99.     # Include discussion links on all pages?
  100.     discussion => 1,
  101.     # To exclude files matching a regexp from processing. This adds to
  102.     # the default exclude list.
  103.     #exclude => qr/\.wav$/,
  104.     # To change the extension used for generated html files.
  105.     #htmlext => 'htm',
  106.     # Time format (for strftime)
  107.     #timeformat => '%c',
  108.     # Locale to use. Must be a UTF-8 locale.
  109.     locale => 'nb_NO.UTF-8',
  110.     # Only send cookies over SSL connections.
  111.     #sslcookie => 1,
  112.     # Logging settings:
  113.     #verbose => 1,
  114.     syslog => 0,
  115.     # To link to user pages in a subdirectory of the wiki.
  116.     #userdir => "users",
  117.     # To create output files named page.html rather than page/index.html.
  118.     #usedirs => 0,
  119.     # Simple spam prevention: require an account-creation password.
  120.     #account_creation_password => "example",
  121.     # Cost of generating a password using Authen::Passphrase::BlowfishCrypt
  122.     #password_cost => 8,
  123.     # Uncomment to force ikiwiki to run with a particular umask.
  124.     #umask => 022,
  125.     # Default settings for the recentchanges page.
  126.     #recentchangespage => "recentchanges",
  127.     #recentchangesnum => 100,
  128.     # Use new '!'-prefixed preprocessor directive syntax
  129.     #prefix_directives => 1,
  130.     # Attempt to make hardlinks to source files instead of copying them.
  131.     # Useful if the wiki contains large media files.
  132.     #hardlink => 1,
  133.     # Enable use of multimarkdown features in .mdwn files.
  134.     #multimarkdown => 1,
  135.     # To add plugins, list them here.
  136.     #add_plugins => [qw{goodstuff search wikitext camelcase
  137.     #                   htmltidy fortune sidebar map rst anonok}],
  138.     # If you want to disable any of the default plugins, list them here.
  139.     #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
  140.     # To add a directory to the perl search path, use this.
  141.     #libdir => "/home/me/private_webdata/samplewiki/perl",
  142.     
  143.     # To override environment variable settings, you can list values here.
  144.     #ENV => {
  145.     #   TZ => "America/New_York",
  146.     #   PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
  147.     #},
  148.     # For use with the tag plugin, make all tags be located under a
  149.     # base page.
  150.     #tagbase => "tag",
  151.     # For use with the search plugin if the omega cgi is located
  152.     # somewhere else.
  153.     #omega_cgi => "/usr/lib/cgi-bin/omega/omega",
  154.     # For use with the openid plugin, to give an url to a page users
  155.     # can use to signup for an OpenID.
  156.     #openidsignup => "http://myopenid.com/",
  157.     # For use with the mirrorlist plugin, a list of mirrors.
  158.     #mirrorlist => {
  159.     #   mirror1 => "http://hostname1",
  160.     #   mirror2 => "http://hostname2/mirror",
  161.     #},
  162.     
  163.     # For use with the anonok plugin, a PageSpec specifying what
  164.     # pages anonymous users can edit
  165.     #anonok_pagespec => "*",
  166.     
  167.     # For use with the aggregate plugin.
  168.     # Enable aggregation to internal pages. New wikis should set this to 1,
  169.     # but if you use aggregate already, read the aggregate plugin docs
  170.     # before enabling it.
  171.     #aggregateinternal => 1,
  172.     # Allow aggregation to be triggered via the web.
  173.     #aggregate_webtrigger => 1,
  174.     
  175.     # For use with the pinger plugin, how many seconds to wait before
  176.     # timing out.
  177.     #pinger_timeout => 15.
  178.     
  179.     # For use with the amazon S3 plugin, your public access key id.
  180.     #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  181.     # And a file holding your secret key. This file *must* not be
  182.     # readable by others!
  183.     #amazon_s3_key_file => "/home/me/secret_webdata/s3_key
  184.     # The globally unique name of the bucket to use to store the wiki.
  185.     #amazon_s3_bucket => "mywiki",
  186.     # A prefix to prepend to each page name.
  187.     #amazon_s3_prefix => "wiki/",
  188.     # Uncomment to use the S3 European datacenter.
  189.     #amazon_s3_location => "EU",
  190.     # Uncomment if you need to store each index file twice.
  191.     #amazon_s3_dupindex => 1,
  192.     
  193.     # For use with the attachment plugin, a program that returns
  194.     # nonzero if its standard input contains an virus.
  195.     #virus_checker => "clamdscan -",
  196. }