mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

LICENSE
LinuxServer-CI 2019-03-20 17:17:36 -04:00
rodzic efc3aa20d3
commit e112133bad
1 zmienionych plików z 32 dodań i 19 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

49
images/docker-webgrabplus.md
Wyświetl plik

@ -1,6 +1,12 @@
# linuxserver/webgrabplus # [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) [![](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) [![](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. [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.
@ -13,18 +19,19 @@ Simply pulling `linuxserver/webgrabplus` should retrieve the correct image for y
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v6-latest | | armhf | arm32v6-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=webgrabplus \ --name=webgrabplus \
-e PUID=1000 \ -e PUID=1000 \
@ -36,6 +43,7 @@ docker create \
linuxserver/webgrabplus linuxserver/webgrabplus
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -59,57 +67,61 @@ services:
## Parameters ## 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. 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`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
### Environment Variables \(`-e`\) ### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Where webgrabplus should store it's config files. | | `/config` | Where webgrabplus should store it's config files. |
| `/data` | Where webgrabplus should store it's data files. | | `/data` | Where webgrabplus should store it's data files. |
## User / Group Identifiers ## 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`. 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. 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: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
To configure WebGrab+Plus follow the \[guide\]\[guideurl\] 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. 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 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. 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! 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. Below is the syntax of the cron file.
```text ```
┌───────────── minute (0 - 59) ┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23) │ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of month (1 - 31) │ │ ┌───────────── day of month (1 - 31)
@ -121,6 +133,8 @@ Below is the syntax of the cron file.
* * * * * s6-setuidgid abc /bin/bash /defaults/update.sh * * * * * s6-setuidgid abc /bin/bash /defaults/update.sh
``` ```
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
@ -136,4 +150,3 @@ Below is the syntax of the cron file.
* **19.02.19:** - Add pipeline logic and multi arch. * **19.02.19:** - Add pipeline logic and multi arch.
* **18.01.18:** - Initial Release. * **18.01.18:** - Initial Release.