Mirrors/koel
2
0
Fork 0
mirror of https://github.com/koel/koel synced 2024-12-30 06:23:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
koel/docs/usage/remote-controller.md
Phan An 1bb61ce09b docs: merge docs repo
2024-07-06 17:44:48 +02:00

956 B
Raw Blame History

Remote Controller

Koel has a built-in remote controller that lets you control a desktop instance.

Configuration

In order for the remote controller to work, register for a Pusher account and create an app. Then, populate the app's credentials into .env:

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=

Finally, reload your Koel instance to apply the changes.

Usage

You can access the remote controller by visiting https://<your-koel-domain>/remote.

:::tip You can pin the remote controller to your phone's home screen for quick access. :::

The remote controller will scan for an active Koel instance. If found, it will connect to it and allow you to control the playback as well as like/unlike the current song and adjust the volume.

Remote controller