Readme

README.md

@@ -1 +1,88 @@
-# cops-alpine
+![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
+
+The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
+* [forum.linuxserver.io](https://forum.linuxserver.io)
+* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`
+* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
+
+
+# linuxserver/cops
+
+COPS stands for Calibre OPDS (and HTML) Php Server.
+
+See : [COPS's home](http://blog.slucas.fr/en/oss/calibre-opds-php-server) for more details.
+
+Don't forget to check the [Wiki](https://github.com/seblucas/cops/wiki).
+
+# Why ?
+
+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.
+
+# Docker Container
+
+Unlike other implementations of COPS in a docker container this gives you access to `config_local.php` to customise your install to suit your needs.  It also contains all the dependencies to use the email facility.
+
+`config_local.php` is found in `/config/www/cops/`
+
+## Usage
+
+```
+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
+```
+
+**Parameters**
+
+* `-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 <dockeruser>
+    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
+```
+
+## Info
+
+* To monitor the logs of the container in realtime `docker logs -f couchpotato`.
+
+## Version Log
+
++ **12.08.16:** Release
+