summaryrefslogtreecommitdiff
path: root/README.md
blob: f16bb8c3deb1146a204f5bd37048022cf94eab7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
mp32rss
=======

mp32rss builds a static website from a set of mp3s in in S3 bucket,
typically to generate a podcast feed.

Each time it runs, mp32rss scans the S3 bucket for new MP3s then extracts
the metadata to build RSS feeds or webpages listing the contents. The tool
keeps an index of previously discovered files in the same s3 bucket to
avoid downloading the same files more than once.


Usage
=====

Setup
-----

1. Create an S3 bucket and a static website (you're on your own).

2. Setup the appropriate credentials in a way that the AWS SDK will
   detect. If the AWS CLI works, you should be good to go.

3. Create your templates to render context. See example/podcast.xml.

4. Install the templates:

      mp32rss --bucket $BUCKET \
        add-template --index example/podcast.xml podcast.xml


Regular usage
-------------

Each time you upload a file, refresh the feed:

    mp32rss --bucket $BUCKET refresh


Contributions
=============

Send bug reports or patches to jesse@jesterpm.net.