7.4 KiB
linuxserver/webgrabplus
Webgrabplus 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 and our announcement here.
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 | arm32v7-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=1000 \
-e PGID=1000 \
-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.
---
version: "2"
services:
webgrabplus:
image: linuxserver/webgrabplus
container_name: webgrabplus
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- <path to config>:/config
- <path to data>:/data
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 <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 |
---|
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 |
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=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Application Setup
To configure WebGrab+Plus follow the documentation
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 wg3-cron file found in the /config
folder. After you have edited the the wg3-cron file, restart the container to apply the new schedule.
Do not adjust the command!
Note that due to something in version 3, we had to change the commands for scheduling the grab. If you have a version where there is a wg-cron file in your /config mount, delete it and use wg3-cron instead.
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)
│ │ │ │ │
│ │ │ │ │
* * * * * /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
- 29.03.20: - Update to v3.0.0. Changed to use wg3-cron file.
- 28.05.19: - Update to v2.1.0 and beta v2.1.9, rebase to bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 21.03.19: - Update to beta 2.1.7.
- 19.02.19: - Add pipeline logic and multi arch.
- 18.01.18: - Initial Release.