Dymas/kaizoku
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refresh Docker and project docs

Browse Source
This commit is contained in:
Codex
2026-08-09 13:47:38 +02:00
parent 1048b70ca8
commit fa5b6e7636
5 changed files with 30 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -8
View File
@@ -26,6 +26,7 @@ Kaizoku is a local web app for searching, tracking, and downloading anime from A
- Python 3.12 or newer.
- Node.js and npm for the provider bridge.
- `ffmpeg` available in `PATH`.
- `openssl` available in `PATH` for AES-128 encrypted HLS segments.
Install Node dependencies once:
@@ -49,12 +50,13 @@ Useful environment variables:
- `KAIZOKU_HOST=0.0.0.0`
- `KAIZOKU_PORT=8421`
- `KAIZOKU_ALLOW_REMOTE=1`
- `KAIZOKU_AUTH_USERNAME=admin`
- `KAIZOKU_AUTH_PASSWORD=choose-a-long-random-password`
- `KAIZOKU_JOB_STDOUT=true`
- `KAIZOKU_STATE_ROOT=/path/to/state`
- `KAIZOKU_DOWNLOAD_DIR=/downloads`
- `KAIZOKU_ALLOW_REMOTE=1` to allow non-loopback clients.
- `KAIZOKU_AUTH_USERNAME=admin` and `KAIZOKU_AUTH_PASSWORD=choose-a-long-random-password` for remote access.
- `KAIZOKU_JOB_STDOUT=true` to mirror job logs to container or terminal output.
- `KAIZOKU_STATE_ROOT=/path/to/state` to move SQLite state, config, thumbnails, sessions, and staging.
- `KAIZOKU_DOWNLOAD_DIR=/downloads` for the default library output path.
- `KAIZOKU_REMOTE_PATH_ROOTS=/downloads,/media/anime` to limit remote filesystem browsing.
- `KAIZOKU_MODE=sub`, `KAIZOKU_QUALITY=best`, and `KAIZOKU_DEBUG=1` for runtime defaults and diagnostics.
## Docker
@@ -62,12 +64,22 @@ Useful environment variables:
docker compose up -d --build
```
The compose file mounts:
The compose file builds the local checkout and runs Kaizoku on port `8421` by default. It mounts:
- `./downloads` to `/downloads`
- `./.kaizoku` to `/app/.kaizoku`
The Docker image installs Python, Node.js, npm, and `ffmpeg`, then runs `npm install --omit=dev` for the provider bridge.
The Docker image installs Python, Node.js, npm, `ffmpeg`, `openssl`, and `util-linux` for optional UID/GID switching, then runs `npm install --omit=dev` for the provider bridge. Downloads go through Kaizoku's provider bridge and `provider_downloader.py`.
Useful Compose overrides:
```sh
KAIZOKU_PORT=8080 docker compose up -d --build
KAIZOKU_ALLOW_REMOTE=1 KAIZOKU_AUTH_USERNAME=admin KAIZOKU_AUTH_PASSWORD='change-me' docker compose up -d
USER_UID=$(id -u) USER_GID=$(id -g) docker compose up -d
```
Keep `./.kaizoku` mounted for production instances. That directory contains the SQLite database, configuration, queue history, watchlist data, thumbnail cache, remote sessions, and temporary staging files. Removing the mount starts Kaizoku with a fresh empty state.
## Download Flow