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