docker-documentation/docs/images/docker-webgrabplus.md

title
webgrabplus

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

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/webgrabplus: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	❌

Application Setup

To configure WebGrab+Plus follow the documentation

Please note that depending on your host this container may not work with the no-new-privileges=true security-opt.

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

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:
  webgrabplus:
    image: lscr.io/linuxserver/webgrabplus:latest
    container_name: webgrabplus
    hostname: webgrabplus
    mac_address: 00:00:00:00:00:00
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/config:/config
      - /path/to/data:/data
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=webgrabplus \
  --hostname=webgrabplus \
  --mac-address=00:00:00:00:00:00 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -v /path/to/config:/config \
  -v /path/to/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/webgrabplus: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

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Etc/UTC	specify a timezone to use, see this list.

Volume Mappings (-v)

Volume	Function
/config	Where webgrabplus should store it's config files.
/data	Where webgrabplus should store it's data files.

Miscellaneous Options

Parameter	Function
--hostname=	Set the hostname for the container for the license check.
--mac-address=	Set the mac_address for the container for the license check.

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 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" }}' lscr.io/linuxserver/webgrabplus:latest

Versions

• 18.08.23: - Rebase to Alpine 3.18.
• 16.08.23: - Update dotnet framework to 7.x.
• 06.07.23: - Deprecate armhf. As announced here
• 13.03.23: - Rebase to Alpine 3.17.
• 23.03.22: - Rebase to Alpine 3.16 and s6v3. Update to dotnet 6.
• 29.04.22: - Add hostname and mac_address arguments that are needed for the license check to compose and cli samples.
• 23.03.22: - Rebase to Alpine 3.15.
• 23.03.22: - Update to use dotnet instead of mono.
• 06.01.22: - Rebase to Ubuntu focal. Enable auto builds on version updates (beta and stable).
• 17.12.21: - Update to version 3.2.2 beta.
• 05.08.21: - Update to version 3.2.1 beta.
• 05.06.21: - Added mono-devel dependency.
• 04.06.21: - Update to version 3.1.8 beta.
• 22.03.21: - Update to version 3.1.7 beta.
• 07.03.21: - Update to version 3.1.6 beta.
• 29.01.21: - Update external version number to show as 3.1.5.
• 24.01.21: - Update to version 3.1.5 beta.
• 22.12.20: - Update to version 3.1.4 beta.
• 12.10.20: - Fix version number in jenkinsfile.
• 12.10.20: - Update to version 3.1.1 beta.
• 22.06.20: - Add mono webrequest library.
• 18.06.20: - Update to v3.1.0.
• 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.