Files
otunes/README.md
T
joshuafhiggins Verified 1cea1fe745 feat(docker): bundle Convex backend with oTunes
- Run the web app and Convex backend in one container with generated per-install keys
- Derive Convex URLs from the server address and update self-hosting docs
2026-10-08 15:24:00 -04:00

97 lines
2.6 KiB
Markdown

# oTunes
Your music, my music, _**our**_ music. Self-hosted music streaming app and server.
## Monorepo
This project uses [pnpm workspaces](https://pnpm.io/workspaces):
| Package | Path | Description |
| --- | --- | --- |
| `@otunes/web` | `apps/web` | Next.js web app |
| `@otunes/mobile` | `apps/mobile` | Expo React Native mobile app |
| `@otunes/convex` | `packages/convex` | Shared Convex backend and client types |
### Development
Install dependencies from the repository root:
```bash
pnpm install
```
Run the web app:
```bash
pnpm dev
# or
pnpm dev:web
```
Run the mobile app:
```bash
pnpm dev:mobile
```
Run the Convex backend (from the shared package):
```bash
pnpm dev:convex
```
Point the dev deployment at your music folder (it defaults to `/data`):
```bash
cd packages/convex && npx convex env set DATA "/path/to/Music"
```
Other commands:
```bash
pnpm build # build web app
pnpm lint # lint all packages
pnpm typecheck # typecheck all packages
pnpm format # format with Prettier
```
## Hosting with Docker
The image runs both the web app and its Convex backend, so there is nothing to configure. Here's an example `docker-compose.yml`:
```yaml
name: music
services:
otunes:
image: git.abunchofknowitalls.com/joshuafhiggins/otunes:latest
ports:
- "3000:3000" # web app
- "3210:3210" # Convex
volumes:
- ./otunes-data:/convex/data
- /SomeAttachedStorage/Music:/data
stop_grace_period: 10s
restart: unless-stopped
```
Change `/SomeAttachedStorage/Music` to the folder containing your `lossless`, `normal`, and `atmos` libraries, then run `docker compose up -d`. The first account you create becomes the admin.
On first boot the container generates its own Convex instance secret and sign-in keys and stores them in `./otunes-data`, so no two installs share secrets. Back up that folder: it holds your database and keys.
### Reverse proxy
The web app finds Convex from the address you open it at:
| You open | Convex is expected at |
| --- | --- |
| `https://music.example.com` | `https://convex.music.example.com` |
| `http://192.168.1.5:3000` or `http://localhost:3000` | port `3210` on the same host |
So for a domain, point `music.example.com` at port `3000` and `convex.music.example.com` at port `3210` (WebSockets must be allowed). The mobile app uses the same convention.
If Convex has to live somewhere else, set `PUBLIC_CONVEX_URL` on the container to its public URL.
## Downloads
Check the releases tab for the latest downloads for apps: [Releases](https://git.abunchofknowitalls.com/joshuafhiggins/otunes/releases)