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