From d9ca7beaa9494cf34590853901cf8be44e243775 Mon Sep 17 00:00:00 2001 From: RblSb Date: Thu, 16 Jan 2025 03:07:31 +0300 Subject: Cache on server feature Server will download video from supported players and add as raw video to playlist (only youtube is supported for now). Cache for YT player is available after installing optional dependencies, see readme. For cache size see `cacheStorageLimitGiB ` in config. There is also minor ux improvement, latest checkbox states will be keeped in local storage now. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1266ed7..f3f9725 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Default channel example: https://synctube.onrender.com/ ### Setup - Open `4200` port in your router settings (port is customizable) -- `npm install ws` in this project folder ([NodeJS 14+](https://nodejs.org) required) +- `npm ci` in this project folder ([NodeJS 14+](https://nodejs.org) required) - Run `node build/server.js` - Open showed "Local" link for yourself and send "Global" link to friends @@ -42,6 +42,14 @@ or - (Docker container hides real local/global ips, so you need to checkout it manually) + +### Optional dependencies +If you want to enable `Cache on server` feature for Youtube player, you can also run: +```shell +npm i @distube/ytdl-core@latest +``` +And install `ffmpeg` on your server system. Default cache size is 3.0 GiB. + ### Configuration It's just works, but you can also check [user/ folder](/user/README.md) for server settings and additional customization. -- cgit v1.2.3