Skip to content

Commit b5cec7c

Browse files
committed
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.
1 parent f52018f commit b5cec7c

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See [Environment variables](#environment-variables) for configuration options.
5454
| `POSTAL_CODE` | Postal code of where shows are available. | 30309 |
5555
| `USER_AGENT` | Custom user agent string for HTTP requests. | Uses random if not specified |
5656
| `TZ` | Timezone | System default |
57-
| `SLEEP_TIME` | Sleep time before next run in seconds (default: 10800, Only used with Docker.) | 10800 |
57+
| `SLEEP_TIME` | Sleep time before next run in seconds (default: 21600, Only used with Docker.) | 21600 |
5858
| `OUTPUT_FILE` | Output file name (default: xmltv.xml) | xmltv.xml |
5959

6060
### Command line arguments
@@ -69,3 +69,21 @@ See [Environment variables](#environment-variables) for configuration options.
6969
| `--userAgent` | Custom user agent string for HTTP requests. | Uses random if not specified |
7070
| `--timezone` | Timezone | System default |
7171
| `--outputFile` | Output file name (default: xmltv.xml) | xmltv.xml |
72+
73+
## Setup and running in intervals
74+
75+
### Running natively
76+
77+
You can run zap2xml natively on your system. It is recommended to use a task scheduler to run it in intervals.
78+
79+
Here are some links to get you started on your machine:
80+
81+
- Linux and Raspberry Pi: https://github.com/jef/zap2xml/wiki/Running-on-Linux-and-Raspberry-Pi
82+
- macOS: https://github.com/jef/zap2xml/wiki/Running-on-macOS
83+
- Windows: https://github.com/jef/zap2xml/wiki/Running-on-Windows
84+
85+
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.
86+
87+
### Running in Docker
88+
89+
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).

entrypoint.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh
22

3-
SLEEP_TIME=${SLEEP_TIME:-10800}
3+
SLEEP_TIME=${SLEEP_TIME:-21600}
44

55
while true; do
66
DATE=$(date)

0 commit comments

Comments
 (0)