readme-vars.yml

---

# project information
project_name: cops
project_url: "https://github.com/mikespub-org/seblucas-cops"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cops-icon.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) by Sébastien Lucas, now maintained by MikesPub, stands for Calibre OPDS (and HTML) Php Server.

  COPS links to your Calibre library database and allows downloading and emailing of books directly from a web browser and provides a OPDS feed to connect to your devices.

  Changes in your Calibre library are reflected immediately in your COPS pages.

  See : [COPS's home]({{ project_url }}) for more details.

  Don't forget to check the [Wiki](https://github.com/mikespub-org/seblucas-cops/wiki).

  ## Why? (taken from the author's site)

  In my opinion Calibre is a marvelous tool but is too big and has too much
  dependencies to be used for its content server.

  That's the main reason why I coded this OPDS server. I needed a simple
  tool to be installed on a small server (Seagate Dockstar in my case).

  I initially thought of Calibre2OPDS but as it generate static file no
  search was possible.

  Later I added an simple HTML catalog that should be usable on my Kobo.

  So COPS's main advantages are :
   * No need for many dependencies.
   * No need for a lot of CPU or RAM.
   * Not much code.
   * Search is available.
   * With Dropbox / owncloud it's very easy to have an up to date OPDS server.
   * It was fun to code.

  If you want to use the OPDS feed don't forget to specify /feed at the end of your URL.

project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "COPS Application Data." }
  - { vol_path: "/books", vol_host_path: "/path/to/data", desc: "Calibre metadata.db location." }
param_usage_include_ports: true
param_ports:
  - { external_port: "80", internal_port: "80", port_desc: "HTTP WebUI" }
  - { external_port: "443", internal_port: "443", port_desc: "HTTPS WebUI" }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `http://<docker host ip>:80`. For connecting via OPDS on a mobile device use `http://<docker host ip>:80/index.php/feed`. It is strongly suggested that you reverse proxy this prior to exposing to the internet. For more information, such as requiring credentials, check the COPS Wiki (linked above).

  The linuxserver version gives you access to `config/local.php` in `/config` to customise your install to suit your needs, it also includes the dependencies required to directly view epub books in your browser.

# changelog
changelogs:
  - { date: "14.09.24:", desc: "Ensure user config files have the right permissions." }
  - { date: "09.09.24:", desc: "In COPS 3.x, the config_local.php is being moved over to config/local.php and this container will automatically migrate it. Existing users should verify: config_local.php and/or config/local.php - define $config['cops_kepubify_path'] if they want to use it" }
  - { date: "28.08.24:", desc: "Add kepubify tool to update metadata for Kobo - see mikespub-org/seblucas-cops#77" }
  - { date: "24.06.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings." }
  - { date: "07.05.24:", desc: "Existing users should verify: site-confs/default.conf - Fix rewriting rules default site conf." }
  - { date: "20.03.24:", desc: "Rebase to Alpine 3.19." }
  - { date: "25.12.23:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf." }
  - { date: "11.08.23:", desc: "Undeprecate and add new branch with mikespub fork which is actively maintained." }
  - { date: "15.05.23:", desc: "Deprecate due to upstream dev abandonment of project." }
  - { date: "13.04.23:", desc: "Move ssl.conf include to default.conf." }
  - { date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1." }
  - { date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." }
  - { date: "22.11.20:", desc: "Pin composer version to 1.10.17." }
  - { date: "01.06.20:", desc: "Rebasing to alpine 3.12." }
  - { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
  - { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "27.02.19:", desc: "Upgrade packages during install to prevent mismatch with baseimage." }
  - { date: "22.02.19:", desc: "Rebasing to alpine 3.9." }
  - { date: "14.01.19:", desc: "Add multiarch and pipeline logic." }
  - { date: "21.08.18:", desc: "Rebase to alpine 3.8." }
  - { date: "02.07.18:", desc: "Add php7-ctype dependency." }
  - { date: "08.01.18:", desc: "Rebase to alpine 3.7." }
  - { date: "25.05.17:", desc: "Rebase to alpine 3.6." }
  - { date: "03.04.17:", desc: "Add composer packages, reduce layers." }
  - { date: "02.04.17:", desc: "Updated to version 1.1.0." }
  - { date: "05.02.17:", desc: "Updated to Alpine 3.5 & PHP7." }
  - { date: "24.10.16:", desc: "Updated to implement user based config." }
  - { date: "24.10.16:", desc: "Updated to version 1.0.1." }
  - { date: "14.10.16:", desc: "Add version layer information." }
  - { date: "28.09.16:", desc: "Add php5-zlib." }
  - { date: "11.09.16:", desc: "Add layer badges to README." }
  - { date: "29.08.16:", desc: "Add php5-opcache." }
  - { date: "28.08.16:", desc: "Add badges to README." }
  - { date: "12.08.16:", desc: "Initial Release." }