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