https://github.com/bensaufley/audiobook-catalog

A Docker container for cataloging audiobooks, intended for use on an Unraid server
https://github.com/bensaufley/audiobook-catalog

audiobooks docker nas unraid

Last synced: 4 months ago
JSON representation

A Docker container for cataloging audiobooks, intended for use on an Unraid server

• Host: GitHub
• URL: https://github.com/bensaufley/audiobook-catalog
• Owner: bensaufley
• License: mit
• Created: 2021-02-09T04:45:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-12-12T16:10:36.000Z (6 months ago)
• Last Synced: 2025-12-14T07:23:09.636Z (6 months ago)
• Topics: audiobooks, docker, nas, unraid
• Language: TypeScript
• Homepage:
• Size: 3.88 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




Audiobook Catalog






A Docker container for cataloging audiobooks, intended for use on an [Unraid]

server. Uses [Sequelize] with a [SQLite] database and [Fastify] on the backend,

and [Preact] on the frontend.

# Environment Variables

- `LOG_LEVEL`: Optional. Passed to pino. Sanitized: options are `trace`,

  `debug`, `info`, `warn`, `error`. Defaults to `info`.

# Mount Paths

- The directory for audiobooks to be organized and stored should be mounted at

  `/audiobooks`.

- The directory where the database will be stored should be mounted at `/db`.

- The directory where imports go should be mounted at `/import`.

# Utilities

Certain command-line utilities are included in the container (located at

`.build/bin`). They will respond to `-h`/`--help` for more information:

- `removeTag`: For safety, tags can only be deleted through the UI if they are

  not associated with any audiobooks. This utility can be used to remove one or

  multiple tags, including those associated with audiobooks (with `-f`).

# Development

`.audiobooks` and `.import` will be mounted at `/audiobooks` and `/import`

respectively, and are gitignored; you can use them to work in a local

environment.

## Scripts

This repo adhere's to GitHub's [Scripts to Rule Them All] pattern.

- `script/cmd`: executes a Docker command with all the extra configuration

  needed for this project. Most other scripts use `script/cmd` under the hood.

- `script/setup`: creates a new Docker image for dev, ignoring cache

- `script/update`: builds the dev Docker image, using cache if possible. In most

  cases, `script/update` is all you need and `script/setup` is unnecessary.

- `script/migrate`: exposes the [Umzug] CLI inside the dev container. If no

  arguments are passed, `up` is assumed.

- `script/server`: runs `script/update` and then starts dev server inside

  generated Docker image. Server will be visible at .

- `script/test`: runs `script/update` and runs `npm test` inside it. Extra

  arguments will be passed as arguments to `npm test`, e.g. `script/test -u` to

  update Jest snapshots.

[sequelize]: https://sequelize.org

[sqlite]: https://www.sqlite.org

[fastify]: https://www.fastify.io

[preact]: https://preactjs.com

[unraid]: https://unraid.net

[scripts to rule them all]: https://github.com/github/scripts-to-rule-them-all

[umzug]: https://github.com/sequelize/umzug