11 KiB

Czysty Wina Historia

title
cops

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

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:latest 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	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	✅	arm32v7-<version tag>

Application Setup

Access the webui at http://<docker host ip>:80. For connecting via OPDS on a mobile device use http://<docker host ip>:80/feed.php. 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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  cops:
    image: lscr.io/linuxserver/cops:latest
    container_name: cops
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - <path to data>:/config
      - <path to data>:/books
    ports:
      - 80:80
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=cops \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 80:80 \
  -v <path to data>:/config \
  -v <path to data>:/books \
  --restart unless-stopped \
  lscr.io/linuxserver/cops:latest

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:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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:latest

Versions

19.01.23: - Rebase to alpine 3.17 with php8.1.
20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
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.

11 KiB Czysty Wina Historia