justin/gropple
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases 24 Wiki Activity

Clean up documentation

Browse Source
This commit is contained in:
Justin Hawkins 2023-03-15 05:00:56 +10:30
parent 7f0a51d659
commit d650725523
1 changed files with 49 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@ -16,9 +16,10 @@ A frontend to youtube-dl (or compatible forks, like yt-dlp) to download videos w
## Binaries ## Binaries
Binaries are available at https://github.com/tardisx/gropple/releases Binaries are available at <https://github.com/tardisx/gropple/releases>
Gropple will automatically check for available updates and prompt you to upgrade. Gropple will automatically check for available updates and prompt you to
upgrade.
## Running ## Running
@ -32,66 +33,75 @@ interface. The address will be printed after startup:
## Using ## Using
Bring up `http://localhost:6283` (or your configured address) in your browser. You Bring up `http://localhost:6283` (or your configured address) in your browser.
should see a link to the bookmarklet at the top of the screen, and the list of You should see a link to the bookmarklet at the top of the screen, and the list
downloads (currently empty). of downloads (currently empty).
Drag the bookmarklet to your favourites bar, or otherwise bookmark it as you Drag the bookmarklet to your favourites bar, or otherwise bookmark it as you see
see fit. Any kind of browser bookmark should work. The bookmarklet contains fit. Any kind of browser bookmark should work. The bookmarklet contains embedded
embedded javascript to pass the URL of whatever page you are currently on back javascript to pass the URL of whatever page you are currently on back to
to gropple. gropple.
So, whenever you are on a page with a video you would like to download just Whenever you are on a page with a video you would like to download just click
click the bookmarklet. the bookmarklet.
A popup window will appear. Choose a download profile and the download will start. A popup window will appear. Choose a download profile and the download will
The status will be shown in the window, updating in real time. start. The status will be shown in the window, updating in real time.
You may close this window at any time without stopping the download, the status You may close this window at any time without stopping the download, the status
of all downloads is available on the index page. of all downloads is available on the index page.
## Configuration ## Configuration
Click the "config" link on the index page to configure gropple. The default options Click the "config" link on the index page to configure gropple. The default
are fine if you are running on your local machine. If you are running it remotely options are fine if you are running on your local machine. If you are running it
you will need to set the "server address" to ensure the bookmarklet has the correct remotely you will need to set the "server address" to ensure the bookmarklet has
URL in it. the correct URL in it.
### Configuring Downloaders ### Configuring Downloaders
Gropple's default configuration uses the original youtube-dl and has two profiles set Gropple's default configuration uses `yt-dlp` and has two profiles set up, one
up, one for downloading video, the other for downloading audio (mp3). for downloading video, the other for downloading audio (mp3).
Note that gropple does not include any downloaders, you have to install them separately. Note that gropple does not include any downloaders, you have to install them
separately.
If you would like to use a youtube-dl fork (like [yt-dlp](https://github.com/yt-dlp/yt-dlp)) If you would like to use a youtube-dl compatible fork or change the options you
or change the options, you can do so on the right hand side. Create as many profiles as you can do so on the right hand side. Create as many profiles as you wish, whenever
wish, whenever you start a download you can choose the appropriate profile. you start a download you can choose the appropriate profile.
Note that the command arguments must each be specified separately - see the default configuration Note that the command arguments must each be specified separately - see the
for an example. default configuration for an example.
While gropple will use your `PATH` to find the executable, you can also specify a full path While gropple will use your `PATH` to find the executable, you can also specify
instead. Note that any tools that the downloader calls itself (for instance, ffmpeg) will a full path instead. Note that any tools that the downloader calls itself (for
probably need to be available on your path. instance, `ffmpeg`) will need to be available on your path.
### Alternate destinations
Gropple supports adding additional optional destinations. By default, all
downloads will be stored in the main download path specified in the config. You
can also add one or more destinations, and you can choose one of these
destinations when queueing a new download, or while it is still downloading from
the popup.
The file will be moved after downloading is complete.
## Portable mode ## Portable mode
If you'd like to use gropple from a USB stick or similar, copy the config file from If you'd like to use gropple from a USB stick or similar, copy the config file
it's default location (shown when you start gropple) to the same location as the binary, and rename it to `gropple.yml`. from its default location (shown when you start gropple) to the same location as
the binary, and rename it to `gropple.yml`.
If that file is present in the same directory as the binary, it will be used instead.
## Problems ## Problems
Most download problems are probably diagnosable via the log - check in the popup window and scroll Many download problems are diagnosable via the log - check in the popup window
the log down to the bottom. The most common problem is that youtube-dl cannot be found, or its and scroll the log down to the bottom. The most common problem is that `yt-dlp`
dependency (like ffmpeg) cannot be found on your path. cannot be found, or its dependency (like `ffmpeg`) cannot be found on your path.
For other problems, please file an issue on github. For other problems, please file an issue on github.
## TODO ## TODO
Many things. Please raise an issue after checking the [currently open issues](https://github.com/tardisx/gropple/issues). Many things. Please raise an issue after checking the [currently open
issues](https://github.com/tardisx/gropple/issues).