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