This document is an older, unmaintained guide. There may be a new guide available for this software.
The Planet Feed Aggregator takes a collection of RSS feeds and generates what its founders call a "River of News" feed that combines posts from all sources into a single coherent stream. Thus, this software is useful for providing a simple and consolidated overview of ongoing output from selected blogs. Written and configured in Python and run regularly using cron, Planet is easy to configure and use.
Before beginning to follow this guide, we assume that you have completed the getting started guide. If you are new to Linux systems administration you may wish to consider the guides in our using Linux series, particularly the administration basics guide. Beyond this, Planet requires a web server to provide access to the resources it creates, but this document does not depend on specific web server software software.
Prior to installing the Planet software, you will need to enable the universe repositories. Edit the /etc/apt/sources.list to ensure that the following lines are present:
deb http://us.archive.ubuntu.com/ubuntu/ karmic universe deb-src http://us.archive.ubuntu.com/ubuntu/ karmic universe deb http://us.archive.ubuntu.com/ubuntu/ karmic-updates universe deb-src http://us.archive.ubuntu.com/ubuntu/ karmic-updates universe deb http://security.ubuntu.com/ubuntu karmic-security universe deb-src http://security.ubuntu.com/ubuntu karmic-security universe
Issue the following commands to update your system's package repositories and ensure that all installed software is up to date:
apt-get update apt-get upgrade
Install the Planet software by issuing the following command:
apt-get install planet
This will install the Apache HTTP server as a dependency. Congratulations, we can now begin the configuration of Planet.
For the purposes of example, this document assumes that your web server is configured to use /srv/www/bucknell.net/public_html as the public document root for the domain bucknell.net.
Copy the default configuration file to the /srv/www/bucknell.net directory:
cp /etc/planet.conf /srv/www/bucknell.net
Now edit the file, making sure to modify the following values to conform to the needs of your deployment. Consider the following example:
name=Bucknell link=http://bucknell.net owner_name=squire email@example.com cache_dir = /srv/www/bucknell.net/planet_cache output_dir = /srv/www/bucknell.net/public_html items_perpage = 40 days_per_page = 0 template_files = /srv/www/bucknell.net/planet_templates/index.html.tmpl /srv/www/bucknell.net/planet_templates/atom.xml.tmpl /srv/www/bucknell.net/planet_templates/rss20.xml.tmpl /srv/www/bucknell.net/planet_templates/rss10.xml.tmpl /srv/www/bucknell.net/planet_templates/opml.xml.tmpl /srv/www/bucknell.net/planet_templates/foafroll.xml.tmpl [/srv/www/bucknell.net/planet_templates/rss10.xml.tmpl] items_per_page = 30
These settings establish the name and some background information regarding the site. The output_dir determines where Planet will build the site, and should point to a publicly accessible directory equivalent to or beneath the "document root" of your web server. The items_perpage and days_per_page limit the number of posts displayed on all Planet-generated pages. items_per_page trims the number of posts included in the feed to not surpass the threshold set. days_per_page sets a hard limit for the number of days of oldest possible post that can be displayed.
The remaining settings control the behavior and use of templates. Issue the following commands to copy the default templates and other support files into a site specific configuration:
mkdir -p /srv/www/bucknell.net/planet_cache/ mkdir -p /srv/www/bucknell.net/planet_templates/ cp /var/lib/planet/templates/* /srv/www/bucknell.net/planet_templates/ cp -R /var/lib/planet/www/images/ /srv/www/bucknell.net/public_html/ cp /usr/share/doc/planet/examples/planet.* /srv/www/bucknell.net/public_html/
If you want to override any of the default values like the encoding or the value of items_per_page as seen above, simply create an item block beginning with the full path to the template and specify the values beneath. If you need planet to generate an additional template, simply add the full path to the template to the end of the template_files list.
At the end of your planet.conf file, add entries that resemble the following for each feed that you would like to collect in the Planet you're building:
[http://library.linode.com/feeds/linode-library.xml] name = Linode Library
If you want to take advantage of Planet's support for per-feed "faces" or avatars to identify each feed with a distinct logo or image, consider the following examples:
[DEFAULT] facewidth = 64 faceheight = 64 [http://library.linode.com/feeds/linode-library.xml] name = Linode Library face = lin-lib-avatar.png
You can specify default "width" and "height" in the [DEFAULT] directive, but these values can be overridden for feed-specific settings. All "faces" should be stored in an images/ directory beneath the output directory. In the case of this example, deposit images into /srv/www/bucknell.net/public_html/images/.
Once you have completed your modifications to planet.conf, run Planet for the first time by issuing the following command:
The Planet software will only poll the source feeds when the above command is used. Otherwise, all files generated by Planet are static. By maintaining multiple planet.conf files and specifying distinct output directories, it's possible to generate multiple Planet-based websites on a single server.
While you can run Planet without incident using the above method, we recommend running planet regularly using a "cronjob." Edit your crontab file with the following command:
Insert the following job into the crontab:
*/10 * * * * planetplanet /srv/www/bucknell.net/planet.conf
Save the crontab. Your Planet generated site will refresh every 10 minutes. Congratulations!
You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.
This guide is licensed under a Creative Commons Attribution-NoDerivs 3.0 United States License.
Last edited by Matthew Cone on Monday, October 8th, 2012 (r3111).