Skip to content

Commit 0b1fbe3

Browse files
committed
docs: add OAuth token prerequisite & reword ulimit note
1 parent c5eb586 commit 0b1fbe3

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,28 @@ See the [motivation of the project](#motivation) below.
77

88
## Usage
99

10+
### Prerequisites
11+
12+
You will need to get a Google OAuth token with `https://www.googleapis.com/auth/youtube.upload` scope.
13+
14+
The easiest way of doing it is to utilize the [Google OAuth 2.0 Playground](https://developers.google.com/oauthplayground)
15+
16+
<details>
17+
<summary>Click to see detailed instructions</summary>
18+
19+
1. Visit the [Google OAuth 2.0 Playground](https://developers.google.com/oauthplayground)
20+
2. On the left navbar, select the `YouTube Data API v3` -> `https://www.googleapis.com/auth/youtube.upload` scope
21+
3. Click on **Authorize APIs**
22+
4. Login / select your Google account and allow the app to access your YouTube account
23+
5. Once redirected back to the playground, click on **"Exchange authorization code for tokens"** button
24+
6. Copy the `Access token` string. (You might need renavigate to the `Step 2` tab to see the access token)
25+
26+
</details>
27+
28+
Once you have an **access token**, set it as the environment variable `OAUTH_TOKEN`.
29+
30+
### Running the App
31+
1032
Download the latest release from the [releases page](https://github.com/angeloanan/vod-squirrel/releases) or development build via [commit workflows](https://github.com/angeloanan/vod-squirrel/actions/workflows/dev.yml).
1133

1234
If you are on Mac / Linux, allow the app to be run by `chmod +x vod-squirrel`.
@@ -18,9 +40,9 @@ $ ./vod-squirrel https://twitch.tv/videos/123456789
1840
```
1941

2042
> [!IMPORTANT]
21-
> When archiving a video longer than 2h40m, concatenating video chunks might fail due to `Too many files open`. You can fix this by increasing your system's `ulimit` for the maximum number of open files (`ulimit -n 100000`).
43+
> Archiving a long video might fail due to error `Too many files open`. You can fix this by increasing your system's `ulimit` for the maximum number of open files (`ulimit -n 10240`).
2244
>
23-
> You might want to check the OS' global maximum number of open files before setting the `ulimit` above (`cat /proc/sys/fs/file-max`).
45+
> You might want to check the OS' global maximum number of open files before setting the `ulimit` value above (`cat /proc/sys/fs/file-max`).
2446
2547
You can use the `--help` flag to get a list of all available options:
2648

0 commit comments

Comments
 (0)