kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
fab85d65cf
commit
a60c026163
|
|
@ -1,6 +1,14 @@
|
||||||
# linuxserver/webgrabplus
|
# [linuxserver/webgrabplus](https://github.com/linuxserver/docker-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)
|
[](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 "Get your own version badge on microbadger.com")
|
||||||
|
[](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)
|
||||||
|
|
||||||
[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 +21,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 | arm32v7-latest |
|
| armhf | arm32v7-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 +45,7 @@ docker create \
|
||||||
linuxserver/webgrabplus
|
linuxserver/webgrabplus
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -59,36 +69,38 @@ 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. |
|
||||||
|
|
||||||
## Environment variables from files \(Docker secrets\)
|
|
||||||
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
As an example:
|
As an example:
|
||||||
|
|
||||||
```text
|
```
|
||||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -96,17 +108,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
||||||
|
|
||||||
## Umask for running applications
|
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
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.
|
||||||
|
|
||||||
|
|
||||||
## 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)
|
||||||
```
|
```
|
||||||
|
|
@ -117,17 +131,19 @@ To configure WebGrab+Plus follow the [documentation](http://www.webgrabplus.com/
|
||||||
|
|
||||||
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 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!
|
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.**
|
**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.
|
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)
|
||||||
|
|
@ -139,11 +155,12 @@ Below is the syntax of the cron file.
|
||||||
* * * * * /bin/bash /defaults/update.sh
|
* * * * * /bin/bash /defaults/update.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=webgrabplus "view available mods for this container.")
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=webgrabplus)
|
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.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -166,4 +183,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **21.03.19:** - Update to beta 2.1.7.
|
* **21.03.19:** - Update to beta 2.1.7.
|
||||||
* **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.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue