QueueCube/README.md

# QueueCube

QueueCube is a web frontend for [mpv](https://github.com/mpv-player/mpv).

It allows you to remotely manage mpv's playqueue as well as the ability to search YouTube via a locally running [Invidious](https://github.com/iv-org/invidious) instance. 

## iOS TestFlight releases

Gitea Actions builds and uploads the iOS app when a version tag is pushed. The
workflow accepts the repository's existing numeric tags (for example `3.2`),
`v3.2`, and `release/ios/v3.2`; it can also be started manually.

Configure these Gitea Actions secrets before the first run:

- `APP_STORE_CONNECT_KEY_ID`
- `APP_STORE_CONNECT_ISSUER_ID`
- `APP_STORE_CONNECT_KEY_CONTENT`
- `MATCH_GIT_URL`
- `MATCH_PASSWORD`
- `MATCH_GIT_BASIC_AUTHORIZATION`

For local Fastlane use, copy `.env.example` to `.env` and fill in the same
values. Run `bundle exec fastlane ios setup_signing` only when the match signing
assets need to be created or updated. `bundle exec fastlane ios build` creates
a signed IPA without uploading it, while `bundle exec fastlane ios beta`
performs the release.

![queuecube user interface](screenshots/queuecube.png)

## Running 

The easiest way to run QueueCube is by using Docker. An MPV instance is created in the Docker container, so all you have to do is make it so the MPV instance can access your host's soundcard. On Linux, this is accomplished by mapping the PulseAudio socket to the container:

```
volumes:
    - ~/.config/pulse/cookie:/root/.config/pulse/cookie
    - /var/run/user/1000/pulse:/var/run/pulse
```

### Building the Docker image

```
docker build -t queuecube:latest .
```

If not using docker-compose, create an instance of the container by using `docker create` using the volume mapping specified above for mapping the PulseAudio socket:

```
docker create -p 8080:3000 -v /run/user/1000/pulse:/var/run/pulse -v ~/.config/pulse/cookie:/root/.config/pulse/cookie --name queuecube queuecube:latest
```

On some systems, you may need to add `--security-opt seccomp=unconfined` to allow containerized processes to write to your host's PulseAudio socket. 

Once running, you should be able to access the UI via http://localhost:8080. 

### Video

QueueCube supports video as well. Just set the environment variable `ENABLE_VIDEO=1`. 

When video is enabled, QueueCube starts a managed `mpv` process. The process
fullscreens by default; set `MPV_FULLSCREEN=0` to leave sizing and placement to
your window manager. These optional environment variables are also passed to
`mpv`:

| Environment variable | mpv option |
| --- | --- |
| `MPV_WAYLAND_APP_ID` | `--wayland-app-id=...` |
| `MPV_TITLE` | `--title=...` |
| `MPV_BORDER` | `--border=...` |
| `MPV_ONTOP=1` | `--ontop` |
| `MPV_YTDL_FORMAT` | `--ytdl-format=...` |

For less common options, `MPV_EXTRA_ARGS` can contain additional shell-style
arguments that will be appended to the generated `mpv` command line.

#### Video + Docker

When running in a Docker container, there are a few extra steps needed to make this work. 

First, make sure you're passing in `/dev/dri` as a volume in the container. Since mpd is capable of rendering directly to the GPU, this would be the most performant. 

```
volumes:
    - /dev/dri:/dev/dri
```

as well as the X11 socket:

```
    - /tmp/.X11-unix:/tmp/.X11-unix
```

In order to be able to interact with the X session from the Docker container, you may also need to explicitly allow connections to the host via:

```
$ xhost +local:
```

Since the container will also need to be able to access the GPU device, it may be required to run the container in "privileged" mode:

```
privileged: true
```

(or `--privileged`). 

On Podman rootless, it seems to be enough to just run it with the "unconfined" security profile (`seccomp=unconfined`).