Adding cookies docs.

This commit is contained in:
Roland 2025-05-05 17:00:28 -06:00
parent 1da973c4c3
commit 57863904ff
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
5 changed files with 65 additions and 2 deletions

View file

@ -1,6 +1,7 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="mkdocs" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true">
<module name="wrolpi-help" />
<option name="ENV_FILES" value="" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<envs>
@ -12,7 +13,17 @@
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/venv/bin/mkdocs" />
<EXTENSION ID="net.ashald.envfile">
<option name="IS_ENABLED" value="false" />
<option name="IS_SUBST" value="false" />
<option name="IS_PATH_MACRO_SUPPORTED" value="false" />
<option name="IS_IGNORE_MISSING_FILES" value="false" />
<option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" />
<ENTRIES>
<ENTRY IS_ENABLED="true" PARSER="runconfig" IS_EXECUTABLE="false" />
</ENTRIES>
</EXTENSION>
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/.venv/bin/mkdocs" />
<option name="PARAMETERS" value="serve -a 0.0.0.0:8086" />
<option name="SHOW_COMMAND_LINE" value="false" />
<option name="EMULATE_TERMINAL" value="false" />

1
.idea/wrolpi-help.iml generated
View file

@ -2,6 +2,7 @@
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/.venv" />
<excludeFolder url="file://$MODULE_DIR$/venv" />
</content>
<orderEntry type="jdk" jdkName="Python 3.11 (wrolpi-help)" jdkType="Python SDK" />

View file

@ -37,10 +37,61 @@ video from the WROLPi channel, then your video will be stored in `videos/WROLPi`
* The file format the video will be encapsulated in.
* `mp4` is the most universally compatible (but proprietary).
* `mkv` is an open-standard media format.
* **Use Browser Profile**
* A browser profile is a set of cookies and settings that are used to download videos. This is useful for
downloading videos from sites that require authentication or have other restrictions.
See [Browser Profiles](#browser-profiles)
* **Channel Tag**
* The selected Tag will be applied to any new Channel created in the process of downloading these videos. The
Channel will be placed in the respective tag directory in the `videos` directory.
## Videos Settings
Behavior when downloading videos can be configured in the `Videos > Settings` page.
![Videos Settings Page](videos-settings.png)
* **Video Resolutions**
* Used to configure the default video resolutions to download. This will be suggested to you when downloading
videos.
* **Video File Format**
* Configure the name of the video file format (and related files). The default is
`%(uploader)s_%(upload_date)s_%(id)s_%(title)s.%(ext)s`, this is used so the video files sort themselves by
channel, then by date.
* **Do not overwrite existing files**
* yt-dlp will not overwrite existing files. This is useful if you are downloading a video that has been partially
downloaded.
* **Download Automatic Subtitles** and **Download subtitles**
* Download captions for the video, if available.
* **Download Thumbnail**
* Download the thumbnail for the video, if available.
* **Extra yt-dlp Arguments**
* The text here will be split by spaces and passed as extra arguments to yt-dlp.
* **Browser Profile**
* Shows the browser profiles available to the `wrolpi` user. This is passed as the `--cookies-from-browser` argument
to yt-dlp.
* **Always Use Browser Profile**
* Will download videos using `--cookies-from-browser` always. This is not recommended!
## How to Use Browser Profiles
Downloading videos that require authentication or have other restrictions can be done using a browser profile. This is
done by logging in as the `wrolpi` user, and authenticating in the browser to the site you want to download from.
### Steps to use a browser profile:
1. Boot your Raspberry Pi.
2. Log in as your user (possibly `pi`)
3. Open the terminal, change the password of the wrolpi user:
* `sudo passwd wrolpi`
4. Log out of your user using **Menu** > **Logout** > **Logout**
5. Select the `wrolpi` user in the dropdown.
6. Launch a browser (Chromium or Firefox) and log in to the site you want to download from.
7. Navigate to your WROLPi app, you should see the browser profile you just created in `Videos > Settings`
8. Select the browser profile you just created in `Videos > Settings` and click **Save**.
You can now enable **Use Browser Profile** in the download modal.
## Download Channels/Playlists
WROLPi can download all videos from a channel, or playlist. This is done using the `Download > Channel/Playlist`
@ -148,4 +199,4 @@ VLC can be launched by navigating: `Applications Menu > Sound & Video > VLC Medi
![wrolpi-launch-vlc.png](wrolpi-launch-vlc.png)
Any video file can be opened by navigating `Media > Open File`. VLC will automatically display captions files that
WROLPi has downloaded.
WROLPi has downloaded.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB