Search…
Images
Powered By GitBook
linuxserver/cops
Cops 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 for more details.
Don't forget to check the 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.php at the end of your URL.

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 and our announcement here.
Simply pulling lscr.io/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
arm32v7-latest

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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
cops:
5
image: lscr.io/linuxserver/cops
6
container_name: cops
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- <path to data>:/config
13
- <path to data>:/books
14
ports:
15
- 80:80
16
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=cops \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 80:80 \
7
-v <path to data>:/config \
8
-v <path to data>:/books \
9
--restart unless-stopped \
10
lscr.io/linuxserver/cops
Copied!

Parameters

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

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume
Function
/config
COPS Application Data.
/books
Calibre metadata.db location.

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

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=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

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" }}' lscr.io/linuxserver/cops

Versions

    22.11.20: - Pin composer version to 1.10.17.
    01.06.20: - Rebasing to alpine 3.12.
    19.12.19: - Rebasing to alpine 3.11.
    28.06.19: - Rebasing to alpine 3.10.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    27.02.19: - Upgrade packages during install to prevent mismatch with baseimage.
    22.02.19: - Rebasing to alpine 3.9.
    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.
Last modified 21d ago