Bot Updating Templated Files

2019-02-12 00:45:01 +00:00 · 2019-02-12 00:45:01 +00:00 · 6a172c95ab
commit 6a172c95ab
--- a/images/docker-cops.md
+++ b/images/docker-cops.md
@ -1,21 +1,14 @@
-[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/cops](https://github.com/linuxserver/docker-cops)

-[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
+[![](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)

-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.
+[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 +41,139 @@ 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]
+
+## 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 from this image.
+
+### docker
+
 ```
 docker create \
-	--name=cops \
-	-v <path to data>:/config \
-	-v <path to data>:/books \
-	-e PGID=<gid> -e PUID=<uid>  \
-	-e TZ=<timezone> \
-	-p 80:80 \
-	linuxserver/cops
+  --name=cops \
+  -e PUID=1001 \
+  -e PGID=1001 \
+  -e TZ=Europe/London \
+  -p 80:80 \
+  -v <path to data>:/config \
+  -v <path to data>:/books \
+  --restart unless-stopped \
+  linuxserver/cops
+```
+
+
+### docker-compose
+
+Compatible with docker-compose v2 schemas.
+
+```yaml
+---
+version: "2"
+services:
+  cops:
+    image: linuxserver/cops
+    container_name: cops
+    environment:
+      - PUID=1001
+      - PGID=1001
+      - TZ=Europe/London
+    volumes:
+      - <path to data>:/config
+      - <path to data>:/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.`
+Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` 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.
+
+### Ports (`-p`)
+
+| Parameter | Function |
+| :----: | --- |
+| `80` | WebUI |


-* `-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
+### Environment Variables (`-e`)

-It is based on alpine-linux with S6 overlay, for shell access whilst the container is running do `docker exec -it cops /bin/bash`.
+| Env | Function |
+| :----: | --- |
+| `PUID=1001` | for UserID - see below for explanation |
+| `PGID=1001` | for GroupID - see below for explanation |
+| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |

-### User / Group Identifiers
+### Volume Mappings (`-v`)

-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" ™.
+| Volume | Function |
+| :----: | --- |
+| `/config` | COPS Application Data. |
+| `/books` | Calibre metadata.db location. |

-In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
+
+
+## User / Group Identifiers
+
+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`.
+
+Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
+
+In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:

 ```
-  $ id <dockeruser>
+  $ 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`
-
-* image version number
-
-`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/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`

 ## 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.