MulchProductions

SVN 2 RSS

Current stable version / aktuelle stabile Version: 1.4
Download and Sourcecode: https://github.com/sidler/svn2rss

This is the german version, please scroll down for the english version.

Changelog:

2010-07-27, v1.4: Fixed rendering of single commits in the webview. In some cases the rendering failed for old revision, e.g. if not found in the internal cache.
2010-05-15, v1.3: Fixed escaping of html-entities in webbased detailed-view. Added .htaccess to prevent access of config-xml file.
2010-02-28, v1.2: Introduced webbased commit view. Each rss-item is linked with a webbased detailed-view
2010-02-02, v1.1b: Fixed bug, dates are now formatted according to RFC-282
2010-01-30, v 1.1: Added configuration-option to include changed files
2010-01-10, v 1.0: Initial release
 

Allgemeines

SVN 2 RSS ist ein kleines PHP-Skript, dass aus einer SVN-Historie einen RSS-Feed erzeugt.

svn2rss unterstützt dabei die Konfiguration verschiedener Feeds, mit einer Installation kann also eine beliebige Anzahl an SVN-Repositories in die entsprechende Anzahl an RSS-Feed konvertiert werden.

svn2rss benötigt keine Datenbank sondern lediglich PHP 5. Um die Anzahl der externen Zugriffe auf die Subversion-Server zu reduzieren, unterstützt svn2rss ein Caching der geladenen SVN-Logfiles. Diese werden flach als Dateien abgelegt.

Der Zugriff auf die SVN-Logfiles erfolgt per Aufruf des Kommandozeilenprogramms "svn".

Installation

svn2rss kann von der Github-Projektseite unter https://github.com/sidler/svn2rss heruntergeladen werden.

Zur Installation das ZIP-Archiv entweder lokal entpacken und auf den Webserver hochladen oder direkt auf einem Webserver entpacken.
Wenn das Caching genutzt werden soll, benötigt der Order /svn2rss/cache/ Schreibrechte für den Webserver.

Konfiguration

Sämtliche Konfiguration des Skriptes erfolgt in der Datei svn2rss.xml. Hier können sowohl globale Optionen wie der Pfad zu SVN, Aktivierung des Cachings usw. definiert werden, als auch die Konfiguration der einzelnen Feeds.
Jeder Feed besteht aus den Zugangsdaten zum SVN-Server sowie der ggf. zu verwendenden Cachedauer.
Zusätzlich muss jeder Feed durch eine ID gekennzeichnet werden.

Hinweis: Da die Konfigurationsdatei offen im Web liegt, sollten hier keine sensitiven Zugangsdaten eingetragen werden!

Aufruf

Das Skript kann über die URL http://www.domain.xy/svn2rss.php aufgerufen werden. Wenn unterschiedliche Feeds vorhanden sind, könne diese per http://www.domain.xy/svn2rss.php?feed=ID aufgerufen werden.


---------------------------------- english version-------------------------------


Common

SVN 2 RSS is a small PHP-script generating a RSS-feed out of a SVN-history.

svn2rss supports the configuration of multiple feeds, a single installation can handle an unlimited number of svn-repositories converting them in the matching number of feeds.

svn2rss doesn't need any database, only the support of PHP 5 is needed. To reduce the number of external requests (e.g. to SVN-servers, svn2rss supports the caching of retrieved svn-logs. The cached content is saved in flat files.

The loading of svn-logs is done via the commandline tool "svn".

Installation

svn2rss can be downloaded from the github-projectsite at https://github.com/sidler/svn2rss.

To install svn2rss, decompress the zip-file locally and upload the files or upload the archive to the webserver and decompress it directly on the webserver.
If caching should be used, make sure the folder /svn2rss/cache/ has write-permissions for the webserver.

Configuration

All configuration of the script is done within the file svn2rss.xml. In this file, it's possible to set up global options like the path to the SVN binary, enabling of the caching and the configuration of the single feeds.
Each feed-configuration contains the params needed to access the svn-repository including config-values like enabled or disabled caching.
In addition, every single feed must be identified by the ID-attribute.

Note: Since the config-file is stored readable on the webserver, make sure to not include any sensitive data!

Calling / Execution

The script may be called by the URL http://www.domain.xy/svn2rss.php. While there are different feeds, they can be called independently ba adding the feed-param to the url, e.g. http://www.domain.xy/svn2rss.php?feed=ID.