docs: include so links to wiki, update SLEEP_TIME default
SLEEP_TIME is now 6 hours instead of 3 because of the default TIMESPAN of 6 hours.
This commit is contained in:
20
README.md
20
README.md
@@ -54,7 +54,7 @@ See [Environment variables](#environment-variables) for configuration options.
|
|||||||
| `POSTAL_CODE` | Postal code of where shows are available. | 30309 |
|
| `POSTAL_CODE` | Postal code of where shows are available. | 30309 |
|
||||||
| `USER_AGENT` | Custom user agent string for HTTP requests. | Uses random if not specified |
|
| `USER_AGENT` | Custom user agent string for HTTP requests. | Uses random if not specified |
|
||||||
| `TZ` | Timezone | System default |
|
| `TZ` | Timezone | System default |
|
||||||
| `SLEEP_TIME` | Sleep time before next run in seconds (default: 10800, Only used with Docker.) | 10800 |
|
| `SLEEP_TIME` | Sleep time before next run in seconds (default: 21600, Only used with Docker.) | 21600 |
|
||||||
| `OUTPUT_FILE` | Output file name (default: xmltv.xml) | xmltv.xml |
|
| `OUTPUT_FILE` | Output file name (default: xmltv.xml) | xmltv.xml |
|
||||||
|
|
||||||
### Command line arguments
|
### Command line arguments
|
||||||
@@ -69,3 +69,21 @@ See [Environment variables](#environment-variables) for configuration options.
|
|||||||
| `--userAgent` | Custom user agent string for HTTP requests. | Uses random if not specified |
|
| `--userAgent` | Custom user agent string for HTTP requests. | Uses random if not specified |
|
||||||
| `--timezone` | Timezone | System default |
|
| `--timezone` | Timezone | System default |
|
||||||
| `--outputFile` | Output file name (default: xmltv.xml) | xmltv.xml |
|
| `--outputFile` | Output file name (default: xmltv.xml) | xmltv.xml |
|
||||||
|
|
||||||
|
## Setup and running in intervals
|
||||||
|
|
||||||
|
### Running natively
|
||||||
|
|
||||||
|
You can run zap2xml natively on your system. It is recommended to use a task scheduler to run it in intervals.
|
||||||
|
|
||||||
|
Here are some links to get you started on your machine:
|
||||||
|
|
||||||
|
- Linux and Raspberry Pi: https://github.com/jef/zap2xml/wiki/Running-on-Linux-and-Raspberry-Pi
|
||||||
|
- macOS: https://github.com/jef/zap2xml/wiki/Running-on-macOS
|
||||||
|
- Windows: https://github.com/jef/zap2xml/wiki/Running-on-Windows
|
||||||
|
|
||||||
|
If you want to run zap2xml in intervals, you can use a task scheduler like `cron` on Linux or the Task Scheduler on Windows. Each of the wiki pages above has a section on how to set up zap2xml to run in intervals.
|
||||||
|
|
||||||
|
### Running in Docker
|
||||||
|
|
||||||
|
You can run zap2xml in a Docker container. The `SLEEP_TIME` environment variable can be used to set the interval between runs. The default is 21600 seconds (6 hours).
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
SLEEP_TIME=${SLEEP_TIME:-10800}
|
SLEEP_TIME=${SLEEP_TIME:-21600}
|
||||||
|
|
||||||
while true; do
|
while true; do
|
||||||
DATE=$(date)
|
DATE=$(date)
|
||||||
|
|||||||
Reference in New Issue
Block a user