Ytmous Save

Anonymous Youtube Proxy

Project README

ytmous

Anonymous Youtube Proxy

Search, Click, and watch

ytmous is an lightweight, and Anonymous Youtube Proxy. Designed for device with limited resource.

There's no tracker and ads

Only with a simple UI, ready for you to watch some videos in a second

Free and Open source

ytmous is licensed under BSD 3 Clause and it's code is free. You can also host your own ytmous server. It's easy!

Customizeable

ytmous server owner could customize the frontend to what they would like. See Customizing Frontend

DISCLAIMER: ytmous could fetch, stream or download videos from YouTube, even copyrighted ones. Please respect all copyright laws.

Screenshots

ytmous_homepage.png ytmous_mobile_search.png ytmous_mobile_channel.png ytmous_mobile_playlists.png ytmous_mobile_watch.png ytmous_desktop_watch.png

Server Requirement

  • Node v16+ is advised.
  • Fast server network connection with ability to reach YouTube

Configuration

The code is reading the provided configuration from Environment Variable that comes from your system. These variable is optional.

  • GEOLOCATION: YouTube Geolocation. Default is US.
  • USER_AGENT: This variable is where we fake our user agent to request youtube.
  • DLCHUNKSIZE: Download Chunk Size. Default is 10 MB (1024 * 1024 * 10)
  • NO_CLUSTERS: Do not run ytmous with clusters. Useful for debugging
  • CLUSTERS: Number of clusters to fork. By default is depending on os.availableParallelism() integer or os.cpus().length.
  • PORT: Server port to listen to.

Customizing frontend

You can customize your frontend by creating local directory to replace files from views or public directory.

  • local/views/ for backend rendering (views)
  • local/public/ for static page (public)
local
├── public
│   ├── Ubuntu-R.ttf
│   ├── css
│   │   ├── Toard.css
│   │   └── style.css
│   ├── index.html
│   └── robots.txt
└── views
    ├── channel.ejs
    ├── comments.ejs
    ├── error.ejs
    ├── playlist.ejs
    ├── search.ejs
    └── watch.ejs

Starting the server

If this is your first time running this server, You may need to install it's dependencies first by executing npm install.

Then, you can start the server by executing:

npm start

or

PORT=3000 npm start

API endpoints

You can use ytmous API endpoints for your applications. The following endpoints are supported:

/api/search

Endpoint to search videos.

Queries

  • q (String) (Required) String to search with.

  • page (Number) Next page listing.

/api/getPlaylistInfo/[playlistID]

Endpoint to list videos from playlist / channel.

Parameters

  • playlistID (Required) String of Playlist or Channel ID.

/api/getVideoInfo/[videoID]

Endpoint to give information of an YouTube video.

Parameters

  • videoID (Required) String of YouTube video ID

/api/getComments/[videoID]

Parameters

  • videoID (Required) String of YouTube video ID.

Queries

  • continuation (String) Continuation ID of an Comments. Used to fetch the next comment section.

  • replyToken (String) Reply token. Used to view an reply of a comment. To view continuation of an Reply comments, Put continuationID in replyToken query instead of continuation.

Open Source Agenda is not affiliated with "Ytmous" Project. README Source: ytmous/ytmous

Open Source Agenda Badge

Open Source Agenda Rating