summaryrefslogtreecommitdiff
path: root/ikiwiki_nb.setup
blob: 3fc16a604dd4158f3e94dadcd59f1c550fc1e549 (plain)
  1. #!/usr/bin/perl
  2. # Setup file for ikiwiki.
  3. #
  4. # Passing this to ikiwiki --setup will make ikiwiki generate
  5. # wrappers and build the wiki.
  6. #
  7. # Remember to re-run ikiwiki --setup any time you edit this file.
  8. our $libdir;
  9. our $webdir;
  10. our $cgidir;
  11. our $gitdir;
  12. our $webhost;
  13. our $githost;
  14. our $gitrepo;
  15. BEGIN {
  16.     $libdir = $ENV{'PWD'} . '/perl';
  17.     $webdir = 'build/html';
  18.     $cgidir = 'build/cgi';
  19.     $gitdir = 'build/git';
  20.     $webhost = 'wiki.example.org';
  21.     $githost = 'git.example.org';
  22.     $gitrepo = 'wiki';
  23. }
  24. use IkiWiki::Setup::Standard {
  25.     # name of the wiki
  26.     wikiname => 'MyWiki',
  27.     # contact email for wiki
  28.     #adminemail => 'me@example.org',
  29.     # users who are wiki admins
  30.     adminuser => [],
  31.     # users who are banned from the wiki
  32.     banned_users => [],
  33.     # where the source of the wiki is located
  34.     srcdir => 'content',
  35.     # where to build the wiki
  36.     destdir => $webdir,
  37.     # base url to the wiki
  38.     url => 'http://' . $webhost . '/',
  39.     # url to the ikiwiki.cgi
  40.     cgiurl => 'http://' . $webhost . '/ikiwiki.cgi',
  41.     # cgi wrapper to generate
  42.     cgi_wrapper => $cgidir . '/ikiwiki.cgi',
  43.     # mode for cgi_wrapper (can safely be made suid)
  44.     cgi_wrappermode => '00755',
  45.     # rcs backend to use
  46.     rcs => 'git',
  47.     # plugins to add to the default configuration
  48.     add_plugins => [qw{
  49.         }],
  50.     # plugins to disable
  51.     disable_plugins => [qw{
  52.         }],
  53.     # location of template files
  54.     templatedir => 'templates',
  55.     # base wiki source location
  56.     underlaydir => 'basewiki',
  57.     # display verbose messages when building?
  58.     #verbose => 1,
  59.     # log to syslog?
  60.     #syslog => 1,
  61.     # create output files named page/index.html?
  62.     usedirs => 1,
  63.     # use '!'-prefixed preprocessor directives?
  64.     prefix_directives => 1,
  65.     # use page/index.mdwn source files
  66.     indexpages => 0,
  67.     # enable Discussion pages?
  68.     discussion => 1,
  69.     # only send cookies over SSL connections?
  70.     sslcookie => 0,
  71.     # extension to use for new pages
  72.     default_pageext => 'mdwn',
  73.     # extension to use for html files
  74.     htmlext => 'html',
  75.     # strftime format string to display date
  76.     timeformat => '%c',
  77.     # UTF-8 locale to use
  78.     locale => 'nb_NO.UTF-8',
  79.     # put user pages below specified page
  80.     userdir => '',
  81.     # how many backlinks to show before hiding excess (0 to show all)
  82.     numbacklinks => 10,
  83.     # attempt to hardlink source files? (optimisation for large files)
  84.     hardlink => 0,
  85.     # force ikiwiki to use a particular umask
  86.     #umask => 022,
  87.     # extra library and plugin directory
  88.     libdir => $libdir,
  89.     # environment variables
  90.     ENV => {},
  91.     # regexp of source files to ignore
  92.     #exclude => '\\.wav$',
  93.     # specifies the characters that are allowed in source filenames
  94.     wiki_file_chars => '-[:alnum:]+/.:_',
  95.     # allow symlinks in the path leading to the srcdir (potentially insecure)
  96.     allow_symlinks_before_srcdir => 0,
  97.     # aggregate plugin
  98.     # enable aggregation to internal pages?
  99.     #aggregateinternal => 0,
  100.     # allow aggregation to be triggered via the web?
  101.     #aggregate_webtrigger => 0,
  102.     # amazon_s3 plugin
  103.     # public access key id
  104.     #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
  105.     # file holding secret key (must not be readable by others!)
  106.     #amazon_s3_key_id => 's3_key',
  107.     # globally unique name of bucket to store wiki in
  108.     #amazon_s3_bucket => 'mywiki',
  109.     # a prefix to prepend to each page name
  110.     #amazon_s3_prefix => 'wiki/',
  111.     # which S3 datacenter to use (leave blank for default)
  112.     #amazon_s3_location => 'EU',
  113.     # store each index file twice? (allows urls ending in "/index.html" and "/")
  114.     #amazon_s3_dupindex => 0,
  115.     # anonok plugin
  116.     # PageSpec to limit which pages anonymous users can edit
  117.     #anonok_pagespec => '*/discussion',
  118.     # attachment plugin
  119.     # enhanced PageSpec specifying what attachments are allowed
  120.     #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
  121.     # virus checker program (reads STDIN, returns nonzero if virus found)
  122.     #virus_checker => 'clamdscan -',
  123.     # bzr plugin
  124.     # bzr post-commit hook to generate
  125.     #bzr_wrapper => '',
  126.     # mode for bzr_wrapper (can safely be made suid)
  127.     #bzr_wrappermode => '06755',
  128.     # url to show file history, using loggerhead ([[file]] substituted)
  129.     #historyurl => '',
  130.     # url to view a diff, using loggerhead ([[file]] and [[r2]] substituted)
  131.     #diffurl => 'http://example.org/revision?start_revid=[[r2]]#[[file]]-s',
  132.     # calendar plugin
  133.     # base of the archives hierarchy
  134.     #archivebase => 'archives',
  135.     # git plugin
  136.     # git hook to generate
  137.     git_wrapper => $gitdir . '/post-update-ikiwiki-nb',
  138.     # mode for git_wrapper (can safely be made suid)
  139.     git_wrappermode => '06755',
  140.     # gitweb url to show file history ([[file]] substituted)
  141.     #historyurl => 'http://' . $githost . '/gitweb.cgi?p=wiki.git;a=history;f=[[file]]', # ;hb=master
  142.     # gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)
  143.     #diffurl => 'http://' . $githost . '/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]',
  144.     # where to pull and push changes (set to empty string to disable)
  145.     #gitorigin_branch => 'samplewiki',
  146.     # branch that the wiki is stored in
  147.     #gitmaster_branch => 'master',
  148.     # htmlscrubber plugin
  149.     # PageSpec specifying pages not to scrub
  150.     #htmlscrubber_skip => '!*/Discussion',
  151.     # inline plugin
  152.     # enable rss feeds by default?
  153.     #rss => 0,
  154.     # enable atom feeds by default?
  155.     #atom => 0,
  156.     # allow rss feeds to be used?
  157.     #allowrss => 0,
  158.     # allow atom feeds to be used?
  159.     #allowatom => 0,
  160.     # urls to ping (using XML-RPC) on feed update
  161.     #pingurl => 'http://rpc.technorati.com/rpc/ping',
  162.     # listdirectives plugin
  163.     # directory in srcdir that contains directive descriptions
  164.     #directive_description_dir => 'ikiwiki/directive',
  165.     # lockedit plugin
  166.     # PageSpec controlling which pages are locked
  167.     #locked_pages => '!*/Discussion',
  168.     # mdwn plugin
  169.     # enable multimarkdown features?
  170.     #multimarkdown => 0,
  171.     # mercurial plugin
  172.     # mercurial post-commit hook to generate
  173.     #mercurial_wrapper => '',
  174.     # mode for mercurial_wrapper (can safely be made suid)
  175.     #mercurial_wrappermode => '06755',
  176.     # url to hg serve'd repository, to show file history ([[file]] substituted)
  177.     #historyurl => 'http://example.org:8000/log/tip/[[file]]',
  178.     # url to hg serve'd repository, to show diff ([[file]] and [[r2]] substituted)
  179.     #diffurl => 'http://localhost:8000/?fd=[[r2]];file=[[file]]',
  180.     # mirrorlist plugin
  181.     # list of mirrors
  182.     #mirrorlist => {},
  183.     # openid plugin
  184.     # an url where users can signup for an OpenID
  185.     #openidsignup => 'http://myopenid.com/',
  186.     # passwordauth plugin
  187.     # a password that must be entered when signing up for an account
  188.     #account_creation_password => 's3cr1t',
  189.     # cost of generating a password using Authen::Passphrase::BlowfishCrypt
  190.     #password_cost => 8,
  191.     # pinger plugin
  192.     # how many seconds to try pinging before timing out
  193.     #pinger_timeout => 15,
  194.     # prettydate plugin
  195.     # format to use to display date
  196.     #prettydateformat => '%X, %B %o, %Y',
  197.     # recentchanges plugin
  198.     # name of the recentchanges page
  199.     #recentchangespage => 'recentchanges',
  200.     # number of changes to track
  201.     #recentchangesnum => 100,
  202.     # search plugin
  203.     # path to the omega cgi program
  204.     #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
  205.     # svn plugin
  206.     # subversion repository location
  207.     #svnrepo => '/svn/wiki',
  208.     # path inside repository where the wiki is located
  209.     #svnpath => 'trunk',
  210.     # svn post-commit hook to generate
  211.     #svn_wrapper => '/svn/wikirepo/hooks/post-commit',
  212.     # mode for svn_wrapper (can safely be made suid)
  213.     #svn_wrappermode => '04755',
  214.     # viewvc url to show file history ([[file]] substituted)
  215.     #historyurl => 'http://svn.example.org/trunk/[[file]]',
  216.     # viewvc url to show a diff ([[file]], [[r1]], and [[r2]] substituted)
  217.     #diffurl => 'http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]',
  218.     # tag plugin
  219.     # parent page tags are located under
  220.     #tagbase => 'tag',
  221.     # teximg plugin
  222.     # Should teximg use dvipng to render, or dvips and convert?
  223.     #teximg_dvipng => '',
  224.     # LaTeX prefix for teximg plugin
  225.     #teximg_prefix => '\\documentclass{article}
  226.     #\\usepackage{amsmath}
  227.     #\\usepackage{amsfonts}
  228.     #\\usepackage{amssymb}
  229.     #\\pagestyle{empty}
  230.     #\\begin{document}
  231.     #',
  232.     # LaTeX postfix for teximg plugin
  233.     #teximg_postfix => '\\end{document}',
  234.     # tla plugin
  235.     # tla post-commit hook to generate
  236.     #tla_wrapper => '',
  237.     # mode for tla_wrapper (can safely be made suid)
  238.     #tla_wrappermode => '06755',
  239.     # url to show file history ([[file]] substituted)
  240.     #historyurl => '',
  241.     # url to show a diff ([[file]] and [[rev]] substituted)
  242.     #diffurl => '',
  243.     # typography plugin
  244.     # Text::Typography attributes value
  245.     #typographyattributes => '3',
  246.     # websetup plugin
  247.     # list of plugins that cannot be enabled/disabled via the web interface
  248.     #websetup_force_plugins => [],
  249.     # show unsafe settings, read-only, in web interface?
  250.     #websetup_show_unsafe => 1,
  251. }