plexsonic 0.1.0

package/.env.example

@@ -0,0 +1,16 @@
+PORT=3127
+BIND_HOST=127.0.0.1
+# Optional public URL override for callback generation.
+# Leave empty to derive from incoming request headers.
+BASE_URL=
+SQLITE_PATH=./data/app.db
+SESSION_SECRET=change-this-session-secret-before-production
+# 32-byte key in hex or base64 for Plex token encryption.
+TOKEN_ENC_KEY=
+PLEX_PRODUCT=Plexsonic Bridge
+# Stable client identifier recommended for Plex PIN flow.
+PLEX_CLIENT_IDENTIFIER=
+LICENSE_EMAIL=
+PLEX_INSECURE_TLS=0
+LOG_LEVEL=warn
+LOG_REQUESTS=0

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Yukino Song, SudoMaker Ltd.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright JS Foundation and other contributors, http://js.foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,192 @@
+# Plexsonic
+
+Plexsonic is a local bridge that exposes a Plex music library through Subsonic/OpenSubsonic-compatible endpoints.
+
+It provides:
+- Local account signup/login
+- Plex account linking via Plex PIN
+- Plex server and music library selection
+- Subsonic-compatible `/rest/*.view` API for clients
+- Web test page for manual API checks
+- Playback/scrobble/rating/playlist actions mapped to Plex
+
+To support this project, please subscribe to my [Patreon](https://www.patreon.com/ClassicOldSong).
+
+[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3DClassicOldsong%26type%3Dpatrons&style=for-the-badge)](https://patreon.com/ClassicOldsong)
+
+## Requirements
+
+- Node.js 18+ (Node 20 recommended)
+- `pnpm`
+- A reachable Plex Media Server with a music library
+- A Plex account with access to that server
+
+## Install
+
+```bash
+pnpm install
+cp .env.example .env
+```
+
+### Global CLI install
+
+Install globally from this repo:
+
+```bash
+pnpm add -g .
+```
+
+Then run:
+
+```bash
+plexsonic
+```
+
+## Configuration
+
+Edit `.env`:
+
+```env
+PORT=3127
+BIND_HOST=127.0.0.1
+BASE_URL=
+SQLITE_PATH=./data/app.db
+SESSION_SECRET=replace-with-a-long-random-secret
+TOKEN_ENC_KEY=
+PLEX_PRODUCT=Plexsonic Bridge
+PLEX_CLIENT_IDENTIFIER=
+LICENSE_EMAIL=
+PLEX_INSECURE_TLS=0
+LOG_LEVEL=warn
+LOG_REQUESTS=0
+```
+
+### Important env vars
+
+- `PORT`: HTTP port (default `3127`).
+- `BIND_HOST`: listen interface (`127.0.0.1` local only, `0.0.0.0` for LAN).
+- `BASE_URL`: optional public URL override used for callback generation. If empty, origin is derived from request headers.
+- `SESSION_SECRET`: cookie/session signing secret. Keep stable across restarts.
+- `TOKEN_ENC_KEY`: optional but recommended 32-byte key (hex or base64) used to encrypt stored Plex tokens.
+- `LOG_LEVEL`: logger level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`).
+- `LOG_REQUESTS`: set to `1` to enable incoming request logs. Very verbose, and can expose your login credeitial. (`0` by default).
+
+Generate secrets (examples):
+
+```bash
+# SESSION_SECRET
+openssl rand -hex 32
+
+# TOKEN_ENC_KEY (hex)
+openssl rand -hex 32
+```
+
+## Run
+
+```bash
+pnpm start
+```
+
+Or, if installed globally:
+
+```bash
+plexsonic
+```
+
+Dev mode:
+
+```bash
+pnpm dev
+```
+
+## Docker
+
+Build and run with Compose:
+
+```bash
+docker compose up -d --build
+```
+
+Notes:
+- Compose maps `3127:3127`.
+- `./data` is mounted to `/app/data` for SQLite persistence.
+- `docker-compose.yml` uses `${VAR:-default}` interpolation.
+- You should change at least:
+  - `SESSION_SECRET`
+  - `TOKEN_ENC_KEY` (recommended)
+  - `BASE_URL` only if auto-detected origin is wrong in your proxy/network setup
+
+Override via CLI (without editing compose):
+
+```bash
+SESSION_SECRET='replace-me' \
+TOKEN_ENC_KEY='your-32-byte-key' \
+BASE_URL='http://192.168.1.50:3127' \
+docker compose up -d --build
+```
+
+Or with an env file:
+
+```bash
+docker compose --env-file .env up -d --build
+```
+
+Stop:
+
+```bash
+docker compose down
+```
+
+Health check:
+
+```bash
+curl http://127.0.0.1:3127/health
+```
+
+## Web Setup Flow
+
+1. Open `http://127.0.0.1:3127/signup`
+2. Create a local Plexsonic account
+3. Link Plex (`/link/plex`) and complete PIN auth
+4. Select Plex server
+5. Select music library
+6. Open `/test` to run quick API checks
+
+## Using From Subsonic/OpenSubsonic Clients
+
+Use:
+- Server URL: `http://<host>:3127`
+- Username/password: your local Plexsonic account
+
+### Endpoint suffix compatibility
+
+Both endpoint styles are accepted:
+- `/rest/getArtists.view`
+- `/rest/getArtists`
+
+## Expose to LAN
+
+Set:
+
+```env
+BIND_HOST=0.0.0.0
+# Optional when auto-detection is not correct:
+# BASE_URL=http://<your-lan-ip>:3127
+```
+
+Then:
+- Open firewall inbound TCP `3127`
+- Keep it LAN-only (do not expose directly to the internet)
+
+If you run behind a reverse proxy, forward `X-Forwarded-Proto` and `X-Forwarded-Host` so Plex PIN callbacks use the correct public origin.
+
+Without HTTPS, credentials travel unencrypted on your network.
+
+## Notes
+
+- This project currently targets practical client compatibility over strict parity with any single server implementation.
+- Some Subsonic features may be partially implemented or client-dependent.
+
+## License
+
+Apache-2.0

package/bin/plexsonic.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+/* Copyright Yukino Song, SudoMaker Ltd.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import '../src/index.js';

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "plexsonic",
+  "version": "0.1.0",
+  "description": "PlexMusic to OpenSubsonic bridge",
+  "main": "./src/index.js",
+  "bin": {
+    "plexsonic": "./bin/plexsonic.js"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "README.md",
+    "LICENSE",
+    ".env.example"
+  ],
+  "type": "module",
+  "scripts": {
+    "dev": "node --watch src/index.js",
+    "start": "node src/index.js"
+  },
+  "dependencies": {
+    "@fastify/cookie": "^11.0.2",
+    "@fastify/formbody": "^8.0.2",
+    "@fastify/session": "^11.1.0",
+    "argon2": "^0.41.1",
+    "better-sqlite3": "^11.7.2",
+    "dotenv": "^16.6.1",
+    "fastify": "^5.1.0",
+    "pino-pretty": "^13.1.3"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "argon2",
+      "better-sqlite3"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ClassicOldSong/Plexsonic.git"
+  },
+  "author": "Yukino Song <yukino@sudomaker.com>",
+  "license": "Apache-2.0",
+  "bugs": "https://github.com/ClassicOldSong/Plexsonic/issues",
+  "homepage": "https://github.com/ClassicOldSong/Plexsonic"
+}

package/src/config.js

@@ -0,0 +1,96 @@
+/* Copyright Yukino Song, SudoMaker Ltd.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import 'dotenv/config';
+import { createHash } from 'node:crypto';
+import path from 'node:path';
+
+const DEFAULT_PORT = 3127;
+const DEFAULT_HOST = '127.0.0.1';
+const DEFAULT_PLEX_PRODUCT = 'Plexsonic Bridge';
+const DEFAULT_SESSION_SECRET = 'dev-session-secret-change-me-before-production-plexsonic';
+const DEFAULT_LOG_LEVEL = 'warn';
+const DEFAULT_LOG_REQUESTS = false;
+
+function parsePort(rawPort) {
+  const value = Number.parseInt(rawPort ?? `${DEFAULT_PORT}`, 10);
+  if (!Number.isInteger(value) || value < 1 || value > 65535) {
+    throw new Error(`Invalid PORT: ${rawPort}`);
+  }
+  return value;
+}
+
+function deriveClientIdentifier(seed) {
+  return createHash('sha256').update(seed).digest('hex').slice(0, 32);
+}
+
+function normalizeSessionSecret(rawSecret) {
+  const secret = rawSecret || DEFAULT_SESSION_SECRET;
+  if (secret.length >= 32) {
+    return secret;
+  }
+  return createHash('sha256').update(secret).digest('hex');
+}
+
+function parseBoolean(value, fallback = false) {
+  if (value == null || value === '') {
+    return fallback;
+  }
+  const normalized = String(value).trim().toLowerCase();
+  return ['1', 'true', 'yes', 'on'].includes(normalized);
+}
+
+function normalizeOptionalBaseUrl(rawBaseUrl) {
+  const value = String(rawBaseUrl || '').trim();
+  if (!value) {
+    return null;
+  }
+  try {
+    const parsed = new URL(value);
+    const normalizedPath = parsed.pathname.replace(/\/+$/, '');
+    const pathname = normalizedPath && normalizedPath !== '/' ? normalizedPath : '';
+    return `${parsed.protocol}//${parsed.host}${pathname}`;
+  } catch {
+    throw new Error(`Invalid BASE_URL: ${rawBaseUrl}`);
+  }
+}
+
+export function loadConfig(env = process.env) {
+  const port = parsePort(env.PORT);
+  const bindHost = env.BIND_HOST || DEFAULT_HOST;
+  const baseUrl = normalizeOptionalBaseUrl(env.BASE_URL);
+  const sqlitePath = env.SQLITE_PATH || './data/app.db';
+
+  return {
+    bindHost,
+    baseUrl,
+    port,
+    sqlitePath,
+    sessionSecret: normalizeSessionSecret(env.SESSION_SECRET),
+    tokenEncKey: env.TOKEN_ENC_KEY || null,
+    plexInsecureTls: env.PLEX_INSECURE_TLS === '1',
+    plexProduct: env.PLEX_PRODUCT || DEFAULT_PLEX_PRODUCT,
+    plexClientIdentifier:
+      env.PLEX_CLIENT_IDENTIFIER || deriveClientIdentifier(path.resolve(sqlitePath)),
+    licenseEmail: env.LICENSE_EMAIL || '',
+    logLevel: env.LOG_LEVEL || DEFAULT_LOG_LEVEL,
+    logRequests: parseBoolean(env.LOG_REQUESTS, DEFAULT_LOG_REQUESTS),
+  };
+}