From 49975867658ff7ca8f653522e4f67441a7c3dc9f Mon Sep 17 00:00:00 2001 From: Conan Scott Date: Tue, 25 Nov 2025 19:31:20 +1100 Subject: [PATCH] updated Readme.MD --- README.md | 44 +------------------------------------------- 1 file changed, 1 insertion(+), 43 deletions(-) diff --git a/README.md b/README.md index bf39b75..13d1ba7 100644 --- a/README.md +++ b/README.md @@ -1,43 +1 @@ -# Kubernetes deployment of calibre-web - -This is a **Kubernetes** deployment of [calibre-web](https://github.com/janeczku/calibre-web) application which uses [linuxserver/calibre-web](https://hub.docker.com/r/linuxserver/calibre-web) docker image. - -## How to - -**Note** This deployment assumes the Kubernetes cluster runs the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx) as ingress controller. If you use another ingress controller, you will have to adapt `ingress.yml` accordingly. - - git clone https://github.com/devtud/calibre-kubernetes - -Edit `ingress.yml` and replace your domain name on this line: - -```yml - - host: -``` - -Open `deployment.yml` and adapt the two values on the following lines according to your needs (the user id and group id which own the files on the host machine - **do not set it as root!**). - -```yml - - name: PUID - value: "1001" - - name: PGID - value: "1001" -``` - -Apply the Kubernetes resources: - - kubectl apply -f ns.yml - kubectl apply -f pv_books.yml - kubectl apply -f pv_config.yml - kubectl apply -f pvc_books.yml - kubectl apply -f pvc_config.yml - kubectl apply -f deployment.yml - kubectl apply -f service.yml - kubectl apply -f ingress.yml - - -**Important** Even though you can access the deployed `calibre-web` app at your address, you won't be able to use it, because neither the calibre-web app nor the docker image provide a Calibre database. You have to get a Calibre database first and upload it to `/var/data/calibre/books/metadata.db` (note that this is the path on your host machine where the persistent volume [pv_books.yml](pv_books.yml) is pointing to). One way of doing this is to install a fresh Calibre on your computer and copy the `metadata.db` file from your computer to the mentioned path. - -After you open the web interface, in the config screen put the following values: -- `/books` for the db path -- `/usr/bin/ebook-convert` for the converter path -- `/usr/bin/unrar` for the unrar path +Run deploy.sh to deploy **_calibre web_** to OCP