diff --git a/README.md b/README.md index 3b34b91..d196835 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,35 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: http://blog.slucas.fr/en/oss/calibre-opds-php-server -[hub]: https://hub.docker.com/r/linuxserver/cops/ +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :- -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! + * regular and timely application updates + * easy user mappings (PGID, PUID) + * custom base image with s6 overlay + * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth + * regular security updates -# linuxserver/cops -[![](https://images.microbadger.com/badges/version/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cops.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cops.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-cops)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-cops/) +Find us at: +* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. +* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord. +* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! +* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018). -COPS, by Sébastien Lucas, stands for Calibre OPDS (and HTML) Php Server. +# PSA: Changes are happening + +From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag. + +TLDR: Multi-arch support is changing from multiple repos to one repo per container image. + +# [linuxserver/cops](https://github.com/linuxserver/docker-cops) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cops.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cops.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cops/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cops/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/index.html) + +[Cops](http://blog.slucas.fr/en/oss/calibre-opds-php-server) by Sébastien Lucas, 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. @@ -48,81 +62,145 @@ So COPS's main advantages are : If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL. -[![cops](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cops-icon.png)][appurl] + +[![cops](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cops-icon.png)](http://blog.slucas.fr/en/oss/calibre-opds-php-server) + +## Supported Architectures + +Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list). + +Simply pulling `linuxserver/cops` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | + ## Usage +Here are some example snippets to help you get started creating a container. + +### docker + ``` docker create \ - --name=cops \ - -v :/config \ - -v :/books \ - -e PGID= -e PUID= \ - -e TZ= \ - -p 80:80 \ - linuxserver/cops + --name=cops \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 80:80 \ + -v :/config \ + -v :/books \ + --restart unless-stopped \ + linuxserver/cops +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +``` +--- +version: "2" +services: + cops: + image: linuxserver/cops + container_name: cops + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/books + ports: + - 80:80 + mem_limit: 4096m + restart: unless-stopped ``` ## Parameters -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. +| Parameter | Function | +| :----: | --- | +| `-p 80` | WebUI | +| `-e PUID=1001` | for UserID - see below for explanation | +| `-e PGID=1001` | for GroupID - see below for explanation | +| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `-v /config` | COPS Application Data. | +| `-v /books` | Calibre metadata.db location. | -* `-p 80` - the port(s) -* `-v /config` - COPS Application Data -* `-v /books` - Calibre metadata.db location -* `-e PGID` for for GroupID - see below for explanation -* `-e PUID` for for UserID - see below for explanation -* `-e TZ` for timezone information, eg Europe/London +## User / Group Identifiers -It is based on alpine-linux with S6 overlay, for shell access whilst the container is running do `docker exec -it cops /bin/bash`. +When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. -### User / Group Identifiers +Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. -Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. - -In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: +In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below: ``` - $ id + $ id username uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` -## Setting up the application + +  +## Application Setup Unlike other implementations of COPS in a docker container, the linuxserver version gives you access to `config_local.php` in `/config` to customise your install to suit your needs, including details of your email account etc to enable emailing of books, it also includes the dependencies required to directly view epub books in your browser. -## Info -* To monitor the logs of the container in realtime `docker logs -f cops`. -* container version number - -`docker inspect -f '{{ index .Config.Labels "build_version" }}' cops` +## Support Info +* Shell access whilst the container is running: `docker exec -it cops /bin/bash` +* To monitor the logs of the container in realtime: `docker logs -f cops` +* container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' cops` * image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cops` -`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cops` +## Updating Info +Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. + +Below are the instructions for updating containers: + +### Via Docker Run/Create +* Update the image: `docker pull linuxserver/cops` +* Stop the running container: `docker stop cops` +* Delete the container: `docker rm cops` +* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) +* Start the new container: `docker start cops` +* You can also remove the old dangling images: `docker image prune` + +### Via Docker Compose +* Update the image: `docker-compose pull linuxserver/cops` +* Let compose update containers as necessary: `docker-compose up -d` +* You can also remove the old dangling images: `docker image prune` ## Versions -+ **14.01.19:** Add multiarch and pipeline logic. -+ **21.08.18:** Rebase to alpine 3.8. -+ **02.07.18:** Add php7-ctype dependency. -+ **08.01.18:** Rebase to alpine 3.7. -+ **25.05.17:** Rebase to alpine 3.6. -+ **03.04.17:** Add composer packages, reduce layers. -+ **02.04.17:** Updated to version 1.1.0. -+ **05.02.17:** Updated to Alpine 3.5 & PHP7. -+ **24.10.16:** Updated to implement user based config. -+ **24.10.16:** Updated to version 1.0.1. -+ **14.10.16:** Add version layer information. -+ **28.09.16:** Add php5-zlib. -+ **11.09.16:** Add layer badges to README. -+ **29.08.16:** Add php5-opcache. -+ **28.08.16:** Add badges to README. -+ **12.08.16:** Release +* **14.01.19:** - Add multiarch and pipeline logic. +* **21.08.18:** - Rebase to alpine 3.8. +* **02.07.18:** - Add php7-ctype dependency. +* **08.01.18:** - Rebase to alpine 3.7. +* **25.05.17:** - Rebase to alpine 3.6. +* **03.04.17:** - Add composer packages, reduce layers. +* **02.04.17:** - Updated to version 1.1.0. +* **05.02.17:** - Updated to Alpine 3.5 & PHP7. +* **24.10.16:** - Updated to implement user based config. +* **24.10.16:** - Updated to version 1.0.1. +* **14.10.16:** - Add version layer information. +* **28.09.16:** - Add php5-zlib. +* **11.09.16:** - Add layer badges to README. +* **29.08.16:** - Add php5-opcache. +* **28.08.16:** - Add badges to README. +* **12.08.16:** - Initial Release. diff --git a/readme-vars.yml b/readme-vars.yml index bfe458d..910ceef 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -2,32 +2,16 @@ # project information project_name: cops -full_custom_readme: | - {% raw -%} - [linuxserverurl]: https://linuxserver.io - [forumurl]: https://forum.linuxserver.io - [ircurl]: https://www.linuxserver.io/irc/ - [podcasturl]: https://www.linuxserver.io/podcast/ - [appurl]: http://blog.slucas.fr/en/oss/calibre-opds-php-server - [hub]: https://hub.docker.com/r/linuxserver/cops/ - - [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] - - The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: - * [forum.linuxserver.io][forumurl] - * [IRC][ircurl] on freenode at `#linuxserver.io` - * [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! - - # linuxserver/cops - [![](https://images.microbadger.com/badges/version/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cops.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cops.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-cops)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-cops/) - - COPS, by Sébastien Lucas, stands for Calibre OPDS (and HTML) Php Server. +project_url: "http://blog.slucas.fr/en/oss/calibre-opds-php-server" +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, 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](http://blog.slucas.fr/en/oss/calibre-opds-php-server) for more details. + See : [COPS's home]({{ project_url }}) for more details. Don't forget to check the [Wiki](https://github.com/seblucas/cops/wiki). @@ -54,82 +38,63 @@ full_custom_readme: | If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL. - [![cops](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cops-icon.png)][appurl] +project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" +project_blurb_optional_extras_enabled: false - ## Usage +# supported architectures +available_architectures: + - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} + - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} + - { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"} - ``` - docker create \ - --name=cops \ - -v :/config \ - -v :/books \ - -e PGID= -e PUID= \ - -e TZ= \ - -p 80:80 \ - linuxserver/cops - ``` +# development version +development_versions: false - ## Parameters +# container parameters +common_param_env_vars_enabled: true +param_container_name: "{{ project_name }}" +param_usage_include_net: false +param_usage_include_env: true +param_env_vars: + - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "COPS Application Data." } + - { vol_path: "/books", vol_host_path: "", desc: "Calibre metadata.db location." } +param_usage_include_ports: true +param_ports: + - { external_port: "80", internal_port: "80", port_desc: "WebUI" } +param_device_map: false +cap_add_param: false - `The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. - For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. - So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 - http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` - - - * `-p 80` - the port(s) - * `-v /config` - COPS Application Data - * `-v /books` - Calibre metadata.db location - * `-e PGID` for for GroupID - see below for explanation - * `-e PUID` for for UserID - see below for explanation - * `-e TZ` for timezone information, eg Europe/London - - It is based on alpine-linux with S6 overlay, for shell access whilst the container is running do `docker exec -it cops /bin/bash`. - - ### User / Group Identifiers - - Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. - - In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: - - ``` - $ id - uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) - ``` - - ## Setting up the application +# optional container parameters +opt_param_usage_include_env: false +opt_param_usage_include_vols: false +opt_param_usage_include_ports: false +opt_param_device_map: false +opt_cap_add_param: false +optional_block_1: false +# application setup block +app_setup_block_enabled: true +app_setup_block: | Unlike other implementations of COPS in a docker container, the linuxserver version gives you access to `config_local.php` in `/config` to customise your install to suit your needs, including details of your email account etc to enable emailing of books, it also includes the dependencies required to directly view epub books in your browser. - ## Info - - * To monitor the logs of the container in realtime `docker logs -f cops`. - - * container version number - - `docker inspect -f '{{ index .Config.Labels "build_version" }}' cops` - - * image version number - - `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cops` - - - ## Versions - - + **14.01.19:** Add multiarch and pipeline logic. - + **21.08.18:** Rebase to alpine 3.8. - + **02.07.18:** Add php7-ctype dependency. - + **08.01.18:** Rebase to alpine 3.7. - + **25.05.17:** Rebase to alpine 3.6. - + **03.04.17:** Add composer packages, reduce layers. - + **02.04.17:** Updated to version 1.1.0. - + **05.02.17:** Updated to Alpine 3.5 & PHP7. - + **24.10.16:** Updated to implement user based config. - + **24.10.16:** Updated to version 1.0.1. - + **14.10.16:** Add version layer information. - + **28.09.16:** Add php5-zlib. - + **11.09.16:** Add layer badges to README. - + **29.08.16:** Add php5-opcache. - + **28.08.16:** Add badges to README. - + **12.08.16:** Release - {%- endraw %} +# changelog +changelogs: + - { 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." }