Configuration
From GregariusWiki
The following are the configuration variables present in Gregarius 0.5.5, their defaults, and brief descriptions of what they each do.
[edit] rss.config.absoluteordering
- Default Value</dt>
true</dd>- Description</dt>
- Allow ordering of channels and folders in the admin section. If false, channels and folders will be organized by their titles.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.autologout
- Default Value</dt>
false</dd>- Description</dt>
- When true, Gregarius will automatically remove the "admin cookie" when the browser window is closed, effectively logging you out.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.datedesc.read
- Default Value</dt>
true</dd>- Description</dt>
- When true, Gregarius displays newer read items first. If false, Gregarius will display older read items first.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.datedesc.unread
- Default Value</dt>
true</dd>- Description</dt>
- When true, Gregarius displays newer unread items first. If false, Gregarius will display older unread items first.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.dateformat
- Default Value</dt>
F jS, Y, g:ia T</dd>- Description</dt>
- Format to use when displaying dates. </dd>
- Notes</dt>
- See here for help on the format. Direct access to a given feed's month and day archives more or less depends on the fact that this date format contains the "F" (Month) and "jS" (day) elements in this form. So feel free to change the order of the elements, but better leave those two tokens in :) </dd>
[edit] rss.config.deadthreshhold
- Default Value</dt>
24</dd>- Description</dt>
- Sets the threshold for when a feed is marked as dead, in hours.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.feedgrouping
- Default Value</dt>
true</dd>- Description</dt>
- When true, Gregarius groups unread items per feed and sorts the feeds according to the rss.config.absoluteordering configuration switch. When false, unread items are not grouped by feed, but are sorted by date instead.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.markreadonupdate
- Default Value</dt>
false</dd>- Description</dt>
- Mark all old unread feeds as read when updating if new unread feeds are found.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.plugins
- Default Value</dt>
Default Url filter v1.4, Rounded Corners v0.1.</dd>- Description</dt>
- Plugins are third-party scripts that offer extended functionalities. More plugins can be found at the Plugin Repository.</dd>
- Notes</dt>
- This config option has been removed in 0.5.4. </dd>
[edit] rss.config.publictagging
- Default Value</dt>
false</dd>- Description</dt>
- When true, every visitor to your Gregarius site will be allowed to tag items, when false only the Administrator (you) is allowed to tag.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.rating
- Default Value</dt>
true</dd>- Description</dt>
- Enable the item rating system.</dd>
- Notes</dt>
- This feature was taken out at the last moment before releasing 0.5.2. Only the config option remains. Item rating will come back in a future release. Complaining loudly about it will help it come back faster... </dd>
[edit] rss.config.refreshafter
- Default Value</dt>
45</dd>- Description</dt>
- If this option is set the feeds will be refreshed after x minutes of inactivity. Please respect the feed providers by not setting this value to anything lower than thirty minutes. Set this variable to 0 turn this option off.</dd>
- Notes</dt>
- This config option controls how long you have to keep your browser open on a Gregarius page till all your feeds start to update. Naturally, this is not the preferred method of updating your feeds. </dd>
[edit] rss.config.robotsmeta
- Default Value</dt>
index,follow</dd>- Description</dt>
- How should spiders crawl your Gregarius installation (see [1] for more info).</dd>
- Notes</dt>
- Preventing spiders from crawling your website improves performance. </dd>
[edit] rss.config.serverpush
- Default Value</dt>
false</dd>- Description</dt>
- Use server push on update.php for a more user-friendly experience. This is only supported by Mozilla browsers (Netscape, Mozilla, Firefox,...) and Opera. These browsers will be autodetected. If you're not using one of these (you should) you can as well turn this off.</dd>
- Notes</dt>
- Setting this value start the Ajax updater. Although this method is server intensive, it updates your feeds in parallel and saves you time. </dd>
[edit] rss.config.showdevloglink
- Default Value</dt>
false</dd>- Description</dt>
- Show a link to the gregarius devlog. This is mainly useful on the actual live gregarius site. You can safely set this to 'false' if you don't want to display a link back.</dd>
- Notes</dt>
- </dd>
[edit] rss.config.tzoffset
- Default Value</dt>
0</dd>- Description</dt>
- Timezone offset, in hours, between your local time and server time. Valid range: "-12" through "12"</dd>
- Notes</dt>
- </dd>
[edit] rss.input.allowed
- Default Value</dt>
<a href="..." title="..." > <b> <blockquote> <br> <code> <del> <em> <i> <img src="..." alt="..." > <ins> <li> <ol> <p> <pre> <sup> <table> <td> <th> <tr> <tt> <ul>.</dd>- Description</dt>
- This variable controls input filtering. HTML tags and their attributes, which are not in this list, get filtered out when new RSS items are imported.</dd>
- Notes</dt>
- </dd>
[edit] rss.input.allowupdates
- Default Value</dt>
true</dd>- Description</dt>
- Allow Gregarius to look for updates in existing items.</dd>
- Notes</dt>
- If a blog posts an item and then later on updates that item, this config option will control whether we replace the original post with the new value (and mark it as unread) or we discard the new post. </dd>
[edit] rss.meta.debug
- Default Value</dt>
false</dd>- Description</dt>
- When in debug mode some extra debug info is shown and the error reporting is a bit more verbose.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.cachecontrol
- Default Value</dt>
false</dd>- Description</dt>
- If true, Gregarius will negotiate with the browser and check whether it should get a fresh document or not.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.cachedir
- Default Value</dt>
/tmp/magpierss</dd>- Description</dt>
- Where should magpie store its temporary files? (Apache needs write permissions on this dir.)</dd>
- Notes</dt>
- </dd>
[edit] rss.output.channelcollapse
- Default Value</dt>
true</dd>- Description</dt>
- Allow collapsing of channels on the main page.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.compression
- Default Value</dt>
true</dd>- Description</dt>
- This variable turns output compression on and off. Output compression is handled by most browsers.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.encoding
- Default Value</dt>
UTF-8</dd>- Description</dt>
- Output encoding for the PHP XML parser.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.itemsinchannelview
- Default Value</dt>
10</dd>- Description</dt>
- Number of read items shown on for a single channel.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.lang
- Default Value</dt>
English</dd>- Description</dt>
- Which language pack to use</dd>
- Notes</dt>
- Gregarius can be localized for several languages </dd>
[edit] rss.output.noreaditems
- Default Value</dt>
false</dd>- Description</dt>
- Show unread items only on the frontpage.</dd>
- Notes</dt>
- This config option has been removed in 0.5.4. </dd>
[edit] rss.output.numitemsonpage
- Default Value</dt>
100</dd>- Description</dt>
- Maximum number of items displayed on the main page. Set this variable to 0 to turn this option off.</dd>
- Notes</dt>
- This config option has been removed in 0.5.4. </dd>
[edit] rss.output.showfavicons
- Default Value</dt>
true</dd>- Description</dt>
- Display the favicon for the channels that have one. Due to a IE bug, some icons do not render correctly. You can either change the URL to the icon in the admin screen, or turn the display of favicons off globally here.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.showfeedmeta
- Default Value</dt>
false</dd>- Description</dt>
- Display meta-information (like a web- and rss/rdf/xml url) about each feed in the feed side-column.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.theme
- Default Value</dt>
default</dd>- Description</dt>
- The theme to use. Download more themes from the Gregarius Theme Repository.</dd>
- Notes</dt>
- This config option has been removed in 0.5.4. </dd>
[edit] rss.output.titleunreadcnt
- Default Value</dt>
false</dd>- Description</dt>
- Display unread count in the document title.</dd>
- Notes</dt>
- </dd>
[edit] rss.output.usemodrewrite
- Default Value</dt>
true</dd>- Description</dt>
- Make use of apache's mod_rewrite module to return sexy urls. Turn this off if your host doesn't allow you to change this apache setting. </dd>
- Notes</dt>
- Extensive research has shown that 84.35% of all installation-related problems are due to this config option. If you are having a problem, then please turn this config option off and then delete the .htaccess file in your Gregarius directory. </dd>
[edit] rss.output.usepermalinks
- Default Value</dt>
true</dd>- Description</dt>
- Display a permalink icon and allow linking a given item directly.</dd>
- Notes</dt>
- </dd>
[edit] rss.search.maxitems
- Default Value</dt>
500</dd>- Description</dt>
- Limits the number of items returned during searches.</dd>
- Notes</dt>
- </dd>
