Note about local mod for fix commits with blank comments.
[ikiwiki.git] / docs / howtos / HowToManageThisSite.mdwn
1 This site is managed using ikiwiki.  
2
3 ## File locations
4
5 * `/usr/local/www/ikiwiki-repo.git/` : The bare Git repo for the site. (clone from here)
6 * `/usr/local/www/ikiwiki-srcdir/` : The checked out work for site generation. 
7 * `/usr/local/www/www.dragonflybsd.org/` Static output from ikiwiki.
8 * Source is publically browsable at [gitweb.dragonflybsd.org](http://gitweb.dragonflybsd.org/).
9 * Configuration file is at `/usr/local/etc/ikiwiki.setup`.
10 * Page layouts are at `/usr/local/etc/ikiwiki-templates/` - page.tmpl is probably the one you want.  These are just the overrides from /usr/local/share/ikiwiki/templates.  This affects all pages; the sidebar menu is here.
11 * Stylesheet changes are in `/usr/local/share/ikiwiki/basewiki/local.css`.
12 * After modifying any of the templates or stylesheet info, regenerate the site with `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
13 * Add images by committing them to the repo.
14
15 ## Upgrading
16
17 * Back up `/usr/local/www/ikiwiki-srcdir/`, `/usr/local/www/ikiwiki-repo.git/`, `/usr/local/share/ikiwiki/templates/`, and `/usr/local/etc/ikiwiki.setup`, just to be safe.
18 * Save `favicon.ico`, `local.css`, and `style.css` in `/usr/local/share/ikiwiki/basewiki/` separately.  These will need to be restored after upgrade, as they're modified from what comes with the ikiwiki package.  You may also have to save `local.css` and `style.css` in `/usr/local/www/www.dragonflybsd.org/` as well.
19 * Upgrade using dports.
20 * Run any ikiwiki transition commands mentioned in the release notes at http://ikiwiki.info/news/ .
21 * Check for any new plugins that could be enabled; place them in the ikiwiki.setup file.
22 * textproc/p5-Search-Xapian and textproc/xapian-omega is needed for the search engine, and the path to the omega CGI listed in ikiwiki.setup, though this should never be needed for a separate install unless rebuilding everything.
23
24 Ikiwiki was patched to make sure it would commit changes to git even when no commit message was added.  In /usr/local/lib/perl5/site_perl/5.16/IkiWiki/Plugin/git.pm, change this around line 545:
25
26     # Force git to allow empty commit messages.
27     # (If this version of git supports it.)
28     my ($version)=`git --version` =~ /git version (.*)/;
29     if ($version ge "1.5.4") {
30         push @opts, '--cleanup=verbatim';
31     }
32     else {
33         $params{message}.=".";
34     }
35
36 to
37
38     $params{message}.="No commit message specified.";
39
40
41 ## Feeds
42
43 * The sidebar on the main page displays recent headlines from the DragonFly BSD Digest.  
44 * Pages are saved to /digest/ and displayed using an 'inline' statement.  \[[!inline pages="internal(digest/*)" feeds="no" template="digestitem"]]
45 * The actual feed information is gathered using an aggregate command, kept here so that instructions and actions are in the same place.
46 * Don't remove the aggregate command from this page unless you have someplace else for it.
47 * Here's the command and output: [[!aggregate  name="DragonFly Digest Feed" dir="digest"
48 feedurl="http://www.shiningsilence.com/dbsdlog/feed"
49 url="http://www.shiningsilence.com/dbsdlog/" updateinterval="15"
50 expireage="14" expirecount="20"]]
51
52 ## For more information
53
54 * This site contains ikiwiki documentation under /[[ikiwiki]].
55 * For document editing, visit [[How to edit pages on dragonflybsd.org|docs/howtos/How_To_Edit_This_Site]]