koel/core

The core components and assets of Koel

koel

Intro

Koel (also stylized as koel, with a lowercase k) is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side. Targeting web developers, Koel embraces some of the more modern web technologies to do its job.

Install and Upgrade Guide

For system requirements, installation/upgrade guides, troubleshooting etc., head over to the Official Documentation.

Development

See the Development Guide.

Koel Player

Koel Player is the official mobile app for Koel, which supports both iOS and Android without the limitations of the mobile web version. For more information on the project, visit its repository.

Backers

Support me on OpenCollective with a monthly donation and help me continue building Koel.

Sponsors

GitHub Sponsors

• You?

OpenCollective

Become a sponsor on OpenCollective and get your logo on our README on Github with a link to your site.

core's Issues

Improve tests for stores

Current tests for stores rely on a data blob. They should be rewritten to use factoria models instead.

• album.js
• artist.js
• equalizer.js
• favorite.js
• index.js
• playlist.js
• preference.js
• queue.js
• recentlyPlayed.js
• setting.js
• shared.js
• song.js
• user.js

Trying to get in touch regarding a security issue

Hi there,

I couldn't find a SECURITY.md in your repository and am not sure how to best contact you privately to disclose a security issue.

Can you add a SECURITY.md file with an e-mail to your repository, so that our system can send you the vulnerability details? GitHub suggests that a security policy is the best way to make sure security issues are responsibly disclosed.

Once you've done that, you should receive an e-mail within the next hour with more info.

Thanks! (cc @huntr-helper)

Playback partially broken in mobile chrome

The playback on phones with mobile chrome can break if you reload the page while in playback.
Steps to reproduce are:

• Start playback in mobile chrome
• Reload page

In that state it is also not possible to start a playback without reloading the page again.

After some research this is due to new autoplay policy in chrome versions since april.

Write tests for services

Because the test coverage for services currently looks quite pathetic.

• services/info/album
• services/info/artist
• services/info/song
• services/download
• services/ls
• services/playback
• services/socket
• services/youtube

Set a Default Gravatar

Currently the default Gravatar is the blue G logo. We can pass a URL to the d parameter and customize the logo.
https://en.gravatar.com/site/implement/images/

This could either be the Koel logo or a mystery person logo. It should be a square that is 256x256

Let me know your thoughts and I'll get it setup

Albums not reactive with 3.7.2

When I did testings with version 3.7.2 of Koel and changed the compilation state of songs, I discovered, that the album section of of the Vue app was not updated correctly. It looks like albumStore.all is not reactive. When old albums are removed from the store and replaced with new ones, the Vue components are not destroyed and replaced with new ones.

core/js/components/screens/album-list.vue

Line 54 in de29c0b

[event.$names.KOEL_READY]: () => (this.albums = albumStore.all),

Mobile app

Hello,
I'm trying to build an android app from this using Quasar Framework but I can't seem to find the .env file so I can change the host that the app should connect to.

Can't load song

koel version 4.4.0

• url is wrong, should be api/${song.id}/play/1/128
• server accepts jwt-token but you use api-token
  

  core/js/stores/song.ts

  Lines 200 to 205 in 31adae0

  	getSourceUrl: (song: Song): string => {
  	if (isMobile.any && preferenceStore.transcodeOnMobile) {
  	return `${sharedStore.state.cdnUrl}play/${song.id}/1/128?api_token=${auth.getToken()}`
  	}
  	return `${sharedStore.state.cdnUrl}play/${song.id}?api_token=${auth.getToken()}`
  	},