koel/docs/usage/remote-controller.md

33 lines
955 B
Markdown
Raw Normal View History

2024-03-17 18:28:39 +00:00
# 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](https://dashboard.pusher.com/accounts/sign_up) 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.
:::
2024-07-17 09:28:30 +00:00
The remote controller will scan for an active Koel instance.
2024-03-17 18:28:39 +00:00
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.
<img loading="lazy" src="../assets/img/remote.jpg" alt="Remote controller" class="rounded-3xl" style="width: 375px" />