Installing Tsundoku - tylergibbs2/Tsundoku GitHub Wiki

Depending on your setup, the type of installation you prefer may differ. Below, instructions are provided for installation with Docker and installation from source.

• Docker Installation (recommended)
• Source Installation

Already finished installing? Check out Torrent client setup.

Docker Installation (Recommended)

1. Copy the compose.yml file from the repository.
2. Replace the file paths.
3. Run docker compose up -d.

Updating is as simple as running docker compose pull and docker compose up -d.

Source Installation

Requirements

• uv
• Bun

Initial Setup

$ git clone https://github.com/tylergibbs2/Tsundoku
$ uv sync --locked --all-extras
$ bun install
$ bun run build

$ git pull
$ uv sync --locked --all-extras
$ bun install
$ bun run build

Running

$ uv run python -m tsundoku