BiBox to PDF

CLI tool to download a book from BiBox as a OCR PDF

Report Bug · Request Feature

DISCLAIMER: THIS PROJECT IS FOR EDUCATIONAL PURPOSES ONLY

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites for manual setup
3. Usage
   • Usage with Docker
   • Usage with manual setup
4. License

About The Project

This cli script allows you to download and ocr books from BiBox.

You need valid login credentials as well as access to the books you want to download.

(back to top)

Getting Started

You can currently only run the script via Docker.

In the future there will be a described way to run it manually.

(back to top)

Usage

Finding the book id

To find the book id, head over to https://bibox.schule and log in to your account. Now open the book you want to download.
The url in your browser should look something like: https://bibox2.westermann.de/book/5417/page/1.
Here the book id is 5417 (between the "/book/" and "/page/" section of the url).

Usage with Docker

To run the image via Docker you can either do it directly via the Docker cli or the recommended way Docker compose.

There are two variants/tags available:

1. latest: The latest ocr version Docker image (larger image than the non-ocr verison)
2. latest-non-ocr: The latest non-ocr version. This image has no support for pdf ocr and is therefore smaller than the ocr version (Currently not available)

Docker Compose

To use the ocr version of the script with Docker Compose run the following command:

docker compose run --rm -it bibox-to-pdf \
    '{USERNAME}' '{PASSWORD}' {BOOK_ID}

Docker CLI

To use the script with ocr via Docker run the following command:

docker run --rm -it \
    -v ./books:/app/output/books \
    ghcr.io/lasser15/bibox-to-pdf:latest \
    '{USERNAME}' '{PASSWORD}' {book_id}

(back to top)

Usage with manual setup

The manual setup is currently not supported. Please use Docker instead.

(back to top)

License

Distributed under the GPL 3.0 License. See LICENSE for more information.

(back to top)