readmeabook/compose.yaml at main · daemonless/readmeabook · GitHub

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
name: readmeabook

x-daemonless:
  title: "ReadMeABook"
  icon: ":material-book-music:"
  category: "Media Management"
  description: "Audiobook request and management platform with AI recommendations."
  upstream_url: "https://github.com/kikootwo/readmeabook"
  web_url: "https://github.com/kikootwo/readmeabook"
  user: "bsd"
  mlock: false
  upstream_binary: false
  appjail:
    makejail:
      options:
        - "template: !ENV '${PWD}/readmeabook.conf'"
  notes: |
    ReadMeABook bundles PostgreSQL, which requires `allow.sysvipc` for shared memory. Create `readmeabook.conf` alongside `appjail-director.yml`:

    ```
    exec.start: "/bin/sh /etc/rc"
    exec.stop: "/bin/sh /etc/rc.shutdown jail"
    mount.devfs
    persist
    allow.sysvipc
    ```

  docs:
    env:
      PUID: "User ID for the application process"
      PGID: "Group ID for the application process"
      TZ: "Timezone for the container"
      PUBLIC_URL: "Public URL for OAuth callbacks (required for Plex/OIDC auth)"
      LOG_LEVEL: "Logging level (default: info)"
    volumes:
      /app/config: "Application configuration and secrets"
      /app/cache: "Thumbnail and metadata cache"
      /downloads: "Download client path"
      /media: "Audiobook library"
      /var/lib/postgresql/data: "PostgreSQL database storage"
      /var/lib/redis: "Redis data persistence"
    ports:
      3030: "Web UI"

services:
  readmeabook:
    image: ghcr.io/daemonless/readmeabook:latest
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - LOG_LEVEL=info
    volumes:
      - /path/to/containers/readmeabook/config:/app/config
      - /path/to/containers/readmeabook/cache:/app/cache
      - /path/to/containers/readmeabook/postgres:/var/lib/postgresql/data
      - /path/to/containers/readmeabook/redis:/var/lib/redis
      - /path/to/downloads:/downloads
      - /path/to/media:/media
    ports:
      - "3030:3030"