From 15413226a8192303d91fd66b984f62a0bc5566ab Mon Sep 17 00:00:00 2001 From: Marian Csontos Date: Thu, 21 Dec 2023 13:48:50 +0100 Subject: [PATCH] pages: Use gitlab pages and ikiwiki for doc --- .gitlab-ci.yml | 17 ++ doc/Problems.mdwn | 24 ++ doc/README.mdwn | 34 +++ doc/index.mdwn | 152 ++++++++++++ doc/local.css | 4 + doc/release-notes/2.02.178 | 2 + doc/release-notes/2.03.24.mdwn | 80 ++++++ doc/release-notes/index.mdwn | 9 + doc/release-notes/legacy.mdwn | 8 + doc/release-notes/pending.mdwn | 3 + doc/release-notes/template.mdwn | 52 ++++ ikiwiki.setup | 420 ++++++++++++++++++++++++++++++++ 12 files changed, 805 insertions(+) create mode 100644 doc/Problems.mdwn create mode 100644 doc/README.mdwn create mode 100644 doc/index.mdwn create mode 100644 doc/local.css create mode 100644 doc/release-notes/2.03.24.mdwn create mode 100644 doc/release-notes/index.mdwn create mode 100644 doc/release-notes/legacy.mdwn create mode 100644 doc/release-notes/pending.mdwn create mode 100644 doc/release-notes/template.mdwn create mode 100644 ikiwiki.setup diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 35a7e4061..423807f40 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -16,6 +16,23 @@ approve1: - when: on_success allow_failure: false + +pages: + image: elecnix/ikiwiki + stage: test + script: + - ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib + artifacts: + paths: + - public + only: + refs: + - main + changes: + - doc/**/* + - ikiwiki.setup + + # TODO: # - check results of autoreconf and make generate - may need additional commit # - we need a particular setup (rawhide OR latest supported fedora?) diff --git a/doc/Problems.mdwn b/doc/Problems.mdwn new file mode 100644 index 000000000..e913b1363 --- /dev/null +++ b/doc/Problems.mdwn @@ -0,0 +1,24 @@ +# Common problems + +## Duplicate PVs in the system + +LVM tries to detect the common sources of duplicates, mdadm RAID and multipath, +there are cases where duplicate PV appears on the system. + +There are two solutions to this problem: + +* Setting a *global_filter* configuration option. +* Using of *devices_file* (See [lvmdevices(8)](https://man7.org/linux/man-pages/man8/lvmdevices.8.html)) + +## Device Filtering + +*filter* and *global_filter* are meant to be used in two ways: + +* as an allow list, listing patterns for devices which will be accepted +* `a|/dev/sdX|`, and rejecting the rest `r|.*|`, +* as a reject list, listing only patterns for devices which will be rejected +* `r|/dev/sdX|`, + +Even though there are situations where it works, mixing reject and accept +patterns is not recommended. + diff --git a/doc/README.mdwn b/doc/README.mdwn new file mode 100644 index 000000000..9faf29910 --- /dev/null +++ b/doc/README.mdwn @@ -0,0 +1,34 @@ +LVM2 Wiki Documentation +======================= + +If you are looking for information about LVM2 visit the [[Index]] page, + +There are only some notes about writing stuff under *./doc* here: + +* If possible use [[MarkDown]] for formatting, use *.md* (or *.mdwn*) suffix. +* For linking between files, use [[IkiWiki]] syntax `[[FileName]]` or + `[[FileName#Anchor]]`, or `[[link text|FileName]]` + +Markdown +-------- + +* Use `` to keep notes, which will not be rendered. +* Use `[[TODO]]` for anything what needs attention. This will be accessible + through the linked [[TODO]] page. + +IkiWiki +------- + +* Install ikiwiki: + + yum install ikiwiki + +* To generate the content, run following in the LVM2 top directory: + + ikiwiki --setup ikiwiki.setup + +Internal Stuff: +--------------- + +* [[TODO]] Can we have a section which is hidden by default? Like this one? +* [[TODO]] Add basic IkiWiki and MarkDown How To. diff --git a/doc/index.mdwn b/doc/index.mdwn new file mode 100644 index 000000000..26088ffdb --- /dev/null +++ b/doc/index.mdwn @@ -0,0 +1,152 @@ +# LVM - Logical Volume Manager for Linux + + + + + + +LVM aka LVM2 refers to the userspace toolset that provide logical volume +management facilities on linux. + + +LVM offers more flexibility than using partitions, allowing one to + +* grow and, where supported by filesystem, shrink volumes, +* create snapshots of existing volumes, +* mirror data on multiple disks including RAID levels 5 or 6, +* striping data on multiple disks, +* create a read or write cache. + +To use LVM2 you need 3 things: + +* [device-mapper](https://sourceware.org/dm/) in your kernel (upstream since long ago) +* the userspace device-mapper support library (*libdevmapper*) (part of lvm2) +* and the userspace LVM2 tools. + +## Getting LVM + +Most of linux ditribution offer packaged LVM tools. +Depending on your distribution use + + # RPM based distributions (Fedora): + yum install lvm2 + # DEB based distributions (Debian, Ubuntu): + apt-get install lvm2 + +Tarballs of the userspace LVM2 source code releases are available from [sourceware.org](https://sourceware.org/pub/lvm2/) [ftp](ftp://sourceware.org/pub/lvm2/). + +List of official [mirror sites](https://sourceware.org/mirrors.html) (including http and rsync protocols). + +### LVM Releases + +[[!inline pages="release-notes/2.03.* and !*/template and !*/Discussion and !tagged(draft) and !tagged(pending)" limit=2 rootpage="release-notes"]] + +[[More releases|release-notes/index]] + +## Getting Started + + +Word of warning first! Even though LVM errs on the side of data safety it is a +tool with low level access and one may seriously harm their data when used +incorrectly! + + +* Physical Volume (PV) is underlaying disk, local or remote, encrypted or even + a mdadm RAID volume. PV is divided into so called Physical Extents (PE) which + are a basic allocation unit. + List PVs using [pvs(8)](https://man7.org/linux/man-pages/man8/pvs.8.html) or + [pvdisplay(8)](https://man7.org/linux/man-pages/man8/pvdisplay.8.html). + + Make one by running `pvcreate /dev/sdX`. + See [pvcreate(8)](https://man7.org/linux/man-pages/man8/pvcreate.8.html). This step is optional. +* Volume Group (VG) consisting for one or more PVs is used as a pool from which LVs are allocated. + List VGs using [vgs(8)](https://man7.org/linux/man-pages/man8/vgs.8.html) or + [vgdisplay(8)](https://man7.org/linux/man-pages/man8/vgdisplay.8.html). + + Make one by running `vgcreate VGNAME /dev/sdX...`, add PVs to existing one by `vgextend VGNAME /dev/sdX`. + To use LVM at least one Volume Group must be present on the system. + See [vgcreate(8)](https://man7.org/linux/man-pages/man8/vgcreate.8.html), and + [vgextend(8)](https://man7.org/linux/man-pages/man8/vgextend.8.html). +* Logical Volume (LV) is the block device usually visible to user to be used for file system. + List PVs using [lvs(8)](https://man7.org/linux/man-pages/man8/lvs.8.html) or + [lvdisplay(8)](https://man7.org/linux/man-pages/man8/lvdisplay.8.html). + + Make one by running `lvcreate [-n LVNAME] -L SIZE VGNAME`, and you are done! + See [vgcreate(8)](https://man7.org/linux/man-pages/man8/vgcreate.8.html). + +## Avoiding Problems + +Good start is to avoid using `{--force|-f}` and `{--yes|-y}` options which are +often seen on internet discussions. +there is a possibility of data loss, LVM tools usually ask, so read the prompts +carefully! Using `--yes` removes these safety. +Also in some cases where it is too dangerous to proceed, e.g. device is used, +LVM refuses to do so, which can be overridden by `--force`. + +Second, when resizing and especially when shrinking LVs it is always a good +idea to use `--resizefs` option which ensures the devices are resized in +correct order. + +Third, if you still make a mess, never ever run fsck on damaged LV/FS, this is +usually the final blow to your data. It is always better to ask first! + + +## Documentation + +## Resolving Problems + +* Backup if possible! +* Search the problem first, check the list of [[common problems|Problems]] +* Never run `fsck` on damaged LV, LV must be recovered first! +* When asking for help describe exactly how the system got corrupted. It really + does not help trying to cover one's mistakes in such situation, it takes + longer to get help and also you are likely to get wrong answer making repair + impossible. + +## Reporting Bugs + +* When you find a problem there is often something specific about your system. + If the problem is reproducible run the failing command(s) with verbose flag + `-vvvv` which gives developers clue where the problem might be. + There is a [lvmdump(8)](https://man7.org/linux/man-pages/man8/lvmdump.8.html) + tool to help collect data about your system, block devices and LVM setup. +* Please report upstream bugs or request features in [Red Hat Bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=LVM%20and%20device-mapper) + + diff --git a/doc/local.css b/doc/local.css new file mode 100644 index 000000000..04612c75d --- /dev/null +++ b/doc/local.css @@ -0,0 +1,4 @@ +.page { + max-width: 1280px; + margin: auto; +} diff --git a/doc/release-notes/2.02.178 b/doc/release-notes/2.02.178 index 5b4319e13..0c94cd2e1 100644 --- a/doc/release-notes/2.02.178 +++ b/doc/release-notes/2.02.178 @@ -51,3 +51,5 @@ In future optional target flags will be given in two situations: This decision could well be contentious, so could distro maintainers feel free to comment. + +[[!tag legacy]] diff --git a/doc/release-notes/2.03.24.mdwn b/doc/release-notes/2.03.24.mdwn new file mode 100644 index 000000000..71aa8add7 --- /dev/null +++ b/doc/release-notes/2.03.24.mdwn @@ -0,0 +1,80 @@ + +[[!meta title="Version 2.03.24 - Feature and Bug Fix Release"]] + +Version 2.03.24 +=============== + +* **Changes in udev rules, new version of systemd is recommended (256).** +* **When using LVs as PVs these are no longer auto activated!** +* Allow creating VDO device for thin data when creating thin pool. +* More devices can be used as external origin for thin snapshot. +* And [[!toggle text="more"]] + +[[!toggleable text=""" +Features +----------------------- + +* Swap properties like hostname, date and time when swapping LVs. +* Allow thin snapshot taken of thin volume from another pool as external origin. +* Allow chaining of external origins. + +### Changes to device handling + +* **IMPORTANT:** When `devices/scan_lvs` is enabled found LVs are no longer auto + activated, must enable `LVM_PVSCAN_ON_LVS` in udev rules (*69-dm-lvm.rules*.) + * NOTE: It is not recomended to use LVs for PVs. If you have an use case for + this talk to us, please. +* Changes to devices file are now backed up in */etc/lvm/devices/backup/*. + Controlled by `devices/devicesfile_backup_limit` configuration option. +* When `devices/use_devicesfile` is set to `0` existing file is renamed to + *system.devices-unused.YYYYMMDD.HHMMSS* to prevent outdated file to be used + on reenabling. + +### Use VDO device for thin pool's data + +New option `--pooldatavdo` during lvcreate or lvconvert allows using VDO as backing device. + +More options (`--compression {y|n}`, `--deduplication {y|n}`, + `--vdosettings STRING`) to control the options are supported by these commands. + +Example of converting a *lvol1* to a thin pool with enabled compression and deduplication: + + lvconvert --type thin-pool --pooldatavdo y vg/lvol1 + +Changes in command line +----------------------- + +* Add *--wipesignature* option controlling signature wiping when converting volume to thin-pool. +* Allow *lvcreate --snapshot* without *{-T|--thin}* option when creating snapshot of a thin volume. +* Allow *--raidintegrity{,mode,blocksize}* options with implicit RAID1 (i.e. when *-m1* is used on command line) + +./configure options +------------------- + +These changes are for packagers: + +* Add `--with-default-event-activation` option controlling default for + `global/event_activation`. Default value is unchanged. Useful when creating + builds for testing. +* Add `--with-modulesdir` option. + +Changes in udev rules +--------------------- + +**IMPORTANT:** Rework of udev rules in cooperation with systemd is included in this release. + +* `DM_SUSPENDED` and `DM_NOSCAN` are now entirely internal for DM and cannot be used outside of DM rules. +* Upper level rules should consume `DM_UDEV_DISABLE_OTHER_RULES_FLAG` rather than `DM_NOSCAN` and `DM_SUSPENDED`. + +Also few more minor improvements: + +* Better handling of `DISK_RO` events and suspended devices + +"""]] + + +[[!tag draft pending]] + diff --git a/doc/release-notes/index.mdwn b/doc/release-notes/index.mdwn new file mode 100644 index 000000000..9aba51e95 --- /dev/null +++ b/doc/release-notes/index.mdwn @@ -0,0 +1,9 @@ +# LVM Releases + +This list is incomplete, only releases with a release-note are included. + +For releases of legacy branch *2.02* see [[legacy]]. + +Too see what's cooking see [[pending]]. + +[[!inline pages="release-notes/2.03.* and !*/template and !*/Discussion and !tagged(draft) and !tagged(pending)" rootpage="release-notes"]] diff --git a/doc/release-notes/legacy.mdwn b/doc/release-notes/legacy.mdwn new file mode 100644 index 000000000..faebdf6a3 --- /dev/null +++ b/doc/release-notes/legacy.mdwn @@ -0,0 +1,8 @@ +# Legacy 2.02 Releases + +This list is incomplete, only releases with a release-note are included. + +For releases of stable branch 2.03 see [[index]]. + +[[!inline pages="release-notes/2.02.* and !*/template and !*/Discussion and !tagged(draft) and !tagged(pending)" limit=2 rootpage="release-notes"]] + diff --git a/doc/release-notes/pending.mdwn b/doc/release-notes/pending.mdwn new file mode 100644 index 000000000..96ebf2c39 --- /dev/null +++ b/doc/release-notes/pending.mdwn @@ -0,0 +1,3 @@ +# Pending Release + +[[!inline pages="release-notes/* and !*/template and !*/Discussion and tagged(pending)" rootpage="release-notes"]] diff --git a/doc/release-notes/template.mdwn b/doc/release-notes/template.mdwn new file mode 100644 index 000000000..397935b8d --- /dev/null +++ b/doc/release-notes/template.mdwn @@ -0,0 +1,52 @@ + +[[!meta title="Version 2.03. - Feature and Bug Fix Release"]] + +Version 2.03. +=============== + +* List of important/interesting changes +* And [[!toggle text="more"]] + +[[!toggleable text=""" +Features +----------------------- + +* List new features worth mentioning here in one line. + +### New Feature Worth a Paragraph or Two + +Write a paragraph or two covering feature where some examples of usage are expected. + + + +Changes in command line +----------------------- + +Describe important changes in command line tools, especially any chnages of behavior, which user must be aware of: + +* New options +* Removed options +* Use a separate page in *./doc* for larger features worth separate article, or a man page + +Changes in lvm.conf +------------------- + +* New options. +* Change of defaults. + +./configure options +------------------- + +* New options and features the enable. + +"""]] + + +[[!tag draft pending]] + diff --git a/ikiwiki.setup b/ikiwiki.setup new file mode 100644 index 000000000..ea7f6ff9b --- /dev/null +++ b/ikiwiki.setup @@ -0,0 +1,420 @@ +# IkiWiki::Setup::Yaml - YAML formatted setup file +# +# Setup file for ikiwiki. +# +# Passing this to ikiwiki --setup will make ikiwiki generate +# wrappers and build the wiki. +# +# Remember to re-run ikiwiki --setup any time you edit this file. +# +# name of the wiki +wikiname: LVM +# contact email for wiki +#adminemail: me@example.com +# users who are wiki admins +adminuser: [] +# users who are banned from the wiki +banned_users: [] +# where the source of the wiki is located +srcdir: ./doc +# where to build the wiki +destdir: ./public +# base url to the wiki +url: https://sourceware.org/lvm2/ +# url to the ikiwiki.cgi +cgiurl: '' +# do not adjust cgiurl if CGI is accessed via different URL +reverse_proxy: 0 +# filename of cgi wrapper to generate +cgi_wrapper: '' +# mode for cgi_wrapper (can safely be made suid) +cgi_wrappermode: 06755 +# number of seconds to delay CGI requests when overloaded +cgi_overload_delay: '' +# message to display when overloaded (may contain html) +cgi_overload_message: '' +# enable optimization of only refreshing committed changes? +only_committed_changes: 0 +# rcs backend to use +rcs: '' +# plugins to add to the default configuration +add_plugins: + - sidebar + - tag + - toggle +# plugins to disable +disable_plugins: [] +# additional directory to search for template files +templatedir: /usr/share/ikiwiki/templates +# base wiki source location +underlaydir: /usr/share/ikiwiki/basewiki +# display verbose messages? +#verbose: 1 +# log to syslog? +#syslog: 1 +# create output files named page/index.html? +usedirs: 1 +# use '!'-prefixed preprocessor directives? +prefix_directives: 1 +# use page/index.mdwn source files +indexpages: 0 +# enable Discussion pages? +discussion: 1 +# name of Discussion pages +discussionpage: Discussion +# use elements new in HTML5 like
? +html5: 0 +# only send cookies over SSL connections? +sslcookie: 0 +# extension to use for new pages +default_pageext: mdwn +# extension to use for html files +htmlext: html +# strftime format string to display date +timeformat: '%c' +# UTF-8 locale to use +#locale: en_US.UTF-8 +# put user pages below specified page +userdir: '' +# how many backlinks to show before hiding excess (0 to show all) +numbacklinks: 10 +# attempt to hardlink source files? (optimisation for large files) +hardlink: 0 +# force ikiwiki to use a particular umask (keywords public, group or private, or a number) +#umask: public +# group for wrappers to run in +#wrappergroup: ikiwiki +# extra library and plugin directories +libdirs: [] +# extra library and plugin directory (searched after libdirs) +libdir: '' +# environment variables +ENV: {} +# time zone name +timezone: :/etc/localtime +# regexp of normally excluded files to include +#include: ^\.htaccess$ +# regexp of files that should be skipped +#exclude: ^(*\.private|Makefile)$ +# specifies the characters that are allowed in source filenames +wiki_file_chars: -[:alnum:]+/.:_ +# allow symlinks in the path leading to the srcdir (potentially insecure) +allow_symlinks_before_srcdir: 0 +# cookie control +cookiejar: + file: /home/mcsontos/.ikiwiki/cookies +# set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds +useragent: ikiwiki/3.20200202.3 +# theme has a responsive layout? (mobile-optimized) +responsive_layout: 1 +# try harder to produce deterministic output +deterministic: 0 + +###################################################################### +# core plugins +# (editpage, htmlscrubber, inline, link, meta, parentlinks, templatebody) +###################################################################### + +# htmlscrubber plugin +# PageSpec specifying pages not to scrub +#htmlscrubber_skip: '!*/Discussion' + +# inline plugin +# enable rss feeds by default? +#rss: 0 +# enable atom feeds by default? +#atom: 0 +# allow rss feeds to be used? +#allowrss: 0 +# allow atom feeds to be used? +#allowatom: 0 +# urls to ping (using XML-RPC) on feed update +pingurl: [] + +###################################################################### +# auth plugins +# (anonok, blogspam, emailauth, httpauth, lockedit, moderatedcomments, +# opendiscussion, openid, passwordauth, signinedit) +###################################################################### + +# anonok plugin +# PageSpec to limit which pages anonymous users can edit +#anonok_pagespec: '*/discussion' + +# blogspam plugin +# PageSpec of pages to check for spam +#blogspam_pagespec: postcomment(*) +# options to send to blogspam server +#blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10 +# blogspam server JSON url +#blogspam_server: '' + +# emailauth plugin +# email address to send emailauth mails as (default: adminemail) +#emailauth_sender: '' + +# httpauth plugin +# url to redirect to when authentication is needed +#cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi +# PageSpec of pages where only httpauth will be used for authentication +#httpauth_pagespec: '!*/Discussion' + +# lockedit plugin +# PageSpec controlling which pages are locked +#locked_pages: '!*/Discussion' + +# moderatedcomments plugin +# PageSpec matching users or comment locations to moderate +#moderate_pagespec: '*' + +# openid plugin +# url pattern of openid realm (default is cgiurl) +#openid_realm: '' +# url to ikiwiki cgi to use for openid authentication (default is cgiurl) +#openid_cgiurl: '' + +# passwordauth plugin +# a password that must be entered when signing up for an account +#account_creation_password: s3cr1t +# cost of generating a password using Authen::Passphrase::BlowfishCrypt +#password_cost: 8 + +###################################################################### +# format plugins +# (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, textile, txt) +###################################################################### + +# highlight plugin +# types of source files to syntax highlight +#tohighlight: .c .h .cpp .pl .py Makefile:make +# location of highlight's filetypes.conf +#filetypes_conf: /etc/highlight/filetypes.conf +# location of highlight's langDefs directory +#langdefdir: /usr/share/highlight/langDefs + +# mdwn plugin +# enable multimarkdown features? +#multimarkdown: 0 +# disable use of markdown discount? +#nodiscount: 0 +# enable footnotes in Markdown (where supported)? +mdwn_footnotes: 1 +# interpret line like 'A. First item' as ordered list when using Discount? +mdwn_alpha_lists: 0 + +# po plugin +# master language (non-PO files) +#po_master_language: en|English +# slave languages (translated via PO files) format: ll|Langname +#po_slave_languages: +#- fr|Français +#- es|Español +#- de|Deutsch +# PageSpec controlling which pages are translatable +#po_translatable_pages: '* and !*/Discussion' +# internal linking behavior (default/current/negotiated) +#po_link_to: current + +###################################################################### +# special-purpose plugins +# (osm, underlay) +###################################################################### + +# osm plugin +# the default zoom when you click on the map link +#osm_default_zoom: 15 +# the icon shown on links and on the main map +#osm_default_icon: ikiwiki/images/osm.png +# the alt tag of links, defaults to empty +#osm_alt: '' +# the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated) +#osm_format: KML +# the icon attached to a tag, displayed on the map for tagged pages +#osm_tag_default_icon: icon.png +# Url for the OpenLayers.js file +#osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js +# Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter. +#osm_layers: +# OSM: GoogleSatellite +# Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key +#osm_google_apikey: '' + +# underlay plugin +# extra underlay directories to add +#add_underlays: +#- /home/mcsontos/wiki.underlay + +###################################################################### +# web plugins +# (404, attachment, comments, editdiff, edittemplate, getsource, google, +# goto, mirrorlist, remove, rename, repolist, search, theme, userlist, +# websetup, wmd) +###################################################################### + +# attachment plugin +# enhanced PageSpec specifying what attachments are allowed +#allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb) +# virus checker program (reads STDIN, returns nonzero if virus found) +#virus_checker: clamdscan - + +# comments plugin +# PageSpec of pages where comments are allowed +#comments_pagespec: blog/* and !*/Discussion +# PageSpec of pages where posting new comments is not allowed +#comments_closed_pagespec: blog/controversial or blog/flamewar +# Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12" +#comments_pagename: '' +# Interpret directives in comments? +#comments_allowdirectives: 0 +# Allow anonymous commenters to set an author name? +#comments_allowauthor: 0 +# commit comments to the VCS +#comments_commit: 1 +# Restrict formats for comments to (no restriction if empty) +#comments_allowformats: mdwn txt + +# getsource plugin +# Mime type for returned source. +#getsource_mimetype: text/plain; charset=utf-8 + +# mirrorlist plugin +# list of mirrors +#mirrorlist: {} +# generate links that point to the mirrors' ikiwiki CGI +#mirrorlist_use_cgi: 1 + +# repolist plugin +# URIs of repositories containing the wiki's source +#repositories: +#- svn://svn.example.org/wiki/trunk + +# search plugin +# path to the omega cgi program +#omega_cgi: /usr/lib/cgi-bin/omega/omega +# use google site search rather than internal xapian index? +#google_search: 1 + +# theme plugin +# name of theme to enable +#theme: actiontabs + +# websetup plugin +# list of plugins that cannot be enabled/disabled via the web interface +#websetup_force_plugins: [] +# list of additional setup field keys to treat as unsafe +#websetup_unsafe: [] +# show unsafe settings, read-only, in web interface? +#websetup_show_unsafe: 1 + +###################################################################### +# widget plugins +# (calendar, color, conditional, cutpaste, date, format, fortune, +# graphviz, haiku, headinganchors, img, linkmap, listdirectives, map, +# more, orphans, pagecount, pagestats, poll, polygen, postsparkline, +# progress, shortcut, sparkline, table, template, teximg, toc, toggle, +# version) +###################################################################### + +# calendar plugin +# base of the archives hierarchy +#archivebase: archives +# PageSpec of pages to include in the archives, if option `calendar_autocreate` is true. +#archive_pagespec: page(posts/*) and !*/Discussion +# autocreate new calendar pages? +#calendar_autocreate: 1 +# if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars). +#calendar_fill_gaps: 1 + +# img plugin +# Image formats to process (jpeg, png, gif, svg, pdf or 'everything' to accept all) +#img_allowed_formats: '' + +# listdirectives plugin +# directory in srcdir that contains directive descriptions +#directive_description_dir: ikiwiki/directive + +# teximg plugin +# Should teximg use dvipng to render, or dvips and convert? +#teximg_dvipng: '' +# LaTeX prefix for teximg plugin +#teximg_prefix: | +# \documentclass{article} +# \usepackage[utf8]{inputenc} +# \usepackage{amsmath} +# \usepackage{amsfonts} +# \usepackage{amssymb} +# \pagestyle{empty} +# \begin{document} +# LaTeX postfix for teximg plugin +#teximg_postfix: \end{document} + +###################################################################### +# other plugins +# (aggregate, amazon_s3, autoindex, brokenlinks, camelcase, ddate, embed, +# favicon, filecheck, flattr, goodstuff, htmlbalance, localstyle, +# loginselector, notifyemail, pagetemplate, pingee, pinger, prettydate, +# recentchanges, recentchangesdiff, relativedate, rsync, sidebar, +# smiley, sortnaturally, tag, testpagespec, trail, transient) +###################################################################### + +# aggregate plugin +# enable aggregation to internal pages? +#aggregateinternal: 1 +# allow aggregation to be triggered via the web? +#aggregate_webtrigger: 0 + +# amazon_s3 plugin +# public access key id +#amazon_s3_key_id: XXXXXXXXXXXXXXXXXXXX +# file holding secret key (must not be readable by others!) +#amazon_s3_key_id: /home/mcsontos/.s3_key +# globally unique name of bucket to store wiki in +#amazon_s3_bucket: mywiki +# a prefix to prepend to each page name +#amazon_s3_prefix: wiki/ +# which S3 datacenter to use (leave blank for default) +#amazon_s3_location: EU +# store each index file twice? (allows urls ending in "/index.html" and "/") +#amazon_s3_dupindex: 0 + +# autoindex plugin +# commit autocreated index pages +#autoindex_commit: 1 + +# camelcase plugin +# list of words to not turn into links +#camelcase_ignore: [] + +# flattr plugin +# userid or user name to use by default for Flattr buttons +#flattr_userid: joeyh + +# pinger plugin +# how many seconds to try pinging before timing out +#pinger_timeout: 15 + +# prettydate plugin +# format to use to display date +#prettydateformat: '%X, %B %o, %Y' + +# recentchanges plugin +# name of the recentchanges page +recentchangespage: recentchanges +# number of changes to track +recentchangesnum: 100 + +# rsync plugin +# command to run to sync updated pages +#rsync_command: rsync -qa --delete . user@host:/path/to/docroot/ + +# sidebar plugin +# show sidebar page on all pages? +#global_sidebars: 1 + +# tag plugin +# parent page tags are located under +#tagbase: tag +# autocreate new tag pages? +#tag_autocreate: 1 +# commit autocreated tag pages +#tag_autocreate_commit: 1