Skip to content

Provides a simple way of implementing a jukebox running from nodejs and youtube

License

Notifications You must be signed in to change notification settings

rtm516/YoutubeJukebox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Youtube jukebox

Known Vulnerabilities
This project provides a simple way of implementing a jukebox running from nodejs and youtube.

Libraries

Node modules

Setup

Download the repository and extract if in a zip, then run. npm install This will install all the required modules. If you would like to use the supplied batch file to make the server reboot automatically then run either npm install nodemon or npm install -g nodemon to install it globally

Config

  • port
    • The port to run the webserver on
    • Type: integer
    • Default: 3000
  • youtubeAPIKey
    • Your API key for the youtube API.
    • Can be obtained from here and this API needs to be enabled.
    • Type: string
    • Default: 'youtube api key here'
  • defaultPlaylist
    • The default playlist to play if there is no songs queued. If it is set to '' then it will be disabled.
    • Type: string
    • Default: 'PLx0sYbCqOb8Q_CLZC2BdBSKEEB59BOPUM' (UK Top 40 Songs)
  • defaultRandomOrder
    • True if you want the default playlists songs to be played in a random order.
    • Type: boolean
    • Default: true
  • playerControls
    • Should the youtube player controls be shown.
    • Type: boolean
    • Default: false
  • playerLockedHosts
    • Should the player page be restricted to certain connection domains.
    • EG: jukebox.yoursite.com would be denied but if navigated to localhost then it would be accepted.
    • Type: boolean
    • Default: true
  • playerLockedHostsList
    • Domain list for above setting.
    • Type: string array
    • Default: ["localhost", "127.0.0.1"]

Links

About

Provides a simple way of implementing a jukebox running from nodejs and youtube

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published