Skip to content

Commit a5c6e2d

Browse files
committed
Move cron section to docs
1 parent aaf8e09 commit a5c6e2d

File tree

2 files changed

+45
-40
lines changed

2 files changed

+45
-40
lines changed

README.md

Lines changed: 8 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,14 @@ On Mac you can install those with `brew`:
4343
brew install youtube-dl ffmpeg
4444
```
4545

46-
## Access tokens
46+
## Documentation
47+
48+
- [How to get Vimeo API token](./docs/how_to_get_vimeo_token.md)
49+
- [How to get YouTube API Key](./docs/how_to_get_youtube_api_key.md)
50+
- [Podsync on QNAP NAS Guide](./docs/how_to_setup_podsync_on_qnap_nas.md)
51+
- [Schedule updates with cron](./docs/cron.md)
52+
53+
### Access tokens
4754

4855
In order to query YouTube or Vimeo API you have to obtain an API token first.
4956

@@ -84,45 +91,6 @@ hostname = "https://my.test.host:4443"
8491

8592
Server will be accessible from `http://localhost:8080`, but episode links will point to `https://my.test.host:4443/ID1/...`
8693

87-
88-
### Schedule via cron expression
89-
90-
You can use `cron_schedule` field to build more precise update checks schedule.
91-
A cron expression represents a set of times, using 5 space-separated fields.
92-
93-
| Field name | Mandatory? | Allowed values | Allowed special characters |
94-
| ------------ | ---------- | --------------- | -------------------------- |
95-
| Minutes | Yes | 0-59 | * / , - |
96-
| Hours | Yes | 0-23 | * / , - |
97-
| Day of month | Yes | 1-31 | * / , - ? |
98-
| Month | Yes | 1-12 or JAN-DEC | * / , - |
99-
| Day of week | Yes | 0-6 or SUN-SAT | * / , - ? |
100-
101-
Month and Day-of-week field values are case insensitive. `SUN`, `Sun`, and `sun` are equally accepted.
102-
The specific interpretation of the format is based on the Cron Wikipedia page: https://en.wikipedia.org/wiki/Cron
103-
104-
#### Predefined schedules
105-
106-
You may use one of several pre-defined schedules in place of a cron expression.
107-
108-
| Entry | Description | Equivalent to |
109-
| ----------------------- | -------------------------------------------| ------------- |
110-
| `@monthly` | Run once a month, midnight, first of month | `0 0 1 * *` |
111-
| `@weekly` | Run once a week, midnight between Sat/Sun | `0 0 * * 0` |
112-
| `@daily (or @midnight)` | Run once a day, midnight | `0 0 * * *` |
113-
| `@hourly` | Run once an hour, beginning of hour | `0 * * * *` |
114-
115-
#### Intervals
116-
117-
You may also schedule a job to execute at fixed intervals, starting at the time it's added
118-
or cron is run. This is supported by formatting the cron spec like this:
119-
120-
@every <duration>
121-
122-
where "duration" is a string accepted by [time.ParseDuration](http://golang.org/pkg/time/#ParseDuration).
123-
124-
For example, `@every 1h30m10s` would indicate a schedule that activates after 1 hour, 30 minutes, 10 seconds, and then every interval after that.
125-
12694
## One click deployment
12795

12896
[![Deploy to AWS](https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?region=us-west-1#/stacks/new?stackName=Podsync&templateURL=https://podsync-cf.s3.amazonaws.com/cloud_formation.yml)

docs/cron.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Schedule via cron expression
2+
3+
You can use `cron_schedule` field to build more precise update checks schedule.
4+
A cron expression represents a set of times, using 5 space-separated fields.
5+
6+
| Field name | Mandatory? | Allowed values | Allowed special characters |
7+
| ------------ | ---------- | --------------- | -------------------------- |
8+
| Minutes | Yes | 0-59 | * / , - |
9+
| Hours | Yes | 0-23 | * / , - |
10+
| Day of month | Yes | 1-31 | * / , - ? |
11+
| Month | Yes | 1-12 or JAN-DEC | * / , - |
12+
| Day of week | Yes | 0-6 or SUN-SAT | * / , - ? |
13+
14+
Month and Day-of-week field values are case insensitive. `SUN`, `Sun`, and `sun` are equally accepted.
15+
The specific interpretation of the format is based on the Cron Wikipedia page: https://en.wikipedia.org/wiki/Cron
16+
17+
#### Predefined schedules
18+
19+
You may use one of several pre-defined schedules in place of a cron expression.
20+
21+
| Entry | Description | Equivalent to |
22+
| ----------------------- | -------------------------------------------| ------------- |
23+
| `@monthly` | Run once a month, midnight, first of month | `0 0 1 * *` |
24+
| `@weekly` | Run once a week, midnight between Sat/Sun | `0 0 * * 0` |
25+
| `@daily (or @midnight)` | Run once a day, midnight | `0 0 * * *` |
26+
| `@hourly` | Run once an hour, beginning of hour | `0 * * * *` |
27+
28+
#### Intervals
29+
30+
You may also schedule a job to execute at fixed intervals, starting at the time it's added
31+
or cron is run. This is supported by formatting the cron spec like this:
32+
33+
@every <duration>
34+
35+
where "duration" is a string accepted by [time.ParseDuration](http://golang.org/pkg/time/#ParseDuration).
36+
37+
For example, `@every 1h30m10s` would indicate a schedule that activates after 1 hour, 30 minutes, 10 seconds, and then every interval after that.

0 commit comments

Comments
 (0)