52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# gropple
|
|
|
|
A web service and bookmarklet to download videos with a single click.
|
|
|
|
## Pre-requisites
|
|
|
|
* a passing familiarity with the command line
|
|
* youtube-dl (plus any of its required dependencies, like ffmpeg)
|
|
* golang compiler
|
|
|
|
## Build
|
|
|
|
go build
|
|
|
|
## Binaries
|
|
|
|
Binaries are available at https://github.com/tardisx/gropple/releases
|
|
|
|
## Running
|
|
|
|
gropple -port 6283 -address http://hostname:6283 -path /downloads
|
|
|
|
With no arguments, it will listen on port 6283 and use an address of 'http://localhost:6283'.
|
|
|
|
The address must be specified so that the bookmarklet can refer to the correct
|
|
host when it is not running on your local machine. You may also need to specify
|
|
a different address if you are running it behind a proxy server or similar.
|
|
|
|
## Using
|
|
|
|
Bring up `http://localhost:6283` (or your chosen address) in your browser. You should see a link to the bookmarklet at the top of the screen, and the list of downloads (currently empty).
|
|
|
|
Drag the bookmarklet to your favourites bar, or otherwise bookmark it as you see fit.
|
|
|
|
Whenever you are on a page with a video you would like to download, simply click the bookmarklet.
|
|
|
|
A popup window will appear, the download will start on the your gropple server and the status will be shown in the window.
|
|
|
|
You may close this window at any time without stopping the download, the status of all downloads is available on the index page.
|
|
|
|
## TODO
|
|
|
|
Many things. Please raise an issue. Known items:
|
|
|
|
* queue downloads if too many started (maybe by domain)
|
|
* show logs from the index page
|
|
* process logs better to note post-processing (for instance when video and audio are downloaded separately and then combined)
|
|
* configurable options for youtube-dl, or the ability to use various youtube-dl forks
|
|
|
|
|
|
|