{"id":13678751,"url":"https://github.com/dan-osull/calibre-web","last_synced_at":"2025-04-29T15:33:02.726Z","repository":{"id":194616736,"uuid":"463694242","full_name":"dan-osull/calibre-web","owner":"dan-osull","description":":books: Web app for browsing, reading and downloading eBooks stored in a Calibre database","archived":false,"fork":true,"pushed_at":"2022-02-25T04:38:25.000Z","size":74956,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-11-11T21:37:51.104Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"janeczku/calibre-web","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dan-osull.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null},"funding":{"custom":["https://PayPal.Me/calibreweb"]}},"created_at":"2022-02-25T22:38:34.000Z","updated_at":"2024-05-13T18:19:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"a8f2ef78-5a10-4c30-87c1-67cf6c8ac664","html_url":"https://github.com/dan-osull/calibre-web","commit_stats":null,"previous_names":["dan-osull/calibre-web"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-osull%2Fcalibre-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-osull%2Fcalibre-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-osull%2Fcalibre-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-osull%2Fcalibre-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dan-osull","download_url":"https://codeload.github.com/dan-osull/calibre-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251529602,"owners_count":21603987,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:00:57.800Z","updated_at":"2025-04-29T15:33:00.097Z","avatar_url":"https://github.com/dan-osull.png","language":null,"funding_links":["https://PayPal.Me/calibreweb"],"categories":["JavaScript"],"sub_categories":[],"readme":"# About\n\nCalibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database.\n\n[![GitHub License](https://img.shields.io/github/license/janeczku/calibre-web?style=flat-square)](https://github.com/janeczku/calibre-web/blob/master/LICENSE)\n[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/janeczku/calibre-web?logo=github\u0026style=flat-square\u0026label=commits)]()\n[![GitHub all releases](https://img.shields.io/github/downloads/janeczku/calibre-web/total?logo=github\u0026style=flat-square)](https://github.com/janeczku/calibre-web/releases)\n[![PyPI](https://img.shields.io/pypi/v/calibreweb?logo=pypi\u0026logoColor=fff\u0026style=flat-square)](https://pypi.org/project/calibreweb/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/calibreweb?logo=pypi\u0026logoColor=fff\u0026style=flat-square)](https://pypi.org/project/calibreweb/)\n[![Discord](https://img.shields.io/discord/838810113564344381?label=Discord\u0026logo=discord\u0026style=flat-square)](https://discord.gg/h2VsJ2NEfB)\n\n*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*\n\n![Main screen](https://github.com/janeczku/calibre-web/wiki/images/main_screen.png)\n\n## Features\n\n- Bootstrap 3 HTML5 interface\n- full graphical setup\n- User management with fine-grained per-user permissions\n- Admin interface\n- User Interface in brazilian, czech, dutch, english, finnish, french, german, greek, hungarian, italian, japanese, khmer, korean, polish, russian, simplified and traditional chinese, spanish, swedish, turkish, ukrainian\n- OPDS feed for eBook reader apps \n- Filter and search by titles, authors, tags, series and language\n- Create a custom book collection (shelves)\n- Support for editing eBook metadata and deleting eBooks from Calibre library\n- Support for converting eBooks through Calibre binaries\n- Restrict eBook download to logged-in users\n- Support for public user registration\n- Send eBooks to Kindle devices with the click of a button\n- Sync your Kobo devices through Calibre-Web with your Calibre library\n- Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz, .djvu)\n- Upload new books in many formats, including audio formats (.mp3, .m4a, .m4b)\n- Support for Calibre Custom Columns\n- Ability to hide content based on categories and Custom Column content per user\n- Self-update capability\n- \"Magic Link\" login to make it easy to log on eReaders\n- Login via LDAP, google/github oauth and via proxy authentication\n\n## Installation\n\n#### Installation via pip (recommended)\n1. To avoid problems with already installed python dependencies, it's recommended to create a virtual environment for Calibre-Web\n2. Install Calibre-Web via pip with the command `pip install calibreweb` (Depending on your OS and or distro the command could also be `pip3`). \n3. Optional features can also be installed via pip, please refer to [this page](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-Windows) for details \n4. Calibre-Web can be started afterwards by typing `cps` or `python3 -m cps` \n\nIn the Wiki there are also examples for a [manual installation](https://github.com/janeczku/calibre-web/wiki/Manual-installation) and for installation on [Linux Mint](https://github.com/janeczku/calibre-web/wiki/How-To:Install-Calibre-Web-in-Linux-Mint-19-or-20)\n\n## Quick start\n\nPoint your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog\nSet `Location of Calibre database` to the path of the folder where your Calibre library (metadata.db) lives, push \"submit\" button\\\nOptionally a Google Drive can be used to host the calibre library [-\u003e Using Google Drive integration](https://github.com/janeczku/calibre-web/wiki/Configuration#using-google-drive-integration)\nGo to Login page\n\n#### Default admin login:\n*Username:* admin\\\n*Password:* admin123\n\n\n## Requirements\n\npython 3.5+\n\nOptionally, to enable on-the-fly conversion from one ebook format to another when using the send-to-kindle feature, or during editing of ebooks metadata:\n\n[Download and install](https://calibre-ebook.com/download) the Calibre desktop program for your platform and enter the folder including program name (normally /opt/calibre/ebook-convert, or C:\\Program Files\\calibre\\ebook-convert.exe) in the field \"calibre's converter tool\" on the setup page.\n\n[Download](https://github.com/pgaskin/kepubify/releases/latest) Kepubify tool for your platform and place the binary starting with `kepubify` in Linux: `\\opt\\kepubify` Windows: `C:\\Program Files\\kepubify`.\n\n## Docker Images\n\nA pre-built Docker image is available in these Docker Hub repository (maintained by the LinuxServer team):\n\n#### **LinuxServer - x64, armhf, aarch64**\n+ Docker Hub - [https://hub.docker.com/r/linuxserver/calibre-web](https://hub.docker.com/r/linuxserver/calibre-web)\n+ Github - [https://github.com/linuxserver/docker-calibre-web](https://github.com/linuxserver/docker-calibre-web)\n+ Github - (Optional Calibre layer) - [https://github.com/linuxserver/docker-calibre-web/tree/calibre](https://github.com/linuxserver/docker-calibre-web/tree/calibre) \n\n   This image has the option to pull in an extra docker manifest layer to include the Calibre `ebook-convert` binary.  Just include the environmental variable `DOCKER_MODS=linuxserver/calibre-web:calibre` in your docker run/docker compose file. **(x64 only)**\n  \n   If you do not need this functionality then this can be omitted, keeping the image as lightweight as possible.\n    \n   Both the Calibre-Web and Calibre-Mod images are rebuilt automatically on new releases of Calibre-Web and Calibre respectively, and on updates to any included base image packages on a weekly basis if required.\n   + The \"path to convertertool\" should be set to `/usr/bin/ebook-convert`\n   + The \"path to unrar\" should be set to `/usr/bin/unrar`\n\n# Contact\n\nJust reach us out on [Discord](https://discord.gg/h2VsJ2NEfB)\n\nFor further information, How To's and FAQ please check the [Wiki](https://github.com/janeczku/calibre-web/wiki)\n\n# Contributing to Calibre-Web\n\nPlease have a look at our [Contributing Guidelines](https://github.com/janeczku/calibre-web/blob/master/CONTRIBUTING.md) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdan-osull%2Fcalibre-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdan-osull%2Fcalibre-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdan-osull%2Fcalibre-web/lists"}