mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-11 02:11:01 +01:00
83 lines
4.2 KiB
Markdown
83 lines
4.2 KiB
Markdown
# Home assistant add-on: Calibre-web
|
|
|
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/marketplace/actions/super-linter)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
Downloads evolution
|
|
|
|
<img src="stats.png" width=500px>
|
|
|
|
## About
|
|
|
|
---
|
|
|
|
[Calibre-web](https://github.com/janeczku/calibre-web) is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
|
|
|
|
This addon is based on the docker image https://github.com/linuxserver/docker-calibre-web
|
|
|
|
## Installation
|
|
|
|
---
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI and adapt the software options
|
|
|
|
## Configuration
|
|
|
|
---
|
|
|
|
Webui can be found at <http://your-ip:PORT>.
|
|
The default username/password : described in the startup log.
|
|
Configurations can be done through the app webUI, except for the following options
|
|
|
|
Default name : admin
|
|
Default password : admin123
|
|
|
|
```yaml
|
|
PGID: user
|
|
GPID: user
|
|
TZ: timezone
|
|
PASSWORD: Optionally set a password for the gui
|
|
CLI_ARGS: Optionally pass cli start arguments to calibre-web
|
|
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
|
|
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
|
|
cifsusername: "username" # optional, smb username, same for all smb shares
|
|
cifspassword: "password" # optional, smb password
|
|
force_scheme_https: if you have issues accessing ingress with https, check this box to force https
|
|
force_external_port: if you have issues accessing ingress with https, note here your external port used to access HA
|
|
```
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
## Illustration
|
|
|
|
---
|
|
|
|
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|