diff options
| author | Andrew Dolgov <[email protected]> | 2023-11-03 18:16:29 +0000 |
|---|---|---|
| committer | Andrew Dolgov <[email protected]> | 2023-11-03 18:16:29 +0000 |
| commit | 886421a258fa185f377c5b4428dd0cdbef1c15e7 (patch) | |
| tree | 3ea483c4b306ff239261b4dd2f551baa1b145378 | |
| parent | 7e17086cbc3a689e19a9fc08232674cb53221ccd (diff) | |
Update Home
| -rw-r--r-- | Home.md | 69 |
1 files changed, 49 insertions, 20 deletions
@@ -13,7 +13,7 @@ Self-hosted web EPUB reader using EPUB.js, Bootstrap, and Calibre. See also: * [Android client (wrapper)](https://git.tt-rss.org/fox/the-epube-android) -* [Demo](https://srv.tt-rss.org/books/) (login as <code>demo</code>, <code>demo</code>; database is restored every three hours) +* [Demo](https://the-epube-demo.tt-rss.org/) (login as <code>demo</code>, <code>demo</code>; database is restored every six hours) ### Screenshots @@ -33,32 +33,61 @@ See also: ### Installation -I suggest using compose with my [Docker Hub](https://hub.docker.com/u/cthulhoo) images (note `static-dockerhub` [branch](https://git.tt-rss.org/fox/epube-docker-compose.git/tree/?h=static-dockerhub) below). Those go through a proper CI/CD pipeline so there are some safeguards involved which would hopefully prevent a broken image getting pushed out. +Use the following compose setup to either pull or build your own images: -```sh -git clone -b static-dockerhub https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose +#### .env -cd epube-docker-compose -cp .env-dist .env -vi .env +```ini +# Put any local modifications here. # Calibre library base directory (mounts to /books) BOOKS_DIR=/home/user/calibre/Books -docker-compose up +# Default user to create (if it doesn't exist) EPUBE_ADMIN_USER=admin EPUBE_ADMIN_PASS=password + # bind exposed port to 127.0.0.1 by default in case reverse proxy is used. # if you plan to run the container standalone and need origin port exposed # use next HTTP_PORT definition (or remove "127.0.0.1:"). HTTP_PORT=127.0.0.1:8280 #HTTP_PORT=8280 ``` -Alternatively, you can use [master branch](https://git.tt-rss.org/fox/epube-docker-compose.git/) compose file which would build a DIY image using latest Epube source from Git: - -```sh -git clone https://git.tt-rss.org/fox/epube-docker-compose.git epube-docker-compose - -cd epube-docker-compose -cp .env-dist .env -vi .env - -docker-compose up --build +#### docker-compose.yml + +```yaml +version: '3' + +services: + # optional dictionary server (add other dictionaries via Dockerfile) + # comment it out if you don't need it + + dict: + restart: unless-stopped + build: + dockerfile: .docker/dict/Dockerfile + context: https://git.tt-rss.org/fox/the-epube.git + + app: + build: + dockerfile: .docker/app/Dockerfile + context: https://git.tt-rss.org/fox/the-epube.git + args: + BUILDKIT_CONTEXT_KEEP_GIT_DIR: 1 + restart: unless-stopped + env_file: + - .env + volumes: + - app:/var/www/html + - ${BOOKS_DIR}:/books:ro + + web-nginx: + build: + dockerfile: .docker/web-nginx/Dockerfile + context: https://git.tt-rss.org/fox/the-epube.git + restart: unless-stopped + ports: + - ${HTTP_PORT}:80 + volumes: + - app:/var/www/html:ro + depends_on: + - app + +volumes: + app: ``` ---------------- - For host installation, see [README.md](https://git.tt-rss.org/fox/the-epube.git/tree/README.md) ### FAQ |