= gitea2rss(1)
:doctype:       manpage
:Author:        tastytea
:Email:         tastytea@tastytea.de
:Date:          2019-04-17
:Revision:      0.0.0
:man source:    gitea2rss
:man version:   {revision}
:man manual:    General Commands Manual

== NAME

gitea2rss - Generates RSS feeds from Gitea releases.

== SYNOPSIS

*gitea2rss* _URL of Gitea project_

== DESCRIPTION

gitea2rss fetches the releases from the Gitea API, converts the data into an RSS
feed and dumps it to stdout. You can use it as a CGI script to generate the
feeds dynamically or simply use cron to generate the feeds at fixed intervals.

If you want to use gitea2rss as a CGI script, you have to set
*GITEA2RSS_BASEURL* to the basis URL of your instance, without the trailing
slash, for example: _https://git.example.com_. The *QUERY_STRING* must contain
_repo=user/project_.

The generated RSS feed contains the *channel* elements _title_, _link_,
_description_, _generator_ and _lastBuildDate_ and the *item* elements _title_,
_link_, _guid_, _pubDate_ and _description_.

== EXAMPLES

gitea2rss https://example.com/user/repo > repo.rss

=== Example rss feed

----
<rss version="2.0">
  <channel>
    <title>gitea2rss releases</title>
    <link>https://schlomp.space/tastytea/gitea2rss</link>
    <description>Releases of tastytea/gitea2rss</description>
    <generator>gitea2rss 0.1.0</generator>
    <lastBuildDate>Wed, 17 Apr 2019 05:07:25 +0200</lastBuildDate>
    <item>
      <title>gitea2rss: 0.1.0</title>
      <link>https://schlomp.space/tastytea/gitea2rss/releases</link>
      <guid isPermaLink="false">schlomp.space release 169</guid>
      <pubDate>Wed, 17 Apr 2019 05:37:10 +0200</pubDate>
      <description><![CDATA[<p><strong>Stable</strong></p><pre>
First release. Everything works, as far as I can tell.
</pre>]]></description>
    </item>
  </channel>
</rss>
----

== SEE ALSO

*crontab*(1) *crontab*(5)

== REPORTING BUGS

Bugtracker: https://schlomp.space/tastytea/gitea2rss/issues

E-mail: tastytea@tastytea.de
