blob: 93455fe641af0cd46a743a6925b11132e602c24a (
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# Roka
Stream directory of audiobooks to podcasting apps via RSS.
A screenshot of the web interface is [available here](screenshots/web.png).
## Installation
1. Copy and populate app.cfg and uwsgi.ini from examples
2. Install python dependencies flask and uwsgi
```bash
pip install --user flask uwsgi
```
3. Run roka.py with --scan to populate audiobook JSON cache (can be re-run to
update cache upon download of new books)
```bash
./roka.py --scan
```
4. Execute uwsgi.sh to start the server
```bash
./uwsgi.sh
```
## Static generation
In addition to running as a server, Roka can also generate a static index and
set of RSS feeds that can be deployed to static hosting. This mode does not
support a username and password.
1. Set `BASE_URL` in app.cfg to the base url where the static site will be
uploaded.
2. Run roka.py with the `--generate <output_directory>` parameter, where
`<output_directory>` is an output directory to place the generated site. All
audiobook files will be copied to this location.
```bash
./roka.py --generate ./static
```
3. Upload the static site to any static web hosting. Make sure it is accessible
at the URL set as `BASE_URL`
## Design decisions
1. Directories contained within config:ROOT_PATH are marked as audiobooks if and
only if they contain at least one MP3 file
2. Audiobooks are uniquely identifiable by the collective hash of each MP3 file
contained in the audiobook directory
* Pro: If the directory structure is changed or files are moved, RSS/download
link integrity is maintained, preserving app-side listening progress and
history
* Con: Each MP3 file is hashed, which can be slow on spinning rust w/ large
collections
3. XML pubDate and list order is derived from MP3 track attributes; if not
present or duplicates exist, tracks are sorted alphanumerically
if a book's track numbers are unique but incorrect, a preference for filename
sort can be established by creating an 'ignore_tracknum' file in the
audiobook's path
4. No rebuild endpoint exists; cache-affecting routines are run externally by
calling roka.py directly
5. Configuration can either be placed in a file named `app.cfg`, or it can be
overridden on the terminal by passing a JSON string as the `--config`
parameter. I.E. `./roka.py --generate ./static --config '{"ROOT_PATH":
"/path/to/audiobooks", "BASE_URL": "https://example.com/"}'`
|
