Merge pull request #18 from Leonetienne/develop
Updated readme to fit the new downloader
This commit is contained in:
commit
b0d1f1f176
19
README.md
19
README.md
@ -6,7 +6,7 @@ The free, open source video downloader!
|
||||
No longer do you have to rely on shady websites, shoving tons of ads in your face to fulfil your downloady needs. No longer will you be held back by artificially crippled download speeds, login-/paywalls or even watermarks.
|
||||
|
||||
## But what is Tubio?
|
||||
Tubio in of itself is not a downloader, but a GUI for the widely known, open-source, public-domain cli [youtube-dl](http://youtube-dl.org/). <sup>Thanks for this awesome tool! You guys are heroes!</sup>
|
||||
Tubio in of itself is not a downloader, but a GUI for the widely known, open-source, public-domain cli [yt-dlp](https://github.com/yt-dlp/yt-dlp/). <sup>Thanks for this awesome tool! You guys are heroes! (Obviously, same goes for youtube-dl, which yt-dlp is based on)</sup>
|
||||
The goal of Tubio is to make this awesome software more accessible. Not everyone knows how to use the command line!
|
||||
|
||||
## But, how does it work?
|
||||
@ -88,7 +88,7 @@ Tubio does NOT manage sessions or accounts! Everyone using your Tubio instance w
|
||||
If you opt for unleashing Tubio on your LAN, i would **strongly** recommend enabling the whitelist! You can do this either in the `config.json` or in /settings. Either way, it is a json-array of strings which represent IPv4 addresses.
|
||||
|
||||
## Setup (Windows)
|
||||
#### Install youtube-dl.exe:
|
||||
#### Install yt-dlp.exe:
|
||||
1) Download the latest Tubio build from [here](https://github.com/Leonetienne/Tubio/releases).
|
||||
2) Create some folder on your pc. This will be the installation folder.
|
||||
3) Dump in the contents of the Tubio build you just downloaded.
|
||||
@ -104,36 +104,39 @@ If you opt for unleashing Tubio on your LAN, i would **strongly** recommend enab
|
||||
This happens as there often is some post-processing to do after downloading.
|
||||
|
||||
### My downloads fail!
|
||||
First thing to do: Navigate to /settings and click "Update ytdl". This will update your local instance of [youtube-dl](http://youtube-dl.org/). Check the logs to see if it worked. If not, restart Tubio and try again.
|
||||
First thing to do: Navigate to /settings and click "Update ytdl". This will update your local instance of [yt-dlp](https://github.com/yt-dlp/yt-dlp/). Check the logs to see if it worked. If not, you can always download it yourself (from the [releases-page](https://github.com/yt-dlp/yt-dlp/releases) and put yt-dlp.exe in the same directory tubio.exe lies in.).
|
||||
|
||||
If it\`s still not working, you are most likely trying to download a video from a playlist with a weird url. Try a different one (The one from the share button, the one from right-clicking the video or the one from the url-bar in your browser).
|
||||
|
||||
If it\`s still not working, you\`re out of luck. :(
|
||||
You may want to check youtube-dl compatible sites.
|
||||
|
||||
### I locked myself out by enabling localhost only on another device!
|
||||
This can only be undone from the host. Open Tubio via, and this is important, either `localhost` or `127.0.0.1` and untick it again. If you can only ssh into the host, you can edit the `config.json` itself and restart Tubio.
|
||||
This can only be undone from localhost. Open Tubio via, and this is important, either `localhost` or `127.0.0.1` and untick it again. If you can only ssh into the host, you can edit the `config.json` itself and restart Tubio.
|
||||
|
||||
### Does it work on linux?
|
||||
Well, technically, yes. You would have to install youtube-dl and the ffmpeg suite yourself, and compile Tubio yourself though. I have not tried it yet, but it should work.
|
||||
You may get warnings for missing .exe files, which are obviously not needed on linux.
|
||||
|
||||
### Can i use it on my phone?
|
||||
### Can I use it on my phone?
|
||||
Sure. Read [this](#user-content-can-i-use-tubio-on-multiple-devices).
|
||||
|
||||
### Can i use this to host my own downloader website?
|
||||
On your own risk! Tubio is NOT designed for this! Also do note that tubio does NOT manage sessions or accounts! Everyone accessing this instance can see everyones downloads and access the admin panel! Tubio is really designed for one user!
|
||||
|
||||
### XY is not working, you have to fix it now!
|
||||
I do not. Tubio is a tool i originally made for myself only. I just thought it\`s nice and worth sharing. I will address issues when i have time. Feel free to submit issues and i will have a look when i get to it. :)
|
||||
I do not. Tubio is a tool I originally made for myself only. I just thought it\`s nice and worth sharing. I will address issues when I have time. Feel free to submit issues and I will have a look when I get to it. :)
|
||||
|
||||
### XY is not polished enough!
|
||||
This is an alpha-version. What did you expect? :D
|
||||
|
||||
### Can you please add support for website XY?
|
||||
Please address the awesome team at youtube-dl, as they made the downloading-end: [github.com/ytdl-org/youtube-dl/issues](https://github.com/ytdl-org/youtube-dl/issues)
|
||||
Please address the awesome team at youtube-dl, as they made the downloading-end: [github.com/ytdl-org/youtube-dl/issues](https://github.com/ytdl-org/youtube-dl/issues).
|
||||
The downloader tubio uses ([yt-dlp](https://github.com/yt-dlp/yt-dlp/)) is based on youtube-dl.
|
||||
|
||||
## Important notice!
|
||||
I do NOT endorse illegal downloads in any way, shape, or form. Tubio is a tool to download media from legal sources! Use Tubio at your own discretion! Neither do i provide ANY warranty in ANY way, shape, or form!
|
||||
|
||||
## License
|
||||
Tubio is distributed under the GNU General Public License v3.0.
|
||||
Please read the [license file](https://github.com/Leonetienne/Tubio/blob/master/license.txt).
|
||||
Please read the [license file](https://github.com/Leonetienne/Tubio/blob/master/license.txt).
|
||||
|
Loading…
x
Reference in New Issue
Block a user