Parson could not start
+The local server did not become available.
+
-
-
- 
-
ParsonLabs Music is the Self Hosted Audio streaming alternative to YouTube Music, Spotify & Apple Music, providing Unrestricted Access to your library in Uncompressed, Lossless Quality
- - - - - - - - - - - - - - - - - - - - - - - - -## Get Started - -### Docker - -#### Docker Run -```sh -docker run -d \ - --name parsonlabs-music \ - -p 1993:1993 \ - -p 7700:7700 \ - -v "/path/to/config:/ParsonLabsMusic" \ - -v "/path/to/music:/music" \ - -e JWT_SECRET=your_auth_secret_here \ - --restart unless-stopped \ - ghcr.io/willkirkmanm/music -``` - -#### Docker Compose -```yaml -services: - music-server: - image: ghcr.io/willkirkmanm/music - container_name: parsonlabs-music - ports: - - "1993:1993" - - "7700:7700" - volumes: - - "/path/to/config:/ParsonLabsMusic" - - "/path/to/music:/music" - environment: - - JWT_SECRET=your_auth_secret_here - restart: unless-stopped -``` - -### Download Precompiled Binaries - -You can download the precompiled binaries from the [releases page](https://github.com/WillKirkmanM/music/releases). - -- [Windows (x86_64)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-x86_64-pc-windows-gnu.zip) -- [Linux (x86_64)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-x86_64-unknown-linux-gnu.tar.gz) -- [Linux (x86_64 MUSL)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-x86_64-unknown-linux-musl.tar.gz) -- [Linux (ARMv7 gnueabihf)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-armv7-unknown-linux-gnueabihf.tar.gz) -- [Linux (ARMv7 MUSL)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-armv7-unknown-linux-musleabihf.tar.gz) -- [Linux (ARM gnueabihf)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-arm-unknown-linux-gnueabihf.tar.gz) -- [Linux (ARM MUSL)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-arm-unknown-linux-musleabihf.tar.gz) -- [Linux (ARM64)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-aarch64-unknown-linux-gnu.tar.gz) -- [Linux (ARM64 MUSL)](https://github.com/WillKirkmanM/music/releases/download/v1.2.0-alpha/music-server-aarch64-unknown-linux-musl.tar.gz) - -### Compile From Source - -### One Liner -``` -git clone https://github.com/WillKirkmanM/music && cd music && OS=$(uname -s) && if [ "$OS" = "Linux" ]; then if [ -f /etc/debian_version ]; then sudo apt-get update && sudo apt-get install -y --no-install-recommends sqlite3 libsqlite3-dev wget make build-essential pkg-config libssl-dev unzip && wget https://www.nasm.us/pub/nasm/releasebuilds/2.16/nasm-2.16.tar.gz && tar xzf nasm-2.16.tar.gz && cd nasm-2.16 && ./configure && make && sudo make install && cd .. && rm -rf nasm-2.16 nasm-2.16.tar.gz && sudo apt-get install -y libssl1.1 && rm -rf /var/lib/apt/lists/* && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn; elif [ -f /etc/arch-release ]; then sudo pacman -Syu --noconfirm sqlite wget make base-devel pkgconf openssl nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn; elif [ -f /etc/fedora-release ]; then sudo dnf install -y sqlite sqlite-devel wget make gcc gcc-c++ kernel-devel pkgconf-pkg-config openssl-devel nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn; elif [ -f /etc/gentoo-release ]; then sudo emerge --sync && sudo emerge --ask sqlite wget make gcc pkgconfig openssl nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn; else echo "Unsupported Linux distribution" && exit 1; fi; else echo "Unsupported OS" && exit 1; fi && bun run build --filter music && cargo build --package music-server --release && cargo run --package music-server --release -``` - -### Clone the Repository -``` -git clone https://github.com/WillKirkmanM/music -``` - -### Install Dependencies -#### Ubuntu -``` -sudo apt-get update && apt-get install -y --no-install-recommends sqlite3 libsqlite3-dev wget make build-essential pkg-config libssl-dev unzip && wget https://www.nasm.us/pub/nasm/releasebuilds/2.16/nasm-2.16.tar.gz && tar xzf nasm-2.16.tar.gz && cd nasm-2.16 && ./configure && make && make install && cd .. && rm -rf nasm-2.16 nasm-2.16.tar.gz && apt-get install -y libssl1.1 && rm -rf /var/lib/apt/lists/* && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn -``` -#### Arch Linux -``` -sudo pacman -Syu --noconfirm sqlite wget make base-devel pkgconf openssl nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn -``` -#### Fedora -``` -sudo dnf install -y sqlite sqlite-devel wget make gcc gcc-c++ kernel-devel pkgconf-pkg-config openssl-devel nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn -``` - -#### Gentoo -``` -sudo emerge --sync && sudo emerge --ask sqlite wget make gcc pkgconfig openssl nasm unzip && curl -fsSL https://bun.sh/install | bash && export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH" && bun install --global yarn -``` - -### Build the Website -``` -bun run build --filter music -``` -### Build the Server -``` -cargo build --package music-server --release -``` - -> [!TIP] -> The authentication is handled by [JWT Tokens](https://jwt.io/)), they require a special `JWT_SECRET` in order to safely protect your accounts against third parties. -> It is reccommended to `cp .env.example .env` and edit the `JWT_SECRET=` value to something secret, alternatively, you can use openssl to generate a random secret: `openssl rand -base64 48`. - -### Run ParsonLabs Music -``` -cargo run --package music-server --release -p 1993 -``` - -> [!NOTE] -> **Done! 🥳**. -> Head to [http://localhost:1993/](http://localhost:1993/) and setup your music library. - -## Documentation -Any additional troubleshooting information can be found in the Documentation https://docs.parsonlabs.com. + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..45b7c015 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,18 @@ +# Security policy + +## Supported versions + +Security fixes are provided for the latest 1.0.x release. + +## Deployment boundary + +Plain HTTP and automatic discovery are intended for trusted local networks. +Use an HTTPS reverse proxy and set `PARSON_PUBLIC_URL` for internet access. A +remote first-account registration requires the setup code printed by the server; +localhost setup does not. Keep the `/Parson` data directory and server logs +private because they contain authentication material and the temporary setup +code. + +## Reporting a vulnerability + +Please report vulnerabilities privately through GitHub Security Advisories for this repository. Do not open a public issue with exploit details. Include affected versions, reproduction steps, impact, and any proposed mitigation. You should receive an acknowledgement within seven days. diff --git a/apps/desktop/README.md b/apps/desktop/README.md new file mode 100644 index 00000000..d912fa54 --- /dev/null +++ b/apps/desktop/README.md @@ -0,0 +1,27 @@ +# Parson desktop client + +Electron client for Linux and Windows. + +## Development + +```powershell +bun --filter parson-music-desktop desktop:dev +``` + +## Packaging + +```powershell +bun --filter parson-music-desktop desktop:build +``` + +Linux package check: + +```bash +./apps/desktop/scripts/verify-linux-package.sh +``` + +Windows release: + +```powershell +.\apps\desktop\scripts\package-windows.ps1 -Version 1.0.0 +``` diff --git a/apps/desktop/electron/main.cjs b/apps/desktop/electron/main.cjs new file mode 100644 index 00000000..8cf68c90 --- /dev/null +++ b/apps/desktop/electron/main.cjs @@ -0,0 +1,219 @@ +const { + app, + BrowserWindow, + dialog, + ipcMain, + Menu, + shell, +} = require("electron"); +const { spawn } = require("node:child_process"); +const fs = require("node:fs"); +const path = require("node:path"); + +const PORT = 1993; +const ORIGIN = `http://127.0.0.1:${PORT}`; +const STARTUP_POLL_MS = 10; +let backend = null; +let mainWindow = null; +let quitting = false; + +const primary = app.requestSingleInstanceLock(); +if (!primary) { + app.quit(); +} else { + app.on("second-instance", () => showMainWindow()); +} + +function showMainWindow() { + if (!mainWindow || mainWindow.isDestroyed()) return; + if (mainWindow.isMinimized()) mainWindow.restore(); + mainWindow.show(); + mainWindow.focus(); +} + +function backendExecutable() { + const executable = `parson-music-server${process.platform === "win32" ? ".exe" : ""}`; + if (app.isPackaged) return path.join(process.resourcesPath, executable); + return path.join(__dirname, "bin", executable); +} + +function rotateBackendLog(logPath) { + try { + if (fs.statSync(logPath).size <= 2 * 1024 * 1024) return; + fs.renameSync(logPath, `${logPath}.previous`); + } catch (error) { + if (error?.code !== "ENOENT") + console.error("Could not rotate backend log", error); + } +} + +async function isParsonReady() { + try { + const response = await fetch(`${ORIGIN}/.well-known/parson`, { + signal: AbortSignal.timeout(750), + cache: "no-store", + }); + if (!response.ok) return false; + const manifest = await response.json(); + return ( + manifest.protocol === "parson" && manifest.product === "parson-music" + ); + } catch { + return false; + } +} + +async function startBackend() { + if (await isParsonReady()) return; + const executable = backendExecutable(); + if (!fs.existsSync(executable)) { + throw new Error(`The packaged Parson backend is missing: ${executable}`); + } + const logsDirectory = app.getPath("logs"); + fs.mkdirSync(logsDirectory, { recursive: true }); + const logPath = path.join(logsDirectory, "backend.log"); + rotateBackendLog(logPath); + const log = fs.openSync(logPath, "a"); + backend = spawn(executable, [], { + cwd: path.dirname(executable), + env: { + ...process.env, + PARSON_BIND_ADDRESS: "0.0.0.0", + PARSON_PORT: String(PORT), + PARSON_PUBLIC_URL: ORIGIN, + }, + stdio: ["ignore", log, log], + }); + fs.closeSync(log); + backend.once("exit", (code, signal) => { + backend = null; + if (!quitting && !mainWindow?.isDestroyed()) { + void mainWindow.loadFile(path.join(__dirname, "startup-error.html"), { + query: { detail: `Backend stopped (${code ?? signal ?? "unknown"}).` }, + }); + } + }); + const deadline = Date.now() + 30_000; + while (Date.now() < deadline) { + if (await isParsonReady()) return; + if (!backend) throw new Error("The Parson backend stopped during startup."); + await new Promise((resolve) => setTimeout(resolve, STARTUP_POLL_MS)); + } + throw new Error("The Parson backend did not become ready within 30 seconds."); +} + +function installDesktopBridge() { + ipcMain.handle("parson:window-control", (event, action) => { + const window = BrowserWindow.fromWebContents(event.sender); + if (!window || window.isDestroyed()) return false; + switch (action) { + case "minimize": + window.minimize(); + return true; + case "toggle-maximize": + if (window.isMaximized()) window.unmaximize(); + else window.maximize(); + return window.isMaximized(); + case "is-maximized": + return window.isMaximized(); + case "close": + window.close(); + return true; + default: + throw new Error(`Unknown window control: ${action}`); + } + }); + + ipcMain.handle("parson:invoke", async (event, command, args = {}) => { + if (new URL(event.senderFrame.url).origin !== ORIGIN) { + throw new Error( + "Desktop commands are only available to the local Parson app.", + ); + } + switch (command) { + case "platform": + return process.platform === "win32" ? "windows" : "linux"; + case "select_music_folder": { + const selection = await dialog.showOpenDialog(mainWindow, { + properties: ["openDirectory", "createDirectory"], + title: "Choose your music folder", + }); + return selection.canceled ? null : (selection.filePaths[0] ?? null); + } + case "show_track_in_file_manager": { + const target = typeof args.path === "string" ? args.path : ""; + if (!target || !fs.existsSync(target)) + throw new Error("A valid track path is required."); + shell.showItemInFolder(target); + return true; + } + default: + throw new Error(`Unknown desktop command: ${command}`); + } + }); +} + +async function createWindow() { + mainWindow = new BrowserWindow({ + width: 1280, + height: 820, + minWidth: 900, + minHeight: 600, + show: true, + backgroundColor: "#000000", + autoHideMenuBar: true, + frame: false, + title: "Parson", + icon: app.isPackaged + ? path.join(process.resourcesPath, "parson.png") + : path.join(__dirname, "../../web/public/icons/icon-512.png"), + webPreferences: { + contextIsolation: true, + nodeIntegration: false, + sandbox: true, + preload: path.join(__dirname, "preload.cjs"), + }, + }); + const publishMaximizedState = () => { + if (!mainWindow?.isDestroyed()) { + mainWindow.webContents.send("parson:maximized", mainWindow.isMaximized()); + } + }; + mainWindow.on("maximize", publishMaximizedState); + mainWindow.on("unmaximize", publishMaximizedState); + mainWindow.maximize(); + mainWindow.webContents.setWindowOpenHandler(({ url }) => { + if (url.startsWith("http://") || url.startsWith("https://")) + void shell.openExternal(url); + return { action: "deny" }; + }); + mainWindow.webContents.on("will-navigate", (event, url) => { + if (url.startsWith(ORIGIN) || url.startsWith("file:")) return; + event.preventDefault(); + }); + await mainWindow.loadFile(path.join(__dirname, "startup.html")); + try { + await startBackend(); + await mainWindow.loadURL(ORIGIN); + } catch (error) { + await mainWindow.loadFile(path.join(__dirname, "startup-error.html"), { + query: { detail: error instanceof Error ? error.message : String(error) }, + }); + } +} + +if (primary) { + app.whenReady().then(async () => { + app.setName("Parson"); + Menu.setApplicationMenu(null); + app.setAsDefaultProtocolClient("parson"); + installDesktopBridge(); + await createWindow(); + }); +} + +app.on("window-all-closed", () => app.quit()); +app.on("before-quit", () => { + quitting = true; + if (backend && !backend.killed) backend.kill("SIGTERM"); +}); diff --git a/apps/desktop/electron/preload.cjs b/apps/desktop/electron/preload.cjs new file mode 100644 index 00000000..05368107 --- /dev/null +++ b/apps/desktop/electron/preload.cjs @@ -0,0 +1,20 @@ +const { contextBridge, ipcRenderer } = require("electron"); + +contextBridge.exposeInMainWorld("__PARSON_ELECTRON__", { + invoke(command, args) { + return ipcRenderer.invoke("parson:invoke", command, args); + }, + windowControls: { + close: () => ipcRenderer.invoke("parson:window-control", "close"), + isMaximized: () => + ipcRenderer.invoke("parson:window-control", "is-maximized"), + minimize: () => ipcRenderer.invoke("parson:window-control", "minimize"), + toggleMaximize: () => + ipcRenderer.invoke("parson:window-control", "toggle-maximize"), + watchMaximized: (callback) => { + ipcRenderer.on("parson:maximized", (_event, maximized) => + callback(Boolean(maximized)), + ); + }, + }, +}); diff --git a/apps/desktop/electron/startup-error.html b/apps/desktop/electron/startup-error.html new file mode 100644 index 00000000..2cf561ba --- /dev/null +++ b/apps/desktop/electron/startup-error.html @@ -0,0 +1,89 @@ + + + + + +The local server did not become available.
+
-
-
- 
- 
- 
- 
- - {children} -
- -