diff options
author | James Taylor <user234683@users.noreply.github.com> | 2018-12-31 03:14:21 -0800 |
---|---|---|
committer | James Taylor <user234683@users.noreply.github.com> | 2018-12-31 03:14:21 -0800 |
commit | eda81412f65ff74629e553f55c99e45a18181601 (patch) | |
tree | d3659a65a169aa49c1fa162ae44d638f179c36d4 | |
parent | b70e3bf6ddb2a3a7389e18e416d0540119d169e8 (diff) | |
download | yt-local-eda81412f65ff74629e553f55c99e45a18181601.tar.lz yt-local-eda81412f65ff74629e553f55c99e45a18181601.tar.xz yt-local-eda81412f65ff74629e553f55c99e45a18181601.zip |
Updated README
-rw-r--r-- | README.md | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -1,7 +1,7 @@ # youtube-local ![screenshot](https://user-images.githubusercontent.com/28744867/42791028-dabb709a-8922-11e8-935b-6680541e08e4.png) -youtube-local is a browser-based client written in Python for watching Youtube anonymously and without the lag of Polymer (the javascript Youtube uses). One of the primary features is that all requests are routed through Tor, except for the video file at googlevideo.com. This is analogous to what HookTube does, except that you do not have to trust a third-party to respect your privacy. The assumption here is that Google won't put the effort in to incorporate the video file requests into their survelliance systems, as it's not worth pursuing the incredibly small number of users who care about privacy. Using Tor is optional; when not routing through Tor, video pages load *faster* than they do with Youtube's Polymer (for me atleast). +youtube-local is a browser-based client written in Python for watching Youtube anonymously and without the lag of the javascript-heavy page used by Youtube. One of the primary features is that all requests are routed through Tor, except for the video file at googlevideo.com. This is analogous to what HookTube does, except that you do not have to trust a third-party to respect your privacy. The assumption here is that Google won't put the effort in to incorporate the video file requests into their survelliance systems, as it's not worth pursuing the incredibly small number of users who care about privacy. Using Tor is optional; when not routing through Tor, video pages load *faster* than they do with Youtube's laggy javascript page (for me atleast). The Youtube API is not used, so no keys or anything are needed. It uses the same requests as the Youtube webpage. No javascript is used either. @@ -11,7 +11,7 @@ Additionally, playlists can be created, and these are stored locally on your com ### Windows -Download the zip file under the Releases page. Unzip it anywhere you choose, it's completely portable. No registry changes or whatnot are made. +Download the zip file under the Releases page. Unzip it anywhere you choose. ### Linux/MacOS @@ -25,13 +25,13 @@ Download the tarball under the Releases page and extract it. ## Usage -On windows, open run.bat. On Linux/MacOS, run `python3 server.py`. -**Note**: On Linux/MacOS, you may need root in order for it to listen for http connections on port 80 (as it is an http server that listens only for connections from your machine). This is not recommended, as this program isn't safe from exploits which can coerce it to run arbitrary code as root. Instead, you should change `port_number = 80` in settings.txt to a port higher than 1024 (such as 8080). See [here](https://serverfault.com/questions/112795/how-to-run-a-server-on-port-80-as-a-normal-user-on-linux) for more information. You'll also need to use that port number when accessing the webpage from the browser. +Firstly, if you wish to run this in portable mode, create the empty file "settings.txt" in the program's main directory. If the file is there, settings and data will be stored in the same directory as the program. Otherwise, settings and data will be stored in `C:\Users\[your username]\.youtube-local` on Windows and `~/.youtube-local` on Linux/MacOS. The settings file will be filled with the default settings when the program is first run (provided the file is empty). -Access youtube URLs by prefixing them with `localhost/`, For instance, `http://localhost/https://www.youtube.com/watch?v=vBgulDeV2RU` -You can use an addon such as [Redirector](https://addons.mozilla.org/en-US/firefox/addon/redirector/) to automatically redirect Youtube URLs to youtube-local. I use the include pattern `^(https?://(?:[a-zA-Z0-9_-]*\.)?(?:youtube\.com|youtu\.be)/.*)` and the redirect pattern `http://localhost/$1`. I also exlude `^https?://(?:[a-zA-Z0-9_-]*\.)?youtube\.com/feed/subscriptions` for subscriptions. +To run the program on windows, open run.bat. On Linux/MacOS, run `python3 server.py`. -Local playlists are found at http://localhost/youtube.com/playlists + +Access youtube URLs by prefixing them with `localhost:8080/`, For instance, `http://localhost:8080/https://www.youtube.com/watch?v=vBgulDeV2RU` +You can use an addon such as [Redirector](https://addons.mozilla.org/en-US/firefox/addon/redirector/) to automatically redirect Youtube URLs to youtube-local. I use the include pattern `^(https?://(?:[a-zA-Z0-9_-]*\.)?(?:youtube\.com|youtu\.be)/.*)` and the redirect pattern `http://localhost:8080/$1`. I also exclude `^https?://(?:[a-zA-Z0-9_-]*\.)?youtube\.com/feed/subscriptions` for subscriptions. youtube-local can be added as a search engine in firefox to make searching more convenient. See [here](https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox) for information on firefox search plugins. @@ -40,14 +40,14 @@ youtube-local can be added as a search engine in firefox to make searching more Change `route_tor = False` to `route_tor = True` in settings.txt to enable Tor routing. If settings.txt doesn't exist yet, run the program and it will be created with the default settings. -Ensure tor is listening for Socks5 connections on port 9050 (a simple way to accomplish this is by opening the Tor Browser Bundle and leaving it open). Your connections should now be routed through Tor. +Ensure tor is listening for Socks5 connections on port 9150 (a simple way to accomplish this is by opening the Tor Browser Bundle and leaving it open). Your connections should now be routed through Tor. ## Planned Features - Options for saving playlists - Settings - Subscriptions -- Posting comments +- ~~Posting comments~~ done - And others I couldn't think of when making this list Pull requests and issues are welcome @@ -67,7 +67,7 @@ Permission is hereby granted to the youtube-dl project at https://github.com/rg3 - [NewPipe](https://newpipe.schabi.org/) (app for android) - [mps-youtube](https://github.com/mps-youtube/mps-youtube) (terminal-only program) - [youtube-viewer](https://github.com/trizen/youtube-viewer) -- [FreeTube](https://github.com/FreeTubeApp/FreeTube) +- [FreeTube](https://github.com/FreeTubeApp/FreeTube) (almost the same as this project, but is an electron app outside the browser) - [smtube](https://www.smtube.org/) - [Minitube](https://flavio.tordini.org/minitube), [github here](https://github.com/flaviotordini/minitube) - [toogles](https://github.com/mikecrittenden/toogles) (only embeds videos, doesn't use mp4) |