2020-06-29 07:29:55 +00:00
# linuxserver/webgrabplus
[](https://github.com/linuxserver/docker-webgrabplus) [](https://github.com/linuxserver/docker-webgrabplus/releases) [](https://github.com/linuxserver/docker-webgrabplus/packages) [](https://gitlab.com/Linuxserver.io/docker-webgrabplus/container_registry) [](https://microbadger.com/images/linuxserver/webgrabplus) [](https://hub.docker.com/r/linuxserver/webgrabplus) [](https://hub.docker.com/r/linuxserver/webgrabplus) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webgrabplus/job/master/) [](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-09-04 20:18:45 +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 |
2020-06-29 07:29:55 +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
2020-06-29 07:29:55 +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
---
2020-04-08 20:18:10 +00:00
version: "2.1"
2019-02-27 18:48:20 +00:00
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
2020-06-29 07:29:55 +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
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-27 18:48:20 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-27 18:48:20 +00:00
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-27 18:48:20 +00:00
| Env | Function |
2020-06-29 07:29:55 +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 |
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-27 18:48:20 +00:00
| Volume | Function |
2020-06-29 07:29:55 +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. |
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-06-03 20:18:10 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-06-03 20:18:10 +00:00
-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
2020-06-29 07:29:55 +00:00
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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-04-29 20:17:50 +00:00
2019-02-27 18:48:20 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +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
2020-06-29 07:29:55 +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-05-19 09:13:37 +00:00
To configure WebGrab+Plus follow the [documentation ](http://www.webgrabplus.com/documentation/configuration/ )
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.
2020-06-29 07:29:55 +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.
2020-06-29 07:29:55 +00:00
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!
2019-02-27 18:48:20 +00:00
2020-03-29 20:24:19 +00:00
**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.**
2019-02-27 18:48:20 +00:00
Below is the syntax of the cron file.
2020-06-29 07:29:55 +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)
│ │ │ │ │
│ │ │ │ │
2020-03-29 20:24:19 +00:00
* * * * * /bin/bash /defaults/update.sh
2019-02-27 18:48:20 +00:00
```
2020-04-08 20:18:10 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=webgrabplus)
2020-04-08 20:18:10 +00:00
2020-06-29 07:29:55 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/docker-mods ) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
2019-10-02 20:18:06 +00:00
2019-02-27 18:48:20 +00:00
## Support Info
2019-09-04 20:18:45 +00:00
* Shell access whilst the container is running:
2019-02-27 18:48:20 +00:00
* `docker exec -it webgrabplus /bin/bash`
2019-09-04 20:18:45 +00:00
* To monitor the logs of the container in realtime:
2019-02-27 18:48:20 +00:00
* `docker logs -f webgrabplus`
2019-09-04 20:18:45 +00:00
* Container version number
2019-02-27 18:48:20 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' webgrabplus`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/webgrabplus`
## Versions
2020-06-23 10:04:51 +00:00
* **22.06.20:** - Add mono webrequest library
2020-06-20 15:50:50 +00:00
* **18.06.20:** - Update to v3.1.0.
2020-03-29 20:24:19 +00:00
* **29.03.20:** - Update to v3.0.0. Changed to use wg3-cron file.
2019-05-28 19:48:02 +00:00
* **28.05.19:** - Update to v2.1.0 and beta v2.1.9, rebase to bionic.
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.
2020-06-29 07:29:55 +00:00
