2019-03-30 10:58:18 +00:00
# linuxserver/webgrabplus
2019-02-27 18:48:20 +00:00
2019-03-30 10:58:18 +00:00
[![ ](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) [![ ](https://images.microbadger.com/badges/image/linuxserver/webgrabplus.svg )](https://microbadger.com/images/linuxserver/webgrabplus) ![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)
2019-02-27 18:48:20 +00:00
[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
2019-03-30 10:58:18 +00:00
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/ ).
2019-02-27 18:48:20 +00:00
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 |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-27 18:48:20 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-25 00:44:17 +00:00
| armhf | arm32v7-latest |
2019-02-27 18:48:20 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-03-30 10:58:18 +00:00
```text
2019-02-27 18:48:20 +00:00
docker create \
--name=webgrabplus \
2019-03-06 21:17:42 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-27 18:48:20 +00:00
-e TZ=Europe/London \
-v < path to config > :/config \
-v < path to data > :/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:
2019-03-06 21:17:42 +00:00
- PUID=1000
- PGID=1000
2019-02-27 18:48:20 +00:00
- TZ=Europe/London
volumes:
- < path to config > :/config
- < path to data > :/data
restart: unless-stopped
```
## Parameters
2019-03-30 10:58:18 +00:00
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.
2019-02-27 18:48:20 +00:00
2019-03-30 10:58:18 +00:00
### Ports \(`-p`\)
2019-02-27 18:48:20 +00:00
| Parameter | Function |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-27 18:48:20 +00:00
2019-03-30 10:58:18 +00:00
### Environment Variables \(`-e`\)
2019-02-27 18:48:20 +00:00
| Env | Function |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-03-06 21:17:42 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-27 18:48:20 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2019-03-30 10:58:18 +00:00
### Volume Mappings \(`-v`\)
2019-02-27 18:48:20 +00:00
| Volume | Function |
2019-03-30 10:58:18 +00:00
| :---: | :--- |
2019-02-27 18:48:20 +00:00
| `/config` | Where webgrabplus should store it's config files. |
| `/data` | Where webgrabplus should store it's data files. |
## User / Group Identifiers
2019-03-30 10:58:18 +00:00
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` .
2019-02-27 18:48:20 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-06 21:17:42 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-27 18:48:20 +00:00
2019-03-30 10:58:18 +00:00
```text
2019-02-27 18:48:20 +00:00
$ id username
2019-03-06 21:17:42 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-27 18:48:20 +00:00
```
## Application Setup
2019-03-30 10:58:18 +00:00
To configure WebGrab+Plus follow the \[guide\]\[guideurl\]
2019-02-27 18:48:20 +00:00
Note that there are some things in the guide that does not apply to this container. Below you can find the changes.
2019-03-30 10:58:18 +00:00
**The configuration files are found where your config volume is mounted.** **Do not change the filename tag in the configuration file!**
2019-02-27 18:48:20 +00:00
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.
2019-03-30 10:58:18 +00:00
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!
2019-02-27 18:48:20 +00:00
Below is the syntax of the cron file.
2019-03-30 10:58:18 +00:00
```text
2019-02-27 18:48:20 +00:00
┌───────────── 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
2019-03-25 00:44:17 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-21 22:07:48 +00:00
* **21.03.19:** - Update to beta 2.1.7.
2019-02-27 18:48:20 +00:00
* **19.02.19:** - Add pipeline logic and multi arch.
* **18.01.18:** - Initial Release.
2019-03-30 10:58:18 +00:00