diff --git a/images/docker-webgrabplus.md b/images/docker-webgrabplus.md new file mode 100755 index 000000000..a0949f2d8 --- /dev/null +++ b/images/docker-webgrabplus.md @@ -0,0 +1,153 @@ +# [linuxserver/webgrabplus](https://github.com/linuxserver/docker-webgrabplus) + +[![](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/webgrabplus.svg)](https://microbadger.com/images/linuxserver/webgrabplus "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/webgrabplus.svg)](https://microbadger.com/images/linuxserver/webgrabplus "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/webgrabplus.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/webgrabplus.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-webgrabplus/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webgrabplus/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/webgrabplus/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/webgrabplus/latest/index.html) + +[Webgrabplus](http://www.webgrabplus.com) is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels. + +## 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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). + +Simply pulling `linuxserver/webgrabplus` 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=webgrabplus \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -v :/config \ + -v :/data \ + --restart unless-stopped \ + linuxserver/webgrabplus +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + webgrabplus: + image: linuxserver/webgrabplus + container_name: webgrabplus + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/data + mem_limit: 4096m + restart: unless-stopped +``` + +## Parameters + +Docker 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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | + + +### Environment Variables (`-e`) + +| 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 | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Where webgrabplus should store it's config files. | +| `/data` | Where webgrabplus should store it's data files. | + + + +## 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 username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Application Setup + +To configure WebGrab+Plus follow the [guide][guideurl] + +Note that there are some things in the guide that does not apply to this container. Below you can find the changes. + +**The configuration files are found where your config volume is mounted.** +**Do not change the filename tag in the configuration file!** + +The /data volume mapping is where WebGrab+Plus outputs the xml file. To use the xml file in another program, you have to point it to the host path you mapped the /data volume to. + +To adjust the scheduled cron job for grabbing, edit the wg-cron file found in the `/config` folder. After you have edited the the wg-cron file, restart the container to apply the new schedule. +Do not adjust the command! + +Below is the syntax of the cron file. + +``` + ┌───────────── minute (0 - 59) + │ ┌───────────── hour (0 - 23) + │ │ ┌───────────── day of month (1 - 31) + │ │ │ ┌───────────── month (1 - 12) + │ │ │ │ ┌───────────── day of week (0 - 6) (Sunday to Saturday; + │ │ │ │ │ 7 is also Sunday on some systems) + │ │ │ │ │ + │ │ │ │ │ + * * * * * s6-setuidgid abc /bin/bash /defaults/update.sh +``` + + + +## Support Info + +* Shell access whilst the container is running: + * `docker exec -it webgrabplus /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f webgrabplus` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' webgrabplus` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/webgrabplus` + +## Versions + +* **19.02.19:** - Add pipeline logic and multi arch. +* **18.01.18:** - Initial Release.