Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f61988597a | ||
|
|
6e1cdba58c | ||
|
|
df4bb27d3a | ||
|
|
de7707b45a | ||
|
|
c884b4776c | ||
|
|
0893b62f3b | ||
|
|
7d071c763d | ||
|
|
664395a0ee | ||
|
|
007d553d59 | ||
|
|
7c8c185c4c | ||
|
|
972eccd0bf | ||
|
|
034cfe7a8e | ||
|
|
7a8cf7c004 | ||
|
|
30cdc9f553 | ||
|
|
3f19abb899 | ||
|
|
a601757759 | ||
|
|
fe03bcd651 | ||
|
|
1f319cb9f6 | ||
|
|
a0ac0f8e46 | ||
|
|
06945fda52 | ||
|
|
306c4c858e | ||
|
|
81885632a0 | ||
|
|
23467481c1 | ||
|
|
e716de2160 | ||
|
|
dda06a0873 | ||
|
|
eca64d68e7 | ||
|
|
1065643b23 | ||
|
|
d92153f85f | ||
|
|
22d76c459a | ||
|
|
ec87ab96d6 | ||
|
|
f62fe270fb | ||
|
|
677474beed | ||
|
|
cb9dd0fbc5 | ||
|
|
0685d4b06d | ||
|
|
82c0a4faec | ||
|
|
ccbd5e304a | ||
|
|
4f81a192fa | ||
|
|
22cf95e58c | ||
|
|
358355c612 | ||
|
|
c5f9600047 | ||
|
|
703731e654 | ||
|
|
0dfa4c7aad | ||
|
|
68e473ec02 | ||
|
|
a8d20734aa | ||
|
|
ebdb76cf6c | ||
|
|
e62e1ac2dd | ||
|
|
e68b46f647 | ||
|
|
7605cd3f1d | ||
|
|
2735c283ce | ||
|
|
0daaec81ca | ||
|
|
2085df4406 | ||
|
|
9b8664d3a3 | ||
|
|
e027a33e8d | ||
|
|
f04a19d34d | ||
|
|
4b27671a91 | ||
|
|
5f4943e025 | ||
|
|
66cdb94d57 | ||
|
|
5ebb0e6a9c | ||
|
|
dfb7f43c00 | ||
|
|
ed85d35117 | ||
|
|
7d69e77ac6 | ||
|
|
03973d215b | ||
|
|
1b182d89cd | ||
|
|
3d5c2c7450 | ||
|
|
d6264dd994 | ||
|
|
4c18123207 | ||
|
|
71e7f41ea5 | ||
|
|
60cf5d1019 | ||
|
|
3977057dfa | ||
|
|
943bdc3e88 | ||
|
|
44710048f4 | ||
|
|
9f9f5655b1 | ||
|
|
e621811364 | ||
|
|
685bc846e8 | ||
|
|
3a9d58fae9 | ||
|
|
33639c6e4c | ||
|
|
7c235e3179 | ||
|
|
559d749207 | ||
|
|
53feae0f8c | ||
|
|
0941ccc0ac | ||
|
|
82ecd96ba4 | ||
|
|
e118dc5db1 | ||
|
|
1a23491ac2 | ||
|
|
d916f167a5 | ||
|
|
0102249549 | ||
|
|
2ca96dab42 | ||
|
|
345e60b7a3 | ||
|
|
b9fb6c9d35 | ||
|
|
5d0ccd8867 | ||
|
|
b36f484f3b | ||
|
|
d2f7f986c7 | ||
|
|
9137d03b9f | ||
|
|
f6c0d13a8b | ||
|
|
c472b4e33a | ||
|
|
f6c3fc6b50 | ||
|
|
8ba146495e | ||
|
|
68c46fefb2 | ||
|
|
eddda41559 | ||
|
|
5945fdc2ef | ||
|
|
d110dcbdcf | ||
|
|
ebc0aa8a4e | ||
|
|
d4113b464a | ||
|
|
753dfe1fb3 | ||
|
|
013cccaac5 | ||
|
|
504f8ffbeb | ||
|
|
81d1eb2553 | ||
|
|
c9327b0e92 | ||
|
|
36aa236d82 | ||
|
|
3c37aa4449 | ||
|
|
f1bf3cbe64 | ||
|
|
17a9356040 | ||
|
|
97c799bf2c | ||
|
|
99c02daec7 | ||
|
|
4cb792641d | ||
|
|
fbc2950854 | ||
|
|
08e0bdb437 | ||
|
|
73dcab4de1 | ||
|
|
00594a14ed | ||
|
|
52d5bab0f5 | ||
|
|
a41f4c56f7 | ||
|
|
8ea83962d6 | ||
|
|
9d97cc6e4c | ||
|
|
023579de9a | ||
|
|
214d99f1c3 | ||
|
|
d6fc6b9b10 | ||
|
|
cbdab93f92 | ||
|
|
abf37f0687 | ||
|
|
e993a43399 | ||
|
|
bc79969fd0 | ||
|
|
801f9ed403 | ||
|
|
3d9f6f8f58 | ||
|
|
c2676fb620 | ||
|
|
cdb4ab23e9 | ||
|
|
b3217f2d9c | ||
|
|
7b61385ad5 | ||
|
|
b5c86e74ad | ||
|
|
a3031a7eb9 | ||
|
|
7c49a0535f | ||
|
|
797e5b0794 | ||
|
|
bc6cd78c86 | ||
|
|
98a5b40be5 | ||
|
|
87c174fe0f | ||
|
|
0cbb45e4ad | ||
|
|
b11226af94 | ||
|
|
27dc5b5e19 | ||
|
|
d892b83110 | ||
|
|
c28984524a | ||
|
|
5d4fb63baa | ||
|
|
ca2574d1e5 | ||
|
|
758038e278 | ||
|
|
cb803b1a24 | ||
|
|
c985af5722 | ||
|
|
1ede54acbb | ||
|
|
a73ca6a95d | ||
|
|
25f4095276 | ||
|
|
d242c133dd | ||
|
|
da3e8044b7 | ||
|
|
b6d5939fbf | ||
|
|
d23ef88647 | ||
|
|
f374f130de | ||
|
|
b0c2c8611b | ||
|
|
6f6f56ce64 | ||
|
|
4b28ec4b3a | ||
|
|
d189084c15 | ||
|
|
975d9540bc | ||
|
|
212bfba950 | ||
|
|
619e32cd83 | ||
|
|
ce9ff53ae1 | ||
|
|
d13fb33884 | ||
|
|
253e91250f | ||
|
|
b23668372b | ||
|
|
5b847c136e | ||
|
|
0d304a793d | ||
|
|
906e1a1a19 | ||
|
|
87f46f1e02 | ||
|
|
56b4be1fe1 | ||
|
|
a08dcf05f1 | ||
|
|
460882f6c1 | ||
|
|
71fc94ba63 | ||
|
|
b587d834bc | ||
|
|
9b63e022ed | ||
|
|
324cbd76ee | ||
|
|
ceab13f672 | ||
|
|
10e17ed239 | ||
|
|
4f84479513 | ||
|
|
216ad4ed32 | ||
|
|
85e4555322 | ||
|
|
a90e443a88 | ||
|
|
a9c54b5f91 | ||
|
|
6d21435aab | ||
|
|
9c3bb11a66 | ||
|
|
d983080584 | ||
|
|
852b96009c | ||
|
|
c82617d857 | ||
|
|
6f19256187 | ||
|
|
479ede334b | ||
|
|
e1349255de | ||
|
|
4a600dc01d | ||
|
|
315256ce96 | ||
|
|
bbead20723 | ||
|
|
bb77c1c0bb | ||
|
|
2a2fb9ad55 | ||
|
|
ea5b66cdae | ||
|
|
1a978c7ee3 | ||
|
|
cfd458f463 | ||
|
|
61b8277822 | ||
|
|
53c8036e34 | ||
|
|
f5c8ce5109 | ||
|
|
17b11f19a3 | ||
|
|
2993279d78 | ||
|
|
b95b7e3781 | ||
|
|
c57200132e | ||
|
|
f6d9921581 | ||
|
|
3aada673d5 | ||
|
|
1456070044 | ||
|
|
883797a51d | ||
|
|
1b93512b0a | ||
|
|
7c99262a79 | ||
|
|
d10ecb88bb | ||
|
|
bb0f8e1a9a |
@@ -1,7 +1,7 @@
|
||||
version: '3.7'
|
||||
services:
|
||||
# Update this to the name of the service you want to work with in your docker-compose.yml file
|
||||
app:
|
||||
multi-scrobbler:
|
||||
# Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
|
||||
# folder. Note that the path of the Dockerfile and context is relative to the *primary*
|
||||
# docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
|
||||
|
||||
@@ -5,9 +5,11 @@
|
||||
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
|
||||
"dockerComposeFile": [
|
||||
"compose.yml"
|
||||
// uncomment to add kasm/discord service
|
||||
//"../deploy/docker-compose.discord.yml"
|
||||
],
|
||||
|
||||
"service": "app",
|
||||
"service": "multi-scrobbler",
|
||||
|
||||
"workspaceFolder": "/workspaces",
|
||||
|
||||
|
||||
@@ -27,4 +27,7 @@ build
|
||||
.vscode
|
||||
**/act/*
|
||||
tmp-*
|
||||
.env
|
||||
.env
|
||||
*.env
|
||||
.storybook
|
||||
.stories
|
||||
@@ -73,6 +73,7 @@ web_modules/
|
||||
# dotenv environment variables file
|
||||
.env
|
||||
.env.test
|
||||
*.env
|
||||
|
||||
# parcel-bundler cache (https://parceljs.org/)
|
||||
.cache
|
||||
@@ -133,6 +134,7 @@ src/backend/common/schema/*.json
|
||||
!src/backend/common/schema/aio.json
|
||||
!src/backend/common/schema/client.json
|
||||
!src/backend/common/schema/source.json
|
||||
docsite/static/schemas/*.json
|
||||
|
||||
|
||||
*.bak
|
||||
@@ -146,3 +148,6 @@ build
|
||||
**/generated-sources.*
|
||||
.github/act/out
|
||||
tmp-*
|
||||
|
||||
*storybook.log
|
||||
storybook-static
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
import { defineMain } from "@storybook/react-vite/node";
|
||||
import { mergeConfig } from "vite";
|
||||
|
||||
|
||||
export default defineMain({
|
||||
"stories": [
|
||||
"../src/**/*.mdx",
|
||||
"../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"
|
||||
],
|
||||
"addons": [
|
||||
"@chromatic-com/storybook",
|
||||
"@storybook/addon-vitest",
|
||||
"@storybook/addon-a11y",
|
||||
"@storybook/addon-docs",
|
||||
"@storybook/addon-onboarding"
|
||||
],
|
||||
features: {
|
||||
// https://github.com/storybookjs/storybook/discussions/33279
|
||||
sidebarOnboardingChecklist: false,
|
||||
},
|
||||
"framework": "@storybook/react-vite",
|
||||
viteFinal: async (config) => {
|
||||
return mergeConfig(config, {
|
||||
optimizeDeps: {
|
||||
include: ["@storybook/addon-docs"],
|
||||
},
|
||||
plugins: [
|
||||
{
|
||||
name: "fix-mdx-react-shim",
|
||||
enforce: "pre",
|
||||
resolveId(source: any) {
|
||||
if (
|
||||
source.startsWith("file://") &&
|
||||
source.includes("mdx-react-shim.js")
|
||||
) {
|
||||
// Convert file:///... path to normal filesystem path for Vite
|
||||
return new URL(source).pathname;
|
||||
}
|
||||
return null;
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,6 @@
|
||||
import { addons } from 'storybook/manager-api';
|
||||
import { themes } from 'storybook/theming';
|
||||
|
||||
addons.setConfig({
|
||||
theme: themes.dark,
|
||||
});
|
||||
@@ -0,0 +1,28 @@
|
||||
import addonDocs from "@storybook/addon-docs";
|
||||
import addonA11y from "@storybook/addon-a11y";
|
||||
import { definePreview } from "@storybook/react-vite";
|
||||
|
||||
import { themes } from 'storybook/theming';
|
||||
|
||||
export default definePreview({
|
||||
parameters: {
|
||||
controls: {
|
||||
matchers: {
|
||||
color: /(background|color)$/i,
|
||||
date: /Date$/i,
|
||||
},
|
||||
},
|
||||
|
||||
a11y: {
|
||||
// 'todo' - show a11y violations in the test UI only
|
||||
// 'error' - fail CI on a11y violations
|
||||
// 'off' - skip a11y checks entirely
|
||||
test: 'todo'
|
||||
},
|
||||
docs: {
|
||||
theme: themes.dark,
|
||||
},
|
||||
},
|
||||
|
||||
addons: [addonA11y(), addonDocs()]
|
||||
});
|
||||
@@ -4,7 +4,8 @@
|
||||
"mochaExplorer.exit": true,
|
||||
"search.exclude": {
|
||||
"**/.docusaurus": true,
|
||||
"**/build": true
|
||||
"**/build": true,
|
||||
"**/schema": true
|
||||
},
|
||||
"tailwindCSS.files.exclude": [
|
||||
"docsite/**"
|
||||
|
||||
@@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
coc@foxxmd.dev.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
@@ -30,6 +30,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a
|
||||
* [MPD (Music Player Daemon)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpd)
|
||||
* [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpris)
|
||||
* [Musikcube](https://foxxmd.github.io/multi-scrobbler/configuration/sources/musikcube)
|
||||
* [Music Assistant](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-endpoint#music-assistant)
|
||||
* [Plex](https://foxxmd.github.io/multi-scrobbler/configuration/sources/plex)
|
||||
* [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/sources/rocksky-source)
|
||||
* [Sonos](https://foxxmd.github.io/multi-scrobbler/configuration/sources/sonos)
|
||||
@@ -41,6 +42,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a
|
||||
* [Yamaha MusicCast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/yamaha-musiccast)
|
||||
* [Youtube Music](https://foxxmd.github.io/multi-scrobbler/configuration/sources/youtube-music)
|
||||
* Supports scrobbling to many [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients)
|
||||
* [Discord](https://foxxmd.github.io/multi-scrobbler/configuration/clients/discord) (Now Playing)
|
||||
* [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/clients/koito)
|
||||
* [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/lastfm)
|
||||
* [Libre.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/librefm)
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
* Attribution for [`default-artwork.png`](/assets/default-artwork.png): https://www.flaticon.com/free-icon/music_15795471
|
||||
|
After Width: | Height: | Size: 1.5 KiB |
|
After Width: | Height: | Size: 4.2 KiB |
@@ -0,0 +1,11 @@
|
||||
[
|
||||
{
|
||||
"name": "MS",
|
||||
"enable": true,
|
||||
"data": {
|
||||
"applicationId": "8190211179716453570",
|
||||
"ipcLocations": ["192.168.0.105:6655"]
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
[
|
||||
{
|
||||
"name": "MS",
|
||||
"enable": true,
|
||||
"data": {
|
||||
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
|
||||
"applicationId": "8190211179716453570"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
"librariesBlock": ["BadMusic"],
|
||||
"additionalAllowedLibraryTypes": ["musicvideos"],
|
||||
"allowMediaTypes": ["audio"],
|
||||
"frontendUrlOverride": "https://myJellyfinExternal.tld"
|
||||
},
|
||||
"options": {
|
||||
"logPayload": true,
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
services:
|
||||
multi-scrobbler:
|
||||
volumes:
|
||||
- kasm_run:/run
|
||||
kasmcord:
|
||||
container_name: kasmcord
|
||||
image: kasmweb/discord:1.14.0
|
||||
ports:
|
||||
# VNC port to use in web browser
|
||||
- 6901:6901
|
||||
shm_size: 512m
|
||||
environment:
|
||||
# set a password for VNC access
|
||||
VNC_PW: ${KASM_PW:-hunter2}
|
||||
XDG_RUNTIME_DIR: /run/user/1000
|
||||
volumes:
|
||||
- kasm_run:/run/user/1000
|
||||
- kasm_config:/home/kasm-user/.config
|
||||
user: "0"
|
||||
entrypoint: sh -c "chmod 700 /run/user/1000 && chown -R kasm-user:kasm-user /run/user/1000 && chown -R kasm-user:kasm-user /home/kasm-user/.config && su kasm-user -c '/dockerstartup/kasm_default_profile.sh /dockerstartup/vnc_startup.sh /dockerstartup/kasm_startup.sh'"
|
||||
|
||||
volumes:
|
||||
kasm_run:
|
||||
name: kasm_run
|
||||
kasm_config:
|
||||
name: kasm_config
|
||||
@@ -60,6 +60,21 @@ If multi-scrobbler is not running on the same machine your browser is on then th
|
||||
|
||||
EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`
|
||||
|
||||
### I get errors with `ECONNRESET` `ETIMEDOUT` `ENOTFOUND` `EAI_AGAIN`
|
||||
|
||||
These are errors indicating a network issue is occuring between you and the Source/Client.
|
||||
|
||||
* `ECONNRESET` means the upstream service unexpectedly closed the connection
|
||||
* `ETIMEDOUT` means the upstream service did not respond to a request MS
|
||||
* `ENOTFOUND` means that MS could not find a DNS record for the domain of the upstream service
|
||||
* `EAI_AGAIN` means that a DNS server did not respond to MS's request to lookup the record for a domain
|
||||
|
||||
`ECONNRESET` and timeout issues can occur when you have a poor connection or if the upstream service is overloaded or is generally not behaving well. This is a common occurrence for Listenbrainz/Musicbrainz related requests.
|
||||
|
||||
Please check the [Upstream Services Status Page](https://status.multi-scrobbler.app) to independently verify if the service is misbehaving. If the service is up and has good uptime then the issue may be in your network.
|
||||
|
||||
`ENOTFOUND` and `EAI_AGAIN` and generally caused by DNS caching (stale records) or misbehaving DNS servers. Though this can happen at the upstream service's end, it is *usually* an issue in your network. If you run a Pihole, AdGaurd, or other DNS solution try flushing the cache for the mishaving domain and check that your DNS application is working correctly.
|
||||
|
||||
### Youtube Music fails after some time
|
||||
|
||||
If you see errors in multi-scrobbler for YTM that contain **401** or **403** like
|
||||
@@ -70,7 +85,7 @@ Error: Could not send the specified request to browse. Status code: 401
|
||||
|
||||
then YTM has invalidated your authentication.
|
||||
|
||||
First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#authentication) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
|
||||
First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#ytm-auth) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
|
||||
|
||||
#### When using OAuth Client Authentication
|
||||
|
||||
@@ -80,7 +95,7 @@ Refresh your authentication by using the **(Re)authenticate** link from MS's web
|
||||
|
||||
The library MS uses relies on scraping the YTM site by using cookies from your actual browser to pretend it is a browser. It does its best to keep these up to date but since this is not an official way to access the service YTM may invalidate your access _to the authenticated session_ at any time. How this is triggered is unknown and not something multi-scrobbler can control. You can help limit the chance of your session being invalidated by [getting the cookie from an Incognito/Private Session](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2504032666) and then immediately closing the browser afterwards.
|
||||
|
||||
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#authentication) and then restart MS to potentially resolve the problem.
|
||||
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#ytm-auth) and then restart MS to potentially resolve the problem.
|
||||
|
||||
## Configuration Issues
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ A **Client** is an application that stores the historical information about what
|
||||
|
||||
| Name | Now Playing |
|
||||
| :-------------------------------------------------- | :---------- |
|
||||
| [Discord](/configuration/clients/discord) | ✅ |
|
||||
| [Last.fm](/configuration/clients/lastfm) | ✅ |
|
||||
| [Libre.fm](/configuration/clients/librefm) | ✅ |
|
||||
| [Listenbrainz](/configuration/clients/listenbrainz) | ✅ |
|
||||
@@ -22,6 +23,71 @@ A **Client** is an application that stores the historical information about what
|
||||
|
||||
## Features
|
||||
|
||||
### Duplicate Detection
|
||||
|
||||
Before a Play is scrobbled to a client MS checks existing scrobbles from the Client's API to see if the Play has already been scrobbled.
|
||||
|
||||
For each Play, MS fetches (cached) scrobbles from the Client in a time range inclusive of the Play's listening timestamp and then scores existing scrobbles against the Play based on:
|
||||
|
||||
* Similarity of Title, Artists, and Album
|
||||
* Temporal closeness of the Play's timestamp to the existing scrobble's timestamp
|
||||
* Whether MS detected the Play as a repeat (applicable to Sources that report realtime Player data)
|
||||
|
||||
Detailed scoring breakdowns against each existing scrobble are logged at the `TRACE` level.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Detailed Explanation</summary>
|
||||
|
||||
A **candidate** (to be scrobbled) Play is first transformed using the configured [`compare.candidate` Hook](/configuration/transforms/#hook), if any exists.
|
||||
|
||||
Next, MS checks (up to) the last 100 scrobbles *in-memory* scrobbles that it has made. These are *not* from the Client but the actual scrobbles MS made while it has been running. The data from these scrobbles is much richer than what is usually parsed from the Client which makes it easier to detect duplicates from.
|
||||
|
||||
If no in-memory scrobble matches then MS starts comparing the candidate against historical scrobbles fetched from an inclusive time range of the candidate's timestamp.
|
||||
|
||||
<h3>Matching Title/Artist/Album</h3>
|
||||
|
||||
For these string-based values MS uses an [token-order-invariant](https://github.com/FoxxMD/multi-scrobbler/blob/0dfa4c7aad6df98e13aee6d395827665c2414adb/src/backend/utils/StringUtils.ts#L299) method that scores string similarity based on a (token count) weighted average of two [similarity](https://foxxmd.github.io/string-sameness/#md:strategies) algorithms, [Levenshtien Distance](https://en.wikipedia.org/wiki/Levenshtein_distance) and [Dice's Coefficient](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient). The weighted average ensures that very long strings (Track titles) are scored with a confidence proportional to their length.
|
||||
|
||||
<h3>Matching Timestamp</h3>
|
||||
|
||||
Timestamps are scored on how temporally close they are. There are four possible scores with decreasing value:
|
||||
|
||||
* **Exact** - Timestamps are within 1 second of each other
|
||||
* **Close** - Timestamps are within `threshold` seconds of each other
|
||||
* This is determined by the smallest update interval of Source
|
||||
* Some Sources (subsonic) only update every 60 seconds so this is the smallest "close" value possible. Most are 10 seconds. Signified by `(Needed <10s)` in the breakdown example below.
|
||||
* **Fuzzy** - One timestamp is within `threshold` seconds of the *end* of the other timestamp
|
||||
* Sources can set the scrobble timestamp at different times. Some do it when the track is started listening to, some when it ends, some when the *player* stops.
|
||||
* Where possible, MS knows and keeps track of when this timestamp *should* be, for each Source. If it's not possible then Fuzzy may be allowed.
|
||||
* **None** - There is no correlation between timestamps
|
||||
|
||||
<h3>Scoring and Breakdows</h3>
|
||||
|
||||
A candidate Play must score >= 1 to be detected as a duplicate of an existing scrobble.
|
||||
|
||||
Each score and a breakdown of the scores for its individual components can be see at the `TRACE` logging level or in the [debug data](/help#copy-play-debug-data) for a scrobble. An example:
|
||||
|
||||
```
|
||||
* Artist: 0.06 * 0.3 = 0.02
|
||||
* Title: 0.04 * 0.4 = 0.02
|
||||
* Time: (Exact) 1 * 0.5 = 0.50
|
||||
* Existing: 19:13:33-04:00 - Candidate: 19:13:33-04:00
|
||||
* Temporal Sameness: Exact
|
||||
* Play Diff: 0s (Needed <10s)
|
||||
* Range Comparison N/A
|
||||
Score 0.54 => No Match
|
||||
```
|
||||
|
||||
In each component equation, the first number is the similarity (or temporal closeness).
|
||||
|
||||
* 0 = no correlation
|
||||
* 1 = exactly the same
|
||||
|
||||
The second number is the *weight* of that component in the final score.
|
||||
|
||||
</details>
|
||||
|
||||
### Dead Scrobbles
|
||||
|
||||
If multi-scrobbler is unable to submit a scrobble to a Client then it places the scrobble into a queue which is retried every 5 minutes for a number of times before it gives up.
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "Discord",
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "configuration/clients/discord/discord"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,566 @@
|
||||
---
|
||||
title: Discord (App)
|
||||
toc_min_heading_level: 2
|
||||
toc_max_heading_level: 5
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import TcpWarning from "@site/src/components/snippets/_discord-port-warn.mdx";
|
||||
import JsonConfig from '!!raw-loader!@site/../config/discord-local.json.example';
|
||||
|
||||
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
This integration uses an **existing Discord application** to set your Rich Presence.
|
||||
|
||||
:::tip
|
||||
|
||||
Check the [main Discord docs page](/configuration/clients/discord) for a comparison between **App** and **Headless**.
|
||||
|
||||
:::
|
||||
|
||||
## Required Setup
|
||||
|
||||
### Discord Application
|
||||
|
||||
You must create a [Discord App](https://docs.discord.com/developers/quick-start/overview-of-apps) in order to use this integration. Creating an App is free and simple.
|
||||
|
||||
Go to the [Discord Developer Portal](https://discord.com/developers/applications)
|
||||
|
||||
* Click on "New Application" and give it a name
|
||||
* Copy the **Application Id** (Client Id) shown after creation
|
||||
* Add this Id to your Multi-Scrobbler config
|
||||
* Env Config => `DISCORD_APPLICATION_ID=12345678`
|
||||
* File Config => `"applicationId": "12345678"`
|
||||
|
||||
### Discord Connection
|
||||
|
||||
This integration uses an existing, running Discord application to communicate with Discord and set Rich Presence. Multi-scrobbler must be able to communicate with the Discord application, either by being on the same machine or over a network.
|
||||
|
||||
<Tabs groupId="discordType" queryString>
|
||||
|
||||
<TabItem value="container" label="Containerized Discord">
|
||||
|
||||
[Kasm Workspaces](https://kasm.com) provides a self-hostable [Discord container image](https://hub.docker.com/r/kasmweb/discord). This image provides a desktop-like experience, through browser-based VNC, to use the official Discord application.
|
||||
|
||||
<img src={require('/img/discord_kasm.png').default} height="400"/>
|
||||
|
||||
This containerized approach can be used instead of configuring MS to use a [Native Discord](./?discordType=native#discord-connection) application on a specific machine.
|
||||
|
||||
**Advantages**
|
||||
|
||||
* Setup is much simpler
|
||||
* Discord runs in the same stack as multi-scrobbler
|
||||
* **Configuration is copy-paste.** Skip all of the [Discord Connection](#discord-connection) instructions.
|
||||
* Get a [Headless](/configuration/clients/discord/discord-headless)-like experience without needing to break Discord TOS
|
||||
|
||||
**Disadvantages**
|
||||
|
||||
* Image only available for x86 arch
|
||||
* Image and container are large (1GB+)
|
||||
* Discord does not notify *other* clients of notifications in a channel if *any* client is viewing that channel.
|
||||
* To avoid this, make sure your container discord instance is not viewing any server/channel/dm.
|
||||
* Sometimes, Discord does not deliver "notifications you missed" to mobile because this depends on *all* clients being offline.
|
||||
|
||||
<h2>Setup</h2>
|
||||
|
||||
Setup is basically the same as using the instructions for [Discord on Linux](./?osType=linux&discordType=native#find-ipc-connection) with [MS on Same Host (Docker)](./?osType=linux&discordType=native#pass-ipc-to-multi-scrobbler).
|
||||
|
||||
<h3>1. Add Discord Service to Multi-Scrobbler Docker Compose Stack</h3>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Detailed Explanation</summary>
|
||||
|
||||
* Add the `kasmweb/discord` service to your compose stack
|
||||
* Mount the directory containing Discord's unix socket to a named volume
|
||||
* Configure MS to use Discord's unix socket
|
||||
* Mount the unix socket volume into MS's container
|
||||
* Add ENV `DISCORD_IPC_LOCATIONS` to point to the mounted volume
|
||||
|
||||
</details>
|
||||
|
||||
Use this example `docker-compose.yaml` to modify your existing multi-scrobbler `docker-compose.yaml`:
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler:latest
|
||||
environment:
|
||||
# ...
|
||||
- DISCORD_APPLICATION_ID=12345678
|
||||
# add below line
|
||||
// highlight-start
|
||||
- DISCORD_IPC_LOCATIONS=/run/discord-ipc-0
|
||||
// highlight-end
|
||||
volumes:
|
||||
# ...
|
||||
# add below line
|
||||
// highlight-start
|
||||
- kasm_run:/run
|
||||
// highlight-end
|
||||
# ...
|
||||
|
||||
# .. add discord service below
|
||||
// highlight-start
|
||||
kasmcord:
|
||||
container_name: kasmcord
|
||||
image: kasmweb/discord:1.14.0
|
||||
ports:
|
||||
# VNC port to use in web browser
|
||||
- 6901:6901
|
||||
shm_size: 512m
|
||||
environment:
|
||||
# set a password for VNC access
|
||||
VNC_PW: hunter2
|
||||
XDG_RUNTIME_DIR: /run/user/1000
|
||||
volumes:
|
||||
- kasm_run:/run/user/1000
|
||||
- kasm_config:/home/kasm-user/.config
|
||||
user: "0"
|
||||
entrypoint: sh -c "chmod 700 /run/user/1000 && chown -R kasm-user:kasm-user /run/user/1000 && chown -R kasm-user:kasm-user /home/kasm-user/.config && su kasm-user -c '/dockerstartup/kasm_default_profile.sh /dockerstartup/vnc_startup.sh /dockerstartup/kasm_startup.sh'"
|
||||
|
||||
volumes:
|
||||
kasm_run:
|
||||
name: kasm_run
|
||||
kasm_config:
|
||||
name: kasm_config
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
Then re-deploy your stack.
|
||||
|
||||
<h3>2. Login to Discord</h3>
|
||||
|
||||
Navigate in your browser to the IP/host Multi-Scrobbler/Discord are running on. Use the `port` set in the `kasmcord` service:
|
||||
|
||||
```
|
||||
# basic auth login
|
||||
# user: kasm_user
|
||||
# pass is what was set in env VNC_PW
|
||||
https://192.168.MY.HOST:6901
|
||||
```
|
||||
|
||||
Login to Discord normally. After login is complete MS should connect automatically when a Now Playing event happens. If it does not or reports authentication failure then restart MS (but not Discord).
|
||||
|
||||
If MS works then you are done and can move on to [Optional Setup](#optional-setup).
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="native" label="Native Discord">
|
||||
|
||||
Use this method if you want to connect MS to Discord running on a physical desktop.
|
||||
|
||||
<DetailsAdmo type="tip" summary="Local MS Installation Requires No Config">
|
||||
|
||||
If MS was [installed locally](/installation#local-installation) (not Docker) on the same machine as the Discord application then MS should [automatically detect the correct method](#find-ipc-connection) and [use it](#pass-ipc-to-multi-scrobbler) **without** any configuration from you. This will work for **any OS**.
|
||||
|
||||
If MS cannot determine this automatically, follow the steps for your OS below.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
Follow the sections below to configure MS for your specific environment.
|
||||
|
||||
#### Find IPC Connection
|
||||
|
||||
Discord uses OS-specific methods to communicate with other applications on the same host, called [IPC](https://en.wikipedia.org/wiki/Inter-process_communication). You may need to determine some details about the IPC method in order for MS to communicate with it correctly.
|
||||
|
||||
|
||||
<Tabs groupId="osType" queryString>
|
||||
|
||||
<TabItem value="linux" label="Discord on Linux">
|
||||
|
||||
On Linux, Discord uses a [Unix Socket](https://en.wikipedia.org/wiki/Unix_domain_socket) for IPC.
|
||||
|
||||
With Discord running, run this command:
|
||||
|
||||
```
|
||||
$ sudo netstat -apeen | grep discord
|
||||
|
||||
unix 2 [ ACC ] STREAM LISTENING 11026149 1641787/Discord /home/foxx/.var/app/com.discordapp.Discord/cache/scoped_dirnnxNIn/SingletonSocket
|
||||
unix 2 [ ACC ] STREAM LISTENING 11036791 1642030/exe /run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
We see that the path we need is:
|
||||
|
||||
```
|
||||
/run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="macos" label="Discord on MacOS">
|
||||
|
||||
On MacOS, Discord uses a [Unix Socket](https://en.wikipedia.org/wiki/Unix_domain_socket) for IPC.
|
||||
|
||||
With Discord running, run this command:
|
||||
|
||||
```
|
||||
$ sudo netstat -apeen | grep discord
|
||||
|
||||
unix 2 [ ACC ] STREAM LISTENING 11026149 1641787/Discord /home/foxx/.var/app/com.discordapp.Discord/cache/scoped_dirnnxNIn/SingletonSocket
|
||||
unix 2 [ ACC ] STREAM LISTENING 11036791 1642030/exe /run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
We see that the path we need is:
|
||||
|
||||
```
|
||||
/run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="windows" label="Discord on Windows">
|
||||
|
||||
Windows uses [**Named Pipes**](https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipes) for IPC. These aren't easily iteratable without external software, like [Pipetap](https://github.com/sensepost/pipetap).
|
||||
|
||||
The syntax for a named pipe is like this:
|
||||
|
||||
```
|
||||
\\.\pipe\app_named_pipe_foo
|
||||
```
|
||||
|
||||
and Discord's names follow this pattern:
|
||||
|
||||
```
|
||||
\\.\pipe\discord-ipc-0
|
||||
```
|
||||
|
||||
Where `0` increments for each different instance of Discord (official, canary, nightly, etc...).
|
||||
|
||||
The default Discord pipe name is: `discord-ipc-0`
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
#### Pass IPC to Multi-Scrobbler
|
||||
|
||||
After [finding your IPC connection path](#find-ipc-connection) you will need to make it accessible to Multi-Scrobbler.
|
||||
|
||||
<Tabs groupId="osType" queryString>
|
||||
|
||||
<TabItem value="linux" label="Discord on Linux">
|
||||
|
||||
<Tabs groupId="msConnection">
|
||||
|
||||
<TabItem value="remote" label="MS on Different Host">
|
||||
|
||||
<TcpWarning/>
|
||||
|
||||
Use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from Discord's [unix socket](#find-ipc-connection) to a listening TCP port on the same host. Likely, you will want to setup a service to start this command on login.
|
||||
|
||||
```shell
|
||||
$ socat -v TCP-LISTEN:6655,reuseaddr,fork UNIX-CONNECT:/run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
In your MS docker compose file add the `host:port` of the host running Discord/`socat` to `DISCORD_IPC_LOCATIONS` `environment:`
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
environment:
|
||||
# ...
|
||||
DISCORD_IPC_LOCATIONS=192.168.DISCORD_HOST.IP:6655
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="local-docker" label="MS on Same Host (Docker)">
|
||||
|
||||
In your MS docker compose file, pass the path of Discord's [unix socket](#find-ipc-connection) as a volume and add this path to `DISCORD_IPC_LOCATIONS` in `environment:`
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
environment:
|
||||
# ...
|
||||
DISCORD_IPC_LOCATIONS=/run/discord-ipc-0
|
||||
volumes:
|
||||
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="local" label="MS on Same Host (Non-Docker)">
|
||||
|
||||
No configuration is required. If MS does not automatically work for you then try the **MS on Same Host (Docker)** method using the `DISCORD_IPC_LOCATIONS` environment variable.
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="macos" label="Discord on MacOS">
|
||||
|
||||
<Tabs groupId="msConnection">
|
||||
|
||||
<TabItem value="remote" label="MS on Different Host">
|
||||
|
||||
<TcpWarning/>
|
||||
|
||||
Use one of the methods below to setup `socat` on your macOS machine.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>`socat` installed natively</summary>
|
||||
|
||||
Install [`socat`](https://formulae.brew.sh/formula/socat) using homebrew to use it as a native command on your host.
|
||||
|
||||
Then, use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from Discord's [unix socket](#find-ipc-connection) to a listening TCP port on the same host. Likely, you will want to setup a service to start this command on login.
|
||||
|
||||
```shell
|
||||
$ socat -v TCP-LISTEN:6655,reuseaddr,fork UNIX-CONNECT:/run/user/1000/discord-ipc-0
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>`socat` in Docker</summary>
|
||||
|
||||
Use the [`socat` container](https://hub.docker.com/r/alpine/socat) in combination with the Discord [unix socket](#find-ipc-connection) found earlier:
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
services:
|
||||
socat:
|
||||
image: alpine/socat
|
||||
ports:
|
||||
- "6655:6655"
|
||||
volumes:
|
||||
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
|
||||
command:
|
||||
- '-v'
|
||||
- 'TCP-LISTEN:6655,reuseaddr,fork'
|
||||
- 'UNIX-CONNECT:/run/discord-ipc-0'
|
||||
```
|
||||
</details>
|
||||
|
||||
In your MS docker compose file add the `host:port` of the host running Discord/`socat` to `DISCORD_IPC_LOCATIONS` `environment:`
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
environment:
|
||||
# ...
|
||||
DISCORD_IPC_LOCATIONS=192.168.DISCORD_HOST.IP:6655
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="local-docker" label="MS on Same Host (Docker)">
|
||||
|
||||
In your MS docker compose file, pass the path of Discord's [unix socket](#find-ipc-connection) as a volume and add this path to `DISCORD_IPC_LOCATIONS` in `environment:`
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
environment:
|
||||
# ...
|
||||
DISCORD_IPC_LOCATIONS=/discord-ipc-0
|
||||
volumes:
|
||||
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="local" label="MS on Same Host (Non-Docker)">
|
||||
|
||||
No configuration is required. If MS does not automatically work for you then try the **MS on Same Host (Docker)** method using the `DISCORD_IPC_LOCATIONS` environment variable.
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="windows" label="Discord on Windows">
|
||||
|
||||
<Tabs groupId="msConnection">
|
||||
|
||||
<TabItem value="remote" label="MS in Docker">
|
||||
|
||||
:::note
|
||||
|
||||
While it is possible to use [named pipes directly in Docker](https://forums.docker.com/t/volume-mount-path-error/143626/3) this has not been tested and [may only work for windows containers](https://github.com/docker/for-win/issues/6813#issuecomment-632859857). If you are adventurous, try this out and if you can get it working please [report your findings in an issue.](https://github.com/FoxxMD/multi-scrobbler/issues)
|
||||
|
||||
:::
|
||||
|
||||
:::warning
|
||||
|
||||
This method is **experimental** and may be buggy and prone to crashes. If you are a Windows or Rust developer please consider helping improve the [pipe proxy implementation](https://github.com/FoxxMD/named-pipe-to-tcp-proxy).
|
||||
|
||||
:::
|
||||
|
||||
<TcpWarning/>
|
||||
|
||||
Use [**pipeProxy**](https://github.com/FoxxMD/named-pipe-to-tcp-proxy) to connect to the Discord named pipe and expose it on a TCP port.
|
||||
|
||||
Download the latest [`pipeProxy.exe`](https://github.com/FoxxMD/named-pipe-to-tcp-proxy/releases) from the releases page.
|
||||
|
||||
The host/ip should be the IP of the machine running discord.
|
||||
|
||||
Run pipeProxy from the windows command line:
|
||||
|
||||
```
|
||||
pipeProxy.exe --pipe "\\.\pipe\discord-ipc-0" --tcp "192.168.0.100:6655"
|
||||
```
|
||||
|
||||
In your MS docker compose file add the `host:port` of the host running `pipeProxy` to `DISCORD_IPC_LOCATIONS` `environment:`
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
environment:
|
||||
# ...
|
||||
DISCORD_IPC_LOCATIONS=192.168.0.100:6655
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="local" label="MS on Same Host (Non-Docker)">
|
||||
|
||||
No configuration is required. If MS does not automatically work for you then try the **MS in Docker** method using the `DISCORD_IPC_LOCATIONS` environment variable.
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
## Optional Setup
|
||||
|
||||
:::note
|
||||
|
||||
Due to the limitations of the Discord local API the other listening activity detection and online status customizations found in [Headless](/configuration/clients/discord/discord-headless#optional-setup) are not available for the Local integration.
|
||||
|
||||
:::
|
||||
|
||||
### Artwork
|
||||
|
||||
Multi-scrobbler can display Album Art in your Discord status. The image that is used differs based on if the image URL is publically accessible.
|
||||
|
||||
The order in which multi-scrobbler determines what image to use is the same as the order of the tabs shown below.
|
||||
|
||||
#### Artwork URL Types
|
||||
|
||||
<Tabs groupId="artworkUrl" queryString>
|
||||
<TabItem label="External URLs" value="external">
|
||||
MS can use external URLs for artwork.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
External URLs that are not from known music services are **disabled by default.** This is to preserve *your* privacy because Discord does not host images, it only links to them and the URL is visible to other users.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Why Should I Care?</summary>
|
||||
|
||||
There are some scenarios where you may not want your artwork URLs to be visible, for example:
|
||||
|
||||
* A Source may be accessible only on your LAN (Jellyfin at `http://192.168.0.101`)
|
||||
* A Source may be internet-facing but you do not want to expose this information to discord/other users
|
||||
* A Source may be internet-facing but requires authentication to view the image
|
||||
</details>
|
||||
|
||||
MS will use your artwork URLs only if:
|
||||
|
||||
* artwork url is from a known music service/[Cover Art Archive](./?artworkUrl=caa#artwork-url-types) or
|
||||
* artwork url starts with `https` and
|
||||
* `artwork` (`DISCORD_ARTWORK`) is
|
||||
* `true` => always uses the url
|
||||
* a list of custom domains keywords an external artwork url should contain EX
|
||||
* ENV => `DISCORD_ARTWORK=mycdn,jellyfin`
|
||||
* File Config => `"artwork": ["mycdn","jellyfin"]`
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Examples</summary>
|
||||
|
||||
None of the below URLs will **ever** be used because they are not `https`
|
||||
|
||||
```
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
http://192.168.0.112/fun.png <-- NOT allowed, not http
|
||||
```
|
||||
|
||||
When `DISCORD_ARTWORK` is not set:
|
||||
|
||||
```
|
||||
https://archive.org/download/dir/myimage.jpg <-- allowed, is https and known service
|
||||
https://spotify.com/assets/cover.png?size=1000 <-- allowed, is https and known service
|
||||
https://example.com/cool.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
|
||||
https://anything.com/neat.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
|
||||
```
|
||||
|
||||
Setting `DISCORD_ARTWORK=true`
|
||||
|
||||
```
|
||||
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
https://example.com/cool.jpg <-- allowed, is https
|
||||
https://anything.com/neat.jpg <-- allowed, is https
|
||||
```
|
||||
|
||||
Setting `DISCORD_ARTWORK=mycdn,jellyfin`
|
||||
|
||||
```
|
||||
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
https://example.com/cool.jpg <-- NOT allowed, is https but does not contain "mycdn" or "jellyfin"
|
||||
https://jellyfin.mydomain.com/neat.jpg <-- allowed, is https and contains "jellyfin"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Musicbrainz/Cover Art Achive" value="caa">
|
||||
MS can try to use [Cover Art Archive](http://coverartarchive.org/) to get album art. The URL it retrieves is public which means it acts like an External URL that is always available for you.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
MS will try to use Cover Art Archive if:
|
||||
|
||||
* The scrobble data does not contain an album art url (no art in dashboard) or the existing url has failed an [External URL](./?artworkUrl=external#artwork-url-types) condition
|
||||
* and **the scrobble data contains a [Musicbrainz](/configuration/transforms/musicbrainz) Release (Album) MBID**
|
||||
|
||||
Basically, if MS would normally use the [MS Default](./?artworkUrl=ms-default#artwork-url-types) art, it will first try to use Cover Art Archive if the scrobble has a Release MBID.
|
||||
|
||||
Some Source, like [Jellyfin](/configuration/sources/jellyfin) and [Plex](/configuration/sources/plex), can automatically provide this ID if the music is "matched" in your library.
|
||||
|
||||
For all others, you can [**configure MS to use the Musicbrainz Stage**](/configuration/transforms/musicbrainz#use-metadata-for-discord-album-art) for Discord to try to get this MBID.
|
||||
</TabItem>
|
||||
<TabItem label="MS Default" value="ms-default">
|
||||
When these conditions are true:
|
||||
|
||||
* Cannot use an [External URL](./?artworkUrl=external#artwork-url-types) and
|
||||
* Cannot get album art from [Cover Art Archive](./?artworkUrl=caa#artwork-url-types) and
|
||||
* Play does not contain artwork information (no artwork shown in dashboard)
|
||||
|
||||
The status artwork will use a default URL instead of your artwork URL.
|
||||
|
||||
Without any other configuration, the default URL is an icon from the [multi-scrobbler repository](https://github.com/FoxxMD/multi-scrobbler/blob/master/assets/default-artwork.png):
|
||||
|
||||
<img src={require('/img/discord_presence_ms_default.png').default} height="127"/>
|
||||
|
||||
This default image can be customized:
|
||||
|
||||
* ENV Config => `DISCORD_ARTWORK_DEFAULT_URL=https://cooldomain.com/art.png`
|
||||
* File Config => `"artworkDefaultUrl": "https://cooldomain.com/art.png"`
|
||||
|
||||
Remember, this URL need to be accessible on the public internet.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="DiscordClientConfig" fileContent={JsonConfig} client name="discord">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :---------------------------- | --------- | ------- | :--------------------------------------------------------------------------------------------------------------- |
|
||||
| `DISCORD_APPLICATION_ID` | Yes | | Application ID |
|
||||
| `DISCORD_IPC_LOCATIONS` | No | | A commera-separated list of `host:port` network locations or file paths to unix socket for Discord |
|
||||
| `DISCORD_ARTWORK` | No | | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains |
|
||||
| `DISCORD_ARTWORK_DEFAULT_URL` | No | | A URL of an image to use as a fallback if the album art URL cannot be used. Or `false` to use discord's default. |
|
||||
</Config>
|
||||
@@ -0,0 +1,334 @@
|
||||
---
|
||||
title: Discord (Headless)
|
||||
toc_min_heading_level: 2
|
||||
toc_max_heading_level: 5
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import JsonConfig from '!!raw-loader!@site/../config/discord.json.example';
|
||||
|
||||
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
This integration is **headless**, it does not depend on any specific Discord application to be running.
|
||||
|
||||
:::tip
|
||||
|
||||
Check the [main Discord docs page](/configuration/clients/discord) for a comparison between **App** and **Headless**.
|
||||
|
||||
:::
|
||||
|
||||
<DetailsAdmo type="note" summary="How MS Uses Discord API">
|
||||
|
||||
Multi-scrobbler does its upmost to implement, to-spec, [Gateway API communication](https://docs.discord.com/developers/events/gateway) and respect usage. It requires no [permissions](https://docs.discord.com/developers/events/gateway#gateway-intents) and reads no data other than monitoring what other user sessions are active.
|
||||
|
||||
Aside from the on-paper violation of using a user token programmatically (on your behalf), there is no misuse of the API to achieve rich presence.
|
||||
|
||||
Additionally, MS uses the state of non-MS sessions to conservatively update presence. [By default it will not conflict](#configure-when-presence-is-used) with any other official presence activities and is only used when you are actually active on a device.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
<DetailsAdmo type="note" summary="REQUIRED Interaction after Starting Multi-Scrobbler">
|
||||
|
||||
Every time multi-scrobbler is started a discord session update needs to be triggered so that [MS can capture the signals it uses to determine if presence can be updated.](#configure-when-presence-is-used) This only needs to be *once*, after starting multi-scrobbler. But it does need to be *every time* multi-scrobbler is (re)started. Without these signals MS will not update presence.
|
||||
|
||||
This session update can happen automatically after *some* time so you may not need to do anything. If you want to force the update then do one of the following:
|
||||
|
||||
* Open discord on a device it was not recently active on
|
||||
* Exit discord on an active device
|
||||
* Change your status (online, idle, etc...)
|
||||
* Set a custom status
|
||||
* Cause a presence update with a different app (listening to..., playing..., etc.)
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
## Required Setup
|
||||
|
||||
### User Token
|
||||
|
||||
You must provide a **Discord User Token** for your account in order to authenticate with Discord.
|
||||
|
||||
<DetailsAdmo type="warning" summary="User Token usage violates Discord TOS">
|
||||
|
||||
This functionality requires you to use your own **Discord User Token** in a way that is **against Discord's policies/terms of service.** If you use this scrobbler you do so **at your risk**.
|
||||
|
||||
There is no precedent for Discord punishing users who use their own token for non-abuse/spam reasons but there is also no guarantee this lack of enforcement will continue.
|
||||
|
||||
Refer to the **How MS Uses Discord API** section above to gauge whether this risk is acceptable to you.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
|
||||
<DetailsAdmo type="warning" summary="User Token is a Sensitive Credential">
|
||||
|
||||
Treat your User Token like a login credential. Anyone who has your token can access Discord as you.
|
||||
|
||||
When finding instructions for obtaining this token only run commands, or follow steps, that you can understand and trust. Do not run commands you do not understand. Never give your token to someone else.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
No instructions will be provided for obtaining a User Token because it is against Discord's policies to use it. Instead, you can search online for "how to obtain discord user token".
|
||||
|
||||
## Optional Setup
|
||||
|
||||
### Configure When Presence Is Used
|
||||
|
||||
MS uses several signals from your "real" Discord sessions to determine if it should update presence. The default configuration is conservative to ensure that MS does not conflict with other apps using presence. Additionally, it only updates if a "real" user device is active on discord.
|
||||
|
||||
:::tip[TLDR]
|
||||
|
||||
Without any additional configuration, MS will only update presence if:
|
||||
|
||||
* you have discord open on a real device
|
||||
* your status is either: online, idle, or dnd (not invisible)
|
||||
* no other apps are broadcasting listening activities (listening to spotify, etc...)
|
||||
|
||||
:::
|
||||
|
||||
#### Online Status
|
||||
|
||||
Configure if MS is allowed to update presence based on your online status. If this setting is not defined MS will only update if your status is **online**, **idle**, or **dnd**.
|
||||
|
||||
Allowed Values: `online` `idle` `dnd` `invisible`
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
Only allow presence updating when all of your "real" sessions are either online or idle.
|
||||
|
||||
|
||||
In File/AIO:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "MS",
|
||||
"enable": true,
|
||||
"data": {
|
||||
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
|
||||
"applicationId": "8190211179716453570",
|
||||
"statusOverrideAllow": ["online", "idle"]
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
In ENV:
|
||||
|
||||
```
|
||||
DISCORD_STATUS_OVERRIDE_ALLOW=online,idle
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### Other Listening Activities
|
||||
|
||||
Without any additional configuration, MS will not set Rich Presence if **other** apps are broadcasting **listening** activities EX "Listening to Spotify".
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What about other activity types?</summary>
|
||||
|
||||
Discord uses an undocumented activity type priority to determine what activity is shown "first" for your profile. The Listening activity type has the *lowest priority*.
|
||||
|
||||
This means that if you start any other type of activity (streaming, watching, competing, etc...) it will take precedence over MS's listening activity.
|
||||
|
||||
Your listening activity will still be visible by clicking into your full profile.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
Configure the names of **other** listening activities that MS **is allowed** to broadcast at the same time as.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
You want to allow MS to update presence even if Spotify is also broadcasting a listening activity.
|
||||
|
||||
In File/AIO:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "MS",
|
||||
"enable": true,
|
||||
"data": {
|
||||
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
|
||||
"applicationId": "8190211179716453570",
|
||||
"listeningActivityAllow": ["spotify"]
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
In ENV:
|
||||
|
||||
```
|
||||
DISCORD_LISTENING_ACTIVITY_ALLOW=spotify
|
||||
```
|
||||
</details>
|
||||
|
||||
### Discord Application
|
||||
|
||||
Creating a [Discord App](https://docs.discord.com/developers/quick-start/overview-of-apps) enables you to use custom album cover art and secondary status images for more links. Creating an App is free and simple, it is recommended you do this to get the most functionality from Rich Presence.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Create An Application</summary>
|
||||
|
||||
Go to the [Discord Developer Portal](https://discord.com/developers/applications)
|
||||
|
||||
* Click on "New Application" and give it a name
|
||||
* Copy the **Application Id** (Client Id) shown after creation
|
||||
* Add this Id to your Multi-Scrobbler config
|
||||
* Env Config => `DISCORD_APPLICATION_ID=12345678`
|
||||
* File Config => `"applicationId": "12345678"`
|
||||
|
||||
</details>
|
||||
|
||||
### Artwork
|
||||
|
||||
Multi-scrobbler can display Album Art in your Discord status. The image that is used differs based on if the image URL is publically accessible.
|
||||
|
||||
:::note
|
||||
|
||||
If no [**Application Id**](#discord-application) is configured the status art will **always** be the [Discord Default](./?artworkUrl=discord-default#artwork-url-types).
|
||||
|
||||
:::
|
||||
|
||||
The order in which multi-scrobbler determines what image to use is the same as the order of the tabs shown below.
|
||||
|
||||
#### Artwork URL Types
|
||||
|
||||
<Tabs groupId="artworkUrl" queryString>
|
||||
<TabItem label="External URLs" value="external">
|
||||
When [**Application Id**](#discord-application) **is** configured MS can use external URLs for artwork.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
External URLs that are not from known music services are **disabled by default.** This is to preserve *your* privacy because Discord does not host images, it only links to them and the URL is visible to other users.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Why Should I Care?</summary>
|
||||
|
||||
There are some scenarios where you may not want your artwork URLs to be visible, for example:
|
||||
|
||||
* A Source may be accessible only on your LAN (Jellyfin at `http://192.168.0.101`)
|
||||
* A Source may be internet-facing but you do not want to expose this information to discord/other users
|
||||
* A Source may be internet-facing but requires authentication to view the image
|
||||
</details>
|
||||
|
||||
MS will use your artwork URLs only if:
|
||||
|
||||
* artwork url is from a known music service/[Cover Art Archive](./?artworkUrl=caa#artwork-url-types) or
|
||||
* artwork url starts with `https` and
|
||||
* `artwork` (`DISCORD_ARTWORK`) is
|
||||
* `true` => always uses the url
|
||||
* a list of custom domains keywords an external artwork url should contain EX
|
||||
* ENV => `DISCORD_ARTWORK=mycdn,jellyfin`
|
||||
* File Config => `"artwork": ["mycdn","jellyfin"]`
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Examples</summary>
|
||||
|
||||
None of the below URLs will **ever** be used because they are not `https`
|
||||
|
||||
```
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
http://192.168.0.112/fun.png <-- NOT allowed, not http
|
||||
```
|
||||
|
||||
When `DISCORD_ARTWORK` is not set:
|
||||
|
||||
```
|
||||
https://archive.org/download/dir/myimage.jpg <-- allowed, is https and known service
|
||||
https://spotify.com/assets/cover.png?size=1000 <-- allowed, is https and known service
|
||||
https://example.com/cool.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
|
||||
https://anything.com/neat.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
|
||||
```
|
||||
|
||||
Setting `DISCORD_ARTWORK=true`
|
||||
|
||||
```
|
||||
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
https://example.com/cool.jpg <-- allowed, is https
|
||||
https://anything.com/neat.jpg <-- allowed, is https
|
||||
```
|
||||
|
||||
Setting `DISCORD_ARTWORK=mycdn,jellyfin`
|
||||
|
||||
```
|
||||
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
|
||||
http://foobar.com/cool.jpg <-- NOT allowed, not http
|
||||
https://example.com/cool.jpg <-- NOT allowed, is https but does not contain "mycdn" or "jellyfin"
|
||||
https://jellyfin.mydomain.com/neat.jpg <-- allowed, is https and contains "jellyfin"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Musicbrainz/Cover Art Achive" value="caa">
|
||||
When [**Application Id**](#discord-application) **is** configured MS can try to use [Cover Art Archive](http://coverartarchive.org/) to get album art. The URL it retrieves is public which means it acts like an External URL that is always available for you.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
MS will try to use Cover Art Archive if:
|
||||
|
||||
* The scrobble data does not contain an album art url (no art in dashboard) or the existing url has failed an [External URL](./?artworkUrl=external#artwork-url-types) condition
|
||||
* and **the scrobble data contains a [Musicbrainz](/configuration/transforms/musicbrainz) Release (Album) MBID**
|
||||
|
||||
Basically, if MS would normally use the [MS Default](./?artworkUrl=ms-default#artwork-url-types) art, it will first try to use Cover Art Archive if the scrobble has a Release MBID.
|
||||
|
||||
Some Source, like [Jellyfin](/configuration/sources/jellyfin) and [Plex](/configuration/sources/plex), can automatically provide this ID if the music is "matched" in your library.
|
||||
|
||||
For all others, you can [**configure MS to use the Musicbrainz Stage**](/configuration/transforms/musicbrainz#use-metadata-for-discord-album-art) for Discord to try to get this MBID.
|
||||
</TabItem>
|
||||
<TabItem label="MS Default" value="ms-default">
|
||||
When [**Application Id**](#discord-application) **is** configured and these conditions are true:
|
||||
|
||||
* Cannot use an [External URL](./?artworkUrl=external#artwork-url-types) and
|
||||
* Cannot get album art from [Cover Art Archive](./?artworkUrl=caa#artwork-url-types) and
|
||||
* Play does not contain artwork information (no artwork shown in dashboard)
|
||||
|
||||
The status artwork will use a default URL instead of your artwork URL.
|
||||
|
||||
Without any other configuration, the default URL is an icon from the [multi-scrobbler repository](https://github.com/FoxxMD/multi-scrobbler/blob/master/assets/default-artwork.png):
|
||||
|
||||
<img src={require('/img/discord_presence_ms_default.png').default} height="127"/>
|
||||
|
||||
This default image can be customized:
|
||||
|
||||
* ENV Config => `DISCORD_ARTWORK_DEFAULT_URL=https://cooldomain.com/art.png`
|
||||
* File Config => `"artworkDefaultUrl": "https://cooldomain.com/art.png"`
|
||||
|
||||
Remember, this URL need to be accessible on the public internet.
|
||||
</TabItem>
|
||||
<TabItem label="Discord Default" value="discord-default">
|
||||
When [**Application Id**](#discord-application) is **not** configured Discord will show its own image. No custom artwork can be used in this configuration.
|
||||
|
||||
This is also the image Discord will display if the artwork URL cannot be fetched.
|
||||
|
||||
<img src={require('/img/discord_presence_discord_default.png').default} height="127"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="DiscordClientConfig" fileContent={JsonConfig} client name="discord">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------------------- | --------- | ----------------- | :---------------------------------------------------------------------------------------------------------------- |
|
||||
| `DISCORD_TOKEN` | Yes | | User Token acquired from an active Discord sessions |
|
||||
| `DISCORD_APPLICATION_ID` | No | | Application ID used to display album art |
|
||||
| `DISCORD_ARTWORK` | No | | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains |
|
||||
| `DISCORD_ARTWORK_DEFAULT_URL` | No | | A URL of an image to use as a fallback if the album art URL cannot be used. Or `false` to use discord's default. |
|
||||
| `DISCORD_STATUS_OVERRIDE_ALLOW` | No | `online,idle,dnd` | A comma-separated list of statuses are allowed to have presence. |
|
||||
| `DISCORD_LISTENING_ACTIVITY_ALLOW` | No | | A commera-seperated list of listening activity names MS **is allowed** to broadcast presence at the same time as. |
|
||||
</Config>
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Discord
|
||||
toc_max_heading_level: 4
|
||||
---
|
||||
|
||||
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
|
||||
|
||||
<img src={require('/img/discord_presence_art.png').default} height="127"/>
|
||||
|
||||
There are two types of Discord integrations to choose from:
|
||||
|
||||
## App
|
||||
|
||||
The **App** integration uses an **existing** Discord application on a desktop computer to set Rich Presence.
|
||||
|
||||
* Uses "permitted" access to Discord, no TOS issues
|
||||
* More restricted customization compared to Headless
|
||||
* Only active when your existing Discord application is open
|
||||
* For most scenarios it requires additional, OS-specific steps to setup correctly
|
||||
* May require an additional program on your machine to relay the Discord connection
|
||||
* This is potentially insecure, or less secure, then Headless
|
||||
* **Can use [discord in a container](/configuration/clients/discord/discord-app#discord-connection) as an easy alternative**
|
||||
* This is a Headless-like experience
|
||||
|
||||
[**App Docs**](/configuration/clients/discord/discord-app)
|
||||
|
||||
## Headless
|
||||
|
||||
The **Headless** integration uses Discord cloud Gateway/API, directly, to set Rich Presence.
|
||||
|
||||
* Does not require an existing Discord application (uses Discord cloud API)
|
||||
* Using this **Violates Discord TOS** because it requires a user token
|
||||
* More customization than App integration
|
||||
* Active if **any** Discord application is online
|
||||
|
||||
[**Headless Docs**](/configuration/clients/discord/discord-headless)
|
||||
@@ -20,7 +20,7 @@ You will need a [Last.fm](https://www.last.fm) account to use the Last.fm API.
|
||||
|
||||
After creating your account, [register for an API account here.](https://www.last.fm/api/account/create)
|
||||
|
||||
The callback URL in the API account form is not used, but to keep it consistent use the same value you set using the [Callback/Redirect URL](#callback-redirect-url) section.
|
||||
The callback URL in the API account form is not used, but to keep it consistent use the same value you set using the [Callback/Redirect URL](#callbackredirect-url) section.
|
||||
|
||||
**Take note of your API Key and Secret after account creation.**
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="ListenbrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
|
||||
<Config config="ListenBrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| ---------------------- | --------- | ----------------------------- | ------------------------------- |
|
||||
| `LZ_TOKEN` | Yes | | User token from your LZ profile |
|
||||
|
||||
@@ -64,7 +64,7 @@ The handle used with multi-scrobbler should be your **full** ATProto handle, inc
|
||||
|
||||
If you do not include a TLD then multi-scrobbler will automatically append `.bsky.social` to your handle value.
|
||||
|
||||
<Config config="RockskyClientConfig" fileContent={JsonConfig} client name="rocksky">
|
||||
<Config config="RockSkyClientConfig" fileContent={JsonConfig} client name="rocksky">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------- | --------- | ------- | ----------------------------------------------------------------------------------- |
|
||||
| `ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` |
|
||||
|
||||
@@ -168,7 +168,7 @@ Each entry for a Source/Client includes a **Configuration** section that describ
|
||||
|
||||
## Secrets Interpolation
|
||||
|
||||
When using [File](./?configType=file#configuration-types) or [AIO](./?configType=aio#configuration-types) Configuration, Multi-Scrobbler can interpolate Environmental Variables into your json files. This can be used, for example, to keep sensitive data (like [Last.fm Client/Secret](/configurations/clients/lastfm#configuration)) out of your configuration files so that they can be committed to git.
|
||||
When using [File](./?configType=file#configuration-types) or [AIO](./?configType=aio#configuration-types) Configuration, Multi-Scrobbler can interpolate Environmental Variables into your json files. This can be used, for example, to keep sensitive data (like [Last.fm Client/Secret](/configuration/clients/lastfm#configuration)) out of your configuration files so that they can be committed to git.
|
||||
|
||||
Multi-scrobbler will look for patterns in text fields within _all_ of your json files:
|
||||
|
||||
@@ -179,7 +179,7 @@ Multi-scrobbler will look for patterns in text fields within _all_ of your json
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
Given this [Last.fm](/configurations/clients/lastfm#configuration) [File](./?configType=file#configuration-types) config:
|
||||
Given this [Last.fm](/configuration/clients/lastfm#configuration) [File](./?configType=file#configuration-types) config:
|
||||
|
||||
```json title="lastfm.json"
|
||||
[
|
||||
@@ -294,7 +294,7 @@ All of the activities below are **always** cached **in-memory** with an optional
|
||||
|
||||
By default, this data use a [Secondary](#secondary-caching-configuration) [File](./?cacheType=file#secondary-caching-configuration) store, configured for you automatically.
|
||||
|
||||
If you have configured a [persisted volume/bind mount](/installation#storage) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
|
||||
If you have configured a [persisted volume/bind mount](/installation?dockerSetting=storage#recommended-settings) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
|
||||
|
||||
:::
|
||||
|
||||
@@ -337,7 +337,7 @@ Authentication sessions/tokens/etc... are cached for quicker requests and for pe
|
||||
|
||||
By default, this data use a [Secondary](#secondary-caching-configuration) [File](./?cacheType=file#secondary-caching-configuration) store, configured for you automatically.
|
||||
|
||||
If you have configured a [persisted volume/bind mount](/installation#storage) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
|
||||
If you have configured a [persisted volume/bind mount](/installation?dockerSetting=storage#recommended-settings) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
|
||||
|
||||
:::
|
||||
|
||||
@@ -555,7 +555,7 @@ If you do not need the dashboard and/or ingress sources, or have security concer
|
||||
|
||||
:::warning
|
||||
|
||||
Any **[ingress-based sources](/configuration/sources#ingress) will be unusable** (Webscrobbler, etc...) if this is disabled.
|
||||
Any **[ingress-based sources](/configuration/sources?sourceComm=ingress#by-communication-method) will be unusable** (Webscrobbler, etc...) if this is disabled.
|
||||
|
||||
:::
|
||||
|
||||
@@ -566,7 +566,19 @@ Disable using either:
|
||||
|
||||
## Monitoring
|
||||
|
||||
Multi-scrobbler supports some common webhooks and a healthcheck endpoint in order to monitor Sources and Clients for errors.
|
||||
### Upstream Services Status
|
||||
|
||||
A status page for monitoring the reachability of public services used by some Sources/Clients is available at
|
||||
|
||||
**https://status.multi-scrobbler.app**
|
||||
|
||||
This monitor runs on a VPS and checks the uptime of *actual* APIs for these services, not just landing pages. On a ~minute interval it checks:
|
||||
|
||||
* Listenbrainz API
|
||||
* Musicbrainz API
|
||||
* CoverArtArchive API
|
||||
* Last.fm API
|
||||
* A few MS-hosted support services
|
||||
|
||||
### Webhook Configurations
|
||||
|
||||
@@ -713,5 +725,37 @@ It includes metrics for:
|
||||
* Count of Queued/Scrobbled/Deadletter scrobbles per [Client](/configuration/clients)
|
||||
* Number of issues per Source/Client
|
||||
* If any of these metrics is > 0 it means your Source/Client is not operating normally
|
||||
* Caching metrics
|
||||
|
||||
Additionally, general process metrics like cpu and memory usage can be enabled with the env `PROMETHEUS_FULL=true`
|
||||
Additionally, general process metrics like cpu and memory usage can be enabled with the env `PROMETHEUS_FULL=true`
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example Usage</summary>
|
||||
|
||||
Update your [Prometheus Configuration file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file) (usually at `/etc/prometheus.yml`) to add a job to the `scrape_configs`[section](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) like this:
|
||||
|
||||
```yaml
|
||||
scrape_configs:
|
||||
#
|
||||
# ...your other jobs are here
|
||||
#
|
||||
- job_name: multi-scrobbler
|
||||
scrape_interval: 30s
|
||||
metrics_path: '/api/metrics'
|
||||
static_configs:
|
||||
- targets: ['myMultiscrobblerIp:9078']
|
||||
```
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<DetailsAdmo status="tip" summary="Grafana Dashboard">
|
||||
|
||||
Github user [4rft5](https://github.com/FoxxMD/multi-scrobbler/issues/507#issuecomment-4144982295) created a Grafana dashboard that uses the Prometheus metrics from above.
|
||||
|
||||
<img src={require('/img/grafana.png').default} height="800"/>
|
||||
|
||||
Download the json dashboard here: [`multiscrobbler-dashboard.json`](/multiscrobbler-dashboard.json)
|
||||
|
||||
</DetailsAdmo>
|
||||
@@ -11,13 +11,13 @@ Scenario:
|
||||
* Each person has their own [Maloja](/configuration/clients/maloja) server
|
||||
* Each person has their own Spotify account
|
||||
* You have your own Airsonic ([subsonic](/configuration/sources/subsonic)) server you to scrobble from
|
||||
* You have your own [Youtube Music](/configuration/soures/youtube-mysic) account you want to scrobble from
|
||||
* You have your own [Youtube Music](/configuration/sources/youtube-music) account you want to scrobble from
|
||||
* Mary has her own [Last.fm](/configuration/clients/lastfm) account she also wants to scrobble to
|
||||
* Fred has his own [Spotify](/configuration/sources/spotify) application and provides you with just his access and refresh token because he doesn't trust you (wtf Fred)
|
||||
* Fred has a Plex server and wants to scrobble everything he plays
|
||||
* Mary uses Fred's Plex server but only wants to scrobble her plays from the `podcast` library
|
||||
* The three of you have a shared library on [Plex](/configuration/sources/plex) called `party` that you only play when you are hanging out. You want plays from that library to be scrobbled to everyone's servers.
|
||||
* Fred also has his own [Jellyfin server](/configurion/sources/jellyfin) and wants to scrobble everything he plays
|
||||
* Fred also has his own [Jellyfin server](/configuration/sources/jellyfin) and wants to scrobble everything he plays
|
||||
* You have an android music app that can scrobble to a [custom listenbrainz server](/configuration/sources/listenbrainz-endpoint)
|
||||
|
||||
### All-in-one Config
|
||||
|
||||
@@ -49,28 +49,11 @@ If neither is configured automatic scrobble defaults to **off** and you should e
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
<Config config="AzuracastSourceConfig" fileContent={AzuracastConfig} name="azuracast">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- |
|
||||
| `AZ_URL` | Yes | | Azuracast URL *without station name* |
|
||||
| `AZ_STATION` | Yes | | The station name shown on the public page |
|
||||
| `AZURA_LIVE` | No | Yes | Only scrobble when station status is ONLINE |
|
||||
| `AZURA_LISTENERS_NUM` | No | `true` | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` |
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
|
||||
<CodeBlock title="CONFIG_DIR/azuracast.json" language="json5">{AzuracastConfig}</CodeBlock>
|
||||
|
||||
|
||||
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
|
||||
<AIOExample data={AzuracastConfig} name="azuracast"/>
|
||||
|
||||
|
||||
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</Config>
|
||||
@@ -44,28 +44,6 @@ import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecat
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------- | --------- | ------- | ------------------------------------------------ |
|
||||
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
|
||||
<CodeBlock title="CONFIG_DIR/deezer.json" language="json5">{DeezerConfig}</CodeBlock>
|
||||
|
||||
or <SchemaLink lower objectName="DeezerSourceConfig"/>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
|
||||
<AIOExample data={DeezerConfig} name="deezer"/>
|
||||
|
||||
or <SchemaLink lower objectName="DeezerSourceConfig"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Duplicate detection
|
||||
|
||||
Third party integrations with Deezer (Sonos) may cause Deezer to [report the same track many times in listening history.](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2922374738) If you experience this issue modify your Deezer Source config (file-based only) to include the option `"fuzzyDiscoveryIgnore": "aggressive"`
|
||||
@@ -153,7 +131,13 @@ import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecat
|
||||
:::
|
||||
</details>
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="DeezerCompatConfig" fileContent={DeezerConfig} name="deezer">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------- | --------- | ------- | ------------------------------------------------ |
|
||||
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
|
||||
</Config>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="official" label="Official API">
|
||||
|
||||
@@ -144,8 +144,7 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
<Config config="ChromecastSourceConfig" fileContent={ChromecastConfig} name="chromecast">
|
||||
:::note
|
||||
[Manually configuring cast device connections](#connecting-devices) is only available through file-based config.
|
||||
:::
|
||||
@@ -157,28 +156,4 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
|
||||
| CC_BLACKLIST_DEVICES | No | | Do not scrobble from these Cast devices. Comma-delimited list |
|
||||
| CC_WHITELIST_APPS | No | | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora |
|
||||
| CC_BLACKLIST_APPS | No | | Do not scrobble from these casted Apps. Comma-delimited list |
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<CodeBlock title="CONFIG_DIR/chromecast.json" language="json5">{ChromecastConfig}</CodeBlock>
|
||||
|
||||
</details>
|
||||
|
||||
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<AIOExample data={ChromecastConfig} name="chromecast"/>
|
||||
|
||||
</details>
|
||||
|
||||
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</Config>
|
||||
@@ -62,32 +62,8 @@ If no `sources` are configured for multi-scrobbler it will automatically try to
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
<Config config="IcecastSourceConfig" fileContent={IcecastConfig} name="icecast">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :--------------------- | :-------- | :------ | ----------- |
|
||||
| `ICECAST_URL` | Yes | | Icecast URL |
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<CodeBlock title="CONFIG_DIR/icecast.json" language="json5">{IcecastConfig}</CodeBlock>
|
||||
|
||||
</details>
|
||||
|
||||
or <SchemaLink lower objectName="IcecastSourceConfig"/>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<AIOExample data={IcecastConfig} name="icecast"/>
|
||||
|
||||
</details>
|
||||
|
||||
or <SchemaLink lower objectName="IcecastSourceConfig"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</Config>
|
||||
@@ -35,36 +35,35 @@ By default...
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
<DetailsAdmo type="tip" summary="External Asset URL">
|
||||
|
||||
If you use MS and Jellyfin on an internal or otherwise inaccessible network but still want album art assets used in the UI or for [Discord](/configuration/clients/discord) to be accessible you can specify a URL to replace your internal url.
|
||||
|
||||
Use (file) `frontendUrlOverride` or (env) `JELLYFIN_FRONTEND_URL_OVERRIDE` to replace `url`/`JELLYFIN_URL`, respectively, when rendering links for the dashboard UI or other resources.
|
||||
|
||||
Example:
|
||||
|
||||
Your `JELLYFIN_URL` is `http://jellyfin:8096` but your Jellyfin instance is externally accessible (by MS or in general) at `https://jellyfin.mydomain.com`.
|
||||
|
||||
Use `JELLYFIN_FRONTEND_URL_OVERRIDE=https://jellyfin.mydomain.com` in order for the MS dashboard to use `https://jellyfin.mydomain.com/art/1234.jpg` when linking to album art.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
#### Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| --------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
|
||||
| `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API |
|
||||
| `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** |
|
||||
| `JELLYFIN_PASSWORD` | No | | The password of the user to authenticate for. **(Must provide either apikey or password)** |
|
||||
| `JELLYFIN_USERS_ALLOW` | No | | Comma-separated list of usernames (from Jellyfin) to scrobble for |
|
||||
| `JELLYFIN_USERS_BLOCK` | No | | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for |
|
||||
| `JELLYFIN_DEVICES_ALLOW` | No | | Comma-separated list of devices to scrobble from |
|
||||
| `JELLYFIN_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from |
|
||||
| `JELLYFIN_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from |
|
||||
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
|
||||
| `JELLYFIN_MEDIATYPES_ALLOW` | No | | Comma-separated list of [media types](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/src/generated-client/models/media-type.ts#L22) to allow scrobbling. Defaults to `audio` |
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
|
||||
<CodeBlock title="CONFIG_DIR/jellyfin.json" language="json5">{JellyfinConfig}</CodeBlock>
|
||||
|
||||
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
|
||||
<AIOExample data={JellyfinConfig} name="jellyfin"/>
|
||||
|
||||
|
||||
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
<Config config="JellyApiSourceConfig" fileContent={JellyfinConfig} name="jellyfin">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| -------------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
|
||||
| `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API |
|
||||
| `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** |
|
||||
| `JELLYFIN_PASSWORD` | No | | The password of the user to authenticate for. **(Must provide either apikey or password)** |
|
||||
| `JELLYFIN_USERS_ALLOW` | No | | Comma-separated list of usernames (from Jellyfin) to scrobble for |
|
||||
| `JELLYFIN_USERS_BLOCK` | No | | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for |
|
||||
| `JELLYFIN_DEVICES_ALLOW` | No | | Comma-separated list of devices to scrobble from |
|
||||
| `JELLYFIN_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from |
|
||||
| `JELLYFIN_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from |
|
||||
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
|
||||
| `JELLYFIN_MEDIATYPES_ALLOW` | No | | Comma-separated list of [media types](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/src/generated-client/models/media-type.ts#L22) to allow scrobbling. Defaults to `audio` |
|
||||
| `JELLYFIN_FRONTEND_URL_OVERRIDE` | No | | The external URL to use for album art assets instead of `JELLYFIN_URL` |
|
||||
</Config>
|
||||
@@ -49,28 +49,10 @@ If any part of this URL is missing multi-scrobbler will use a default value. Thi
|
||||
|
||||
## Configuration
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
<EnvType>
|
||||
<Config config="JRiverSourceConfig" fileContent={JriverConfig} name="jriver">
|
||||
| Environmental Variable | Required | Default | Description |
|
||||
|------------------------|----------|---------------------------------|------------------------------------------------|
|
||||
| JRIVER_URL | Yes | http://localhost:52199/MCWS/v1/ | The URL of the JRiver server |
|
||||
| JRIVER_USERNAME | No | | If authentication is enabled, the username set |
|
||||
| JRIVER_PASSWORD | No | | If authenticated is enabled, the password set |
|
||||
</EnvType>
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
<FileType>
|
||||
<CodeBlock title="CONFIG_DIR/jriver.json" language="json5">{JriverConfig}</CodeBlock>
|
||||
|
||||
or <SchemaLink lower objectName="JRiverSourceConfig"/>
|
||||
</FileType>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
<AIOType>
|
||||
<AIOExample data={JriverConfig} name="jriver"/>
|
||||
|
||||
or <SchemaLink lower objectName="JRiverSourceConfig"/>
|
||||
</AIOType>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</Config>
|
||||
@@ -9,7 +9,9 @@ import TabItem from '@theme/TabItem';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import ListenbrainzEndpointConfig from '!!raw-loader!@site/../config/endpointlz.json.example';
|
||||
|
||||
This Source enables multi-scrobbler to accept scrobbles from outside applications as if it was a Listenbrainz server.
|
||||
This Source enables multi-scrobbler to accept scrobbles from outside applications **as if it was a Listenbrainz server.**
|
||||
|
||||
If your service/player has a "Scrobble to Listenbrainz" feature and there is an option to set the Listenbrainz URL then multi-scrobbler can accept scrobbles from that service/player by imitating a real Listenbrainz server.
|
||||
|
||||
:::tip[Other Uses]
|
||||
|
||||
@@ -18,44 +20,91 @@ This Source enables multi-scrobbler to accept scrobbles from outside application
|
||||
|
||||
:::
|
||||
|
||||
## Setup
|
||||
|
||||
### URL
|
||||
|
||||
If a **slug** is **not** provided in configuration then multi-scrobbler will accept Listenbrainz scrobbles at
|
||||
In general, you should use one of the following as the **base URL** when configuring your application to scrobble to multi-scrobbler:
|
||||
|
||||
* `http://myMultiScrobblerIP:9078`
|
||||
* `http://myMultiScrobblerIP:9078/1/`
|
||||
|
||||
<DetailsAdmo type="tip" summary="Default Scrobble Submit URL">
|
||||
|
||||
If you are not using a [slug for multiple endpoints](#multiple-endpoints) then multi-scrobbler will accept Listenbrainz scrobbles at
|
||||
|
||||
```
|
||||
http://myMultiScrobblerIP:9078/1/submit-listens
|
||||
```
|
||||
|
||||
which is the "standard" Listenbrainz server path for scrobbling.
|
||||
which is the **standard** Listenbrainz server path for scrobbling.
|
||||
|
||||
In general, you should use `http://myMultiScrobblerIP:9078/1/` as the **base path** when configuring your application to scrobble to multi-scrobbler.
|
||||
</DetailsAdmo>
|
||||
|
||||
<details>
|
||||
<DetailsAdmo type="note" summary="Some Services Require HTTPS">
|
||||
|
||||
<summary>URL Setup for Popular Apps</summary>
|
||||
Some services that can scrobble to a custom Listenbrainz URL may require the URL to have a real domain (`example.com`) and/or use SSL (`https://`). In this case you should setup multi-scrobbler behind a reverse proxy to support this functionality. It is out of the scope of this project to do this solely within multi-scrobbler.
|
||||
|
||||
##### Navidrome
|
||||
|
||||
Set the [**ListenBrainz.BaseURL**](https://www.navidrome.org/docs/usage/configuration-options/#advanced-configuration) (env `ND_LISTENBRAINZ_BASEURL`) to `http://myMultiScrobblerIP:9078/1/`
|
||||
|
||||
</details>
|
||||
|
||||
Use a slug only if you need to setup multiple Listenbrainz Endpoint sources and cannot use different tokens.
|
||||
|
||||
If a slug is used then the URL will be:
|
||||
|
||||
```
|
||||
http://myMultiScrobblerIP:9078/api/listenbrainz/mySlug
|
||||
```
|
||||
|
||||
:::note
|
||||
Some Listenbrainz applications may require custom Listenbrainz URLs to be a real domain (`example.com`) and/or use SSL (`https://`). In this case you should setup multi-scrobbler behind a reverse proxy to support this functionality. It is out of the scope of this project to do this solely within multi-scrobbler.
|
||||
:::
|
||||
</DetailsAdmo>
|
||||
|
||||
### Token
|
||||
|
||||
Most Listenbrainz clients require a token (Authentication Token) to be provided during setup. This value can be anything you want, just make sure to use the same value for `token` in your multi-scrobbler configuration for the endpoint.
|
||||
|
||||
### Multiple Endpoints
|
||||
|
||||
If you are setting up multiple [Listenbrainz (Endpoint) Sources](/configuration/sources/listenbrainz-endpoint) MS can differentiate scrobbles based on [Token](#token) so that you can use the same endpoint for many users.
|
||||
|
||||
However, if you cannot configure multiple tokens for your scenario you may also use a URL **Slug** to tell MS which Source belongs to a specific user.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Using a Slug</summary>
|
||||
|
||||
When a **slug** is defined in ENV/File config MS will listen for listenbrainz routes using the slug as a the route path. Example:
|
||||
|
||||
```
|
||||
LZE_SLUG=foobar
|
||||
```
|
||||
|
||||
MS will accept calls to
|
||||
|
||||
```
|
||||
http://myMultiScrobblerIP:9078/api/listenbrainz/foobar
|
||||
```
|
||||
|
||||
for scrobble submission.
|
||||
|
||||
</details>
|
||||
|
||||
## Setup for Popular Apps
|
||||
|
||||
### Navidrome
|
||||
|
||||
<details>
|
||||
|
||||
Set the [**ListenBrainz.BaseURL**](https://www.navidrome.org/docs/usage/configuration-options/#advanced-configuration) (env `ND_LISTENBRAINZ_BASEURL`) to `http://myMultiScrobblerIP:9078/1/`
|
||||
|
||||
</details>
|
||||
|
||||
### Music Assistant
|
||||
|
||||
<details>
|
||||
|
||||
[Music Assistant Docs](https://www.music-assistant.io/plugins/listenbrainz_scrobble/)
|
||||
|
||||
* In your Music Assistant UI navigate to **Settings** -> **Plugins**
|
||||
* Click **Add a plugin**
|
||||
* Add **ListenBrainz Scrobbler**
|
||||
* In the ListenBrainz Scrobbler configuration screen:
|
||||
* User Token is the [Token](#token) you configured
|
||||
* Toggle **Show advanced settings**
|
||||
* Base URL is the [URL](#url) you can configured, or the equivalent of `http://myMultiScrobblerIP:9078` for your MS instance
|
||||
* Save the configuration and you are ready to scrobble
|
||||
|
||||
To troubleshoot any errors, and assuming you are using Home Assistant, view the Logs in the Music Assistant Add-ons. Please include these logs in any reported issue.
|
||||
|
||||
</details>
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ MPRIS communication requires multi-scrobbler to have access to the host's dbus-d
|
||||
|
||||
##### Local Unix Socket
|
||||
|
||||
The most secure way is to **run a multi-scrobbler container on the same host as MPRIS.** In this scenario you can simply mount the **user session** dbus unix socket into the container. Make sure [`PUID` and `PGID` ENVs are configured](/installation/#linux-host) so the container has permissions to access the socket. Then, modify your compose stack with these additional values:
|
||||
The most secure way is to **run a multi-scrobbler container on the same host as MPRIS.** In this scenario you can simply mount the **user session** dbus unix socket into the container. Make sure [`PUID` and `PGID` ENVs are configured](/installation?dockerSetting=linuxHost#recommended-settings) so the container has permissions to access the socket. Then, modify your compose stack with these additional values:
|
||||
|
||||
```yaml title="docker-compose.yaml"
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ See the [Rocksky (Client)](/configuration/clients/rocksky#setup) configuration f
|
||||
|
||||
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
|
||||
|
||||
<Config config="RockskyClientConfig" fileContent={JsonConfig} name="rocksky">
|
||||
<Config config="RockskySourceConfig" fileContent={JsonConfig} name="rocksky">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
| :---------------------- | --------- | ------- | ----------------------------------------------------------------------------------- |
|
||||
| `SOURCE_ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` |
|
||||
|
||||
@@ -16,6 +16,23 @@ If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What-
|
||||
|
||||
#### Authenticate Spotify with Multi-Scrobbler
|
||||
|
||||
<DetailsAdmo type="warning" summary="Premium Account Required">
|
||||
|
||||
Starting [March 9th 2026](https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security) all applications on the Spotify Developer platform will only continue to work if they are **owned** by a **Spotify Premium** account.
|
||||
|
||||
If your App is not created by a Premium account you will likely recieve a 403 error when trying to use MS with Spotify.
|
||||
|
||||
If you do not have a Spotify Premium account *you can still use Spotify with MS* but it will require you to coordinate with a (friend?) user who *does* have Spotify Premium:
|
||||
|
||||
* Follow the steps below **logged in as the Spotify Premium account user**
|
||||
* After completing App creation (step 4 or 5), navigate to the **User Management** page for the created App
|
||||
* Add **your** (non-premium) account here using your account email/name
|
||||
* Complete the rest of the authentication/configuration process normally
|
||||
|
||||
Assure your friend: **Creating a Spotify Developer app does not give anyone access to the owner's account.** The authentication process within MS is where authorization is given: it requires clicking the link in MS's dashboard and following a separate auth flow. This auth flow only authorizes access to the specific account used in the flow, unrelated to the owner of the developer app.
|
||||
|
||||
</DetailsAdmo>
|
||||
|
||||
To access your Spotify history you must [create a Spotify App](https://developer.spotify.com/dashboard) to get a
|
||||
Client ID/Secret.
|
||||
|
||||
@@ -48,7 +65,7 @@ Use **one** of the following methods to specify a valid Redirect URI and complet
|
||||
|
||||
In this scenario you can use `http://127.0.0.1:9078/callback` as the Spotify Redirect URI and multi-scrobbler `SPOTIFY_REDIRECT_URI` ENV.
|
||||
|
||||
After completing authentication, copy the contents of local multi-scrobbler's [configuration folder](/installation#storage) to the final location of where multi-scrobbler will be run.
|
||||
After completing authentication, copy the contents of local multi-scrobbler's [configuration folder](/installation?dockerSetting=storage#recommended-settings) to the final location of where multi-scrobbler will be run.
|
||||
</TabItem>
|
||||
<TabItem value="echo" label="Echo">
|
||||
**Use a docker container on the same machine your browser is on to "intercept" the callback URL from Spotify authentication, then manually finish the process by changing the domain to your multi-scrobbler instance.**
|
||||
|
||||
@@ -30,7 +30,7 @@ Use the optional `usersAllow` property with **File** or **AIO** configuration to
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="SubsonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
|
||||
<Config config="SubSonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
|------------------------|-----------|---------|--------------------------------------|
|
||||
| `SUBSONIC_USER` | Yes | | |
|
||||
|
||||
@@ -86,7 +86,7 @@ This affects **only** MS's behavior and does not affect the general connector be
|
||||
|
||||
## Configuration
|
||||
|
||||
<Config config="WebscrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
|
||||
<Config config="WebScrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
|
||||
| Environmental Variable | Required? | Default | Description |
|
||||
|------------------------|-----------|---------|--------------------------------------------------------------------------|
|
||||
| WS_ENABLE | No | | Set to 'true' to enable WS without needing to define other ENVs |
|
||||
|
||||
@@ -50,7 +50,7 @@ Set up [Valkey Caching](/configuration?cachedThings=metadata#caching) to cache M
|
||||
|
||||
### API Setup
|
||||
|
||||
To avoid rate limiting, MusicBrainz requires API users to identify themself using a [User-Agent that contains an email or URL.](https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting#How_can_I_be_a_good_citizen_and_be_smart_about_using_the_Web_Service?) You must set this in the `data` for your [stage configuration](http://localhost:3000/docs/configuration/transforms/#configuring-stages) in your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
To avoid rate limiting, MusicBrainz requires API users to identify themself using a [User-Agent that contains an email or URL.](https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting#How_can_I_be_a_good_citizen_and_be_smart_about_using_the_Web_Service?) You must set this in the `data` for your [stage configuration](/configuration/transforms/#configuring-stages) in your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
|
||||
```json5 title="config.json"
|
||||
{
|
||||
@@ -160,7 +160,7 @@ Example:
|
||||
]
|
||||
```
|
||||
|
||||
Each [**Stage Rule**](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition](/configuration/transforms#conditional-moditication):
|
||||
Each [**Stage Rule**](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition](/configuration/transforms#conditional-modification):
|
||||
|
||||
<details>
|
||||
|
||||
@@ -247,11 +247,11 @@ To configure [stage defaults](#stage-configuration) use `MB_PRESETS` with a comm
|
||||
* `fields` - Applies [Field Scoring](#field-scoring) to match sorting so match text is baised towards similarity to original scrobble
|
||||
* `sensible` - Applies the [Sensible Default](#sensible-default) configuration for [sorting releases](#sorting-releases)
|
||||
|
||||
Finally, use ENV `*_TRANSFORMS=musicbrainz` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](/configuration/transforms#lifecycle-hooks) with all [Rules](#rules) enabled.
|
||||
Finally, use ENV `*_TRANSFORMS=musicbrainz` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](/configuration/transforms#lifecycle-hooks) with all [Rules](#rules-and-hooks) enabled.
|
||||
|
||||
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this. Example:
|
||||
|
||||
* All [Subsonic Source](http://localhost:3000/docs/configuration/sources/subsonic/) ENVs look like `SUBSONIC_USER=myuser` etc...
|
||||
* All [Subsonic Source](/configuration/sources/subsonic) ENVs look like `SUBSONIC_USER=myuser` etc...
|
||||
* Use `SUBSONIC_TRANSFORMS=musicbrainz`
|
||||
|
||||
<details>
|
||||
@@ -706,7 +706,7 @@ Sorting can be used instead of filters, or in conjunction with filters, it's you
|
||||
|
||||
#### Release Attributes {#sorting-releases}
|
||||
|
||||
Each [Release Attribute](#release-attribute) has one additional property that can be used to **rank** releases based on the order of the values you give it. This is the `priority` property.
|
||||
Each [Release Attribute](#release-attributes) has one additional property that can be used to **rank** releases based on the order of the values you give it. This is the `priority` property.
|
||||
|
||||
In configuration:
|
||||
|
||||
@@ -777,6 +777,10 @@ In the final sorting of Recordings, title score + artist score is combined with
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Caching
|
||||
|
||||
You **should** setup [metadata caching](/configuration/transforms#caching) to reduce API calls, improve transform performance, and reduce memory usage when using this stage.
|
||||
|
||||
### Sensible Default
|
||||
|
||||
Generally, the Musicbrainz Stage can be used without any of the [optional configuration](#configuration) and you should still see good results from matches. The top [scored](#score) match is, anecdotally, good enough for correcting and filling in surface-level play data like Title and Artist names.
|
||||
@@ -818,7 +822,7 @@ Consider adding [Artist Extraction (`artist`)](#search-methods) in **Native Mode
|
||||
|
||||
How complete, and accurate, your scrobble data is from a certain Source should dictate what [Search Methods](#search-methods) you should use for matching.
|
||||
|
||||
Musicbrainz agressively normalizes **artist, album, and title** fields in its database which means that if your Scrobble data contains major innaccuracies or phrases fields in a non-normal way, it's possible Musicbrainz won't find any matches. This is a more common occurrence when trying to match Scrobble data from Sources that don't support multiple artist data, like [Subsonic](/configuration/sources/subsonic) and [Last.fm](/configuration/sources/lastfm).
|
||||
Musicbrainz agressively normalizes **artist, album, and title** fields in its database which means that if your Scrobble data contains major innaccuracies or phrases fields in a non-normal way, it's possible Musicbrainz won't find any matches. This is a more common occurrence when trying to match Scrobble data from Sources that don't support multiple artist data, like [Subsonic](/configuration/sources/subsonic) and [Last.fm](/configuration/sources/lastfm-source).
|
||||
|
||||
<details>
|
||||
|
||||
@@ -869,7 +873,7 @@ When using your own filters consider:
|
||||
|
||||
### Using Partial Match
|
||||
|
||||
Use [Rules](#rules) to apply MusicBrainz match data selectively.
|
||||
Use [Rules](#rules-and-hooks) to apply MusicBrainz match data selectively.
|
||||
|
||||
If you know that your music collection is well organized and you do not want to change the artists/title/album etc... sent to a [Client](/configuration/clients), you can still benefit from matches by only applying MBIDs using `meta` so that any Client that supports Musicbrainz data ([Koito](/configuration/clients/koito), [Tealfm](/configuration/clients/tealfm), [Listenbrainz](/configuration/clients/listenbrainz), [Rocksky](/configuration/clients/rocksky)) can still get that data.
|
||||
|
||||
@@ -1086,7 +1090,7 @@ Your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
}
|
||||
```
|
||||
|
||||
In a [Jellyfin](/configuration/clients/jellyfin) [File Config](/configuration?configType=file#configuration-types):
|
||||
In a [Jellyfin](/configuration/sources/jellyfin) [File Config](/configuration?configType=file#configuration-types):
|
||||
|
||||
```json5 title="jellyfin.json"
|
||||
[
|
||||
@@ -1119,7 +1123,7 @@ In a [Jellyfin](/configuration/clients/jellyfin) [File Config](/configuration?co
|
||||
* [Sensible Defaults](#sensible-default)
|
||||
* Fallback search with [Artist Extraction](#search-methods)
|
||||
* [Default Native Stage](/configuration/transforms/native/#default-stage)
|
||||
* Uses [Flow Control](/configurations/transforms#flow-control) to run Native only if there are no Musicbrainz matches
|
||||
* Uses [Flow Control](/configuration/transforms#flow-control) to run Native only if there are no Musicbrainz matches
|
||||
|
||||
<details>
|
||||
|
||||
@@ -1153,7 +1157,7 @@ Your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
}
|
||||
```
|
||||
|
||||
In a [Jellyfin](/configuration/clients/jellyfin) [File Config](/configuration?configType=file#configuration-types):
|
||||
In a [Jellyfin](/configuration/sources/jellyfin) [File Config](/configuration?configType=file#configuration-types):
|
||||
|
||||
```json5 title="jellyfin.json"
|
||||
[
|
||||
@@ -1266,4 +1270,122 @@ Stage Configuration
|
||||
]
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Use Metadata for Discord Album Art
|
||||
|
||||
The [Discord](/configuration/clients/discord) Client can fetch album art images from [Cover Art Archive](http://coverartarchive.org/) if the Scrobble data contains a Release MBID. Use the Musicbrainz Stage on the `preCompare` hook for your Discord client so that missing Musicbrainz IDs are populated for this functionality.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
Using the [ENV Configuration](#env-configuration) from above, add these fields to your docker compose `environment:`
|
||||
|
||||
```yaml
|
||||
- MB_CONTACT=contact@mydomain.com
|
||||
- MB_PRESETS=id,native,sensible
|
||||
- DISCORD_TRANSFORMS=musicbrainz
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
Your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
|
||||
```json5 title="config.json"
|
||||
{
|
||||
// ...
|
||||
"transformers": [
|
||||
{
|
||||
"type": "musicbrainz",
|
||||
"name": "MyMB",
|
||||
"data": {
|
||||
"apis": [
|
||||
{
|
||||
"contact": "contact@mydomain.com"
|
||||
}
|
||||
]
|
||||
},
|
||||
"defaults": {
|
||||
// sensible defaults
|
||||
"releaseStatusPriority": ["official"],
|
||||
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
|
||||
"releaseCountryPriority": ["XW"],
|
||||
"searchArtistMethod": "native",
|
||||
"searchOrder": ["isrc","basic", "artist"]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
In your [Discord](/configuration/clients/discord) [File Config](/configuration?configType=file#configuration-types):
|
||||
|
||||
```json5 title="discord.json"
|
||||
[
|
||||
{
|
||||
"name": "MS",
|
||||
"data": { /* ... */},
|
||||
"options": {
|
||||
"playTransform": {
|
||||
"preCompare": [
|
||||
{
|
||||
"type": "musicbrainz",
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
Your [AIO Config](/configuration?configType=aio#configuration-types):
|
||||
|
||||
```json5 title="config.json"
|
||||
{
|
||||
// ...
|
||||
"transformers": [
|
||||
{
|
||||
"type": "musicbrainz",
|
||||
"name": "MyMB",
|
||||
"data": {
|
||||
"apis": [
|
||||
{
|
||||
"contact": "contact@mydomain.com"
|
||||
}
|
||||
]
|
||||
},
|
||||
"defaults": {
|
||||
// sensible defaults
|
||||
"releaseStatusPriority": ["official"],
|
||||
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
|
||||
"releaseCountryPriority": ["XW"],
|
||||
"searchArtistMethod": "native",
|
||||
"searchOrder": ["isrc","basic", "artist"]
|
||||
}
|
||||
}
|
||||
],
|
||||
"sources": [
|
||||
{
|
||||
"name": "MS",
|
||||
"type": "discord",
|
||||
"data": { /* ... */},
|
||||
"options": {
|
||||
"playTransform": {
|
||||
"preCompare": [
|
||||
{
|
||||
"type": "musicbrainz",
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</details>
|
||||
@@ -75,7 +75,7 @@ Config => extracted artists
|
||||
|
||||
### Rules
|
||||
|
||||
Each [Rule](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition.](/configuration/transforms#conditional-moditication):
|
||||
Each [Rule](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition.](/configuration/transforms#conditional-modification):
|
||||
|
||||
```json5
|
||||
{
|
||||
@@ -96,7 +96,7 @@ If a rule is not present then multi-scrobbler defaults it to `true`.
|
||||
|
||||
For your convenience, if you do not define any Native [Stage Configurations](/configuration/transforms#configuring-stages) then multi-scrobbler automatically builds one using the defaults shown in [configuration](#configuration).
|
||||
|
||||
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#modification-stage).
|
||||
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#stage).
|
||||
|
||||
<details>
|
||||
|
||||
@@ -132,7 +132,7 @@ Use ENV `*_TRANSFORMS=native` on each Source/Client you wish to apply this stage
|
||||
|
||||
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this. Example
|
||||
|
||||
* All [Subsonic Source](http://localhost:3000/docs/configuration/sources/subsonic/) ENVs look like `SUBSONIC_USER=myuser` etc...
|
||||
* All [Subsonic Source](/configuration/sources/subsonic/) ENVs look like `SUBSONIC_USER=myuser` etc...
|
||||
* Use `SUBSONIC_TRANSFORMS=native`
|
||||
|
||||
<details>
|
||||
|
||||
@@ -36,7 +36,7 @@ Scrobble **Clients** listen for discovered Plays from Sources, then...
|
||||
* The Client **compares** this Play to all the other scrobbles it has already seen, if the Play is unique (title/artist/album/listened datetime) then...
|
||||
* The Client **scrobbles** the Play downstream to the scrobble service and adds it as a Scrobble it has seen already
|
||||
|
||||
## Lifecyle Hooks
|
||||
## Lifecycle Hooks
|
||||
|
||||
You'll notice there is a pattern above that looks like this:
|
||||
|
||||
@@ -376,7 +376,7 @@ Specifying these Rules is **not** the same as [configuring the Stage](#configuri
|
||||
|
||||
Stages may be optionally configured to **continue** to the next Stage or **stop** (end early) all subsequent Stages, based on the outcome of the currently running Stage.
|
||||
|
||||
These three properties can be added to the [Modification Stage](#modification-stage) data, alongside [Rules](#rules-for-play-data):
|
||||
These three properties can be added to the [Modification Stage](#stage) data, alongside [Rules](#stage-rules):
|
||||
|
||||
* `onSuccess` (default `continue`) - If the Stage successfully finishes processing
|
||||
* `onFailure` (default `stop`) - If the Stage encounters an error while processing, or otherwise fails to achieve the transformation result
|
||||
@@ -585,6 +585,47 @@ The output shows the diff between the previous stage (or original Play) and the
|
||||
|
||||
</details>
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Caching
|
||||
|
||||
MS uses [caching](/configuration/#caching) to reduce the number of API calls needed for stages like [Musicbrainz](/configuration/transforms/musicbrainz) and to speed up all transforms by caching steps and results. However, the default caching strategy uses a small cache size and very short [TTLs](https://en.wikipedia.org/wiki/Time_to_live) because it is *in-memory*.
|
||||
|
||||
**If you are using any Transform stages you should configure [secondary caching with Valkey for Metadata](/configuration/?cacheType=valkey&cachedThings=metadata#secondary-caching-configuration)** to increase the cache size and lifetime of cached items. This will also reduce memory usage in MS.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
Add valkey service to your [multi-scrobbler docker compose stack](/installation?runType=docker-compose#docker) and configure MS to use it for metadata:
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
# ...
|
||||
environment:
|
||||
# ...
|
||||
// highlight-start
|
||||
- CACHE_METADATA=valkey
|
||||
- CACHE_METADATA_CONN=redis://valkey:6379
|
||||
// highlight-end
|
||||
# ...
|
||||
|
||||
// highlight-start
|
||||
valkey:
|
||||
image: valkey/valkey
|
||||
volumes:
|
||||
- valkeydata:/data
|
||||
|
||||
volumes:
|
||||
valkeydata:
|
||||
driver: local
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Examples
|
||||
|
||||
See **Examples** sections in specific Stage docs (also in the sidebar):
|
||||
|
||||
@@ -16,7 +16,7 @@ The user [Stage `type`](/configuration/transforms#stage) is `user`.
|
||||
|
||||
## Configuration
|
||||
|
||||
All [Stage Configuration](/configuration/transforms#configuring-stage) is done using [**search-and-replace** expressions](#search-and-replace-expression) inside individual [rules](#rules). Default configuration for all Rules can still be done using Stage `defaults`.
|
||||
All [Stage Configuration](/configuration/transforms#configuring-stages) is done using [**search-and-replace** expressions](#search-and-replace-expression) inside individual [rules](#rules). Default configuration for all Rules can still be done using Stage `defaults`.
|
||||
|
||||
<details>
|
||||
|
||||
@@ -46,9 +46,9 @@ All [Stage Configuration](/configuration/transforms#configuring-stage) is done u
|
||||
|
||||
#### Default Stage
|
||||
|
||||
For your convenience, if you do not define any User [Stage Configurations](/configuration/transforms#configuration) then multi-scrobbler automatically builds an empty one for you.
|
||||
For your convenience, if you do not define any User [Stage Configurations](/configuration/transforms#configuring-stages) then multi-scrobbler automatically builds an empty one for you.
|
||||
|
||||
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#modification-stage).
|
||||
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#stage).
|
||||
|
||||
<details>
|
||||
|
||||
@@ -126,7 +126,7 @@ The `replace` property uses javascript's [`replace()` function and so can use an
|
||||
|
||||
### Rules
|
||||
|
||||
Each [Rule](/configuration/transforms#stage-rules) must be an array of [search-and-replace expressions](#search-and-replace-expressions):
|
||||
Each [Rule](/configuration/transforms#stage-rules) must be an array of [search-and-replace expressions](#search-and-replace-expression):
|
||||
|
||||
```json5 title="lastfm.json"
|
||||
[
|
||||
|
||||
@@ -54,7 +54,7 @@ Thank you for your time.
|
||||
|
||||
### FAQ
|
||||
|
||||
Check the [FAQ](/faq) to see if your issue is a known issue or a commonly-experienced issue with Multi-Scrobbler. The FAQ also includes fixes or ways to help troubleshoot these common issues.
|
||||
Check the [FAQ](/FAQ) to see if your issue is a known issue or a commonly-experienced issue with Multi-Scrobbler. The FAQ also includes fixes or ways to help troubleshoot these common issues.
|
||||
|
||||
### Existing Issues
|
||||
|
||||
|
||||
@@ -31,6 +31,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a
|
||||
* [MPD (Music Player Daemon)](/configuration/sources/mpd)
|
||||
* [MPRIS (Linux Desktop)](/configuration/sources/mpris)
|
||||
* [Musikcube](/configuration/sources/musikcube)
|
||||
* [Music Assistant](/configuration/sources/listenbrainz-endpoint#setup-for-popular-apps)
|
||||
* [Plex](/configuration/sources/plex)
|
||||
* [Rocksky](/configuration/sources/rocksky-source)
|
||||
* [Sonos](/configuration/sources/sonos)
|
||||
@@ -42,6 +43,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a
|
||||
* [Yamaha MusicCast](/configuration/sources/yamaha-musiccast)
|
||||
* [Youtube Music](/configuration/sources/youtube-music)
|
||||
* Supports scrobbling to many [**Clients**](/configuration/clients)
|
||||
* [Discord](/configuration/clients/discord) (Now Playing)
|
||||
* [Koito](/configuration/clients/koito)
|
||||
* [Last.fm](/configuration/clients/lastfm)
|
||||
* [Libre.fm](/configuration/clients/librefm)
|
||||
|
||||
@@ -37,81 +37,39 @@ Cross-platform images are built for x86 (Intel/AMD) and ARM64 (IE Raspberry Pi)
|
||||
|
||||
:::
|
||||
|
||||
Or use the example `docker-compose.yml`, found in the repo, after modifying it to fit your configuration:
|
||||
### Recommended Settings
|
||||
|
||||
<details>
|
||||
<Tabs groupId="dockerSetting" queryString>
|
||||
<TabItem value="storage" label="Storage">
|
||||
You **should** bind a host directory into the container for storing configurations and credentials. Otherwise, these will be lost when the container is updated.
|
||||
|
||||
<summary>`docker-compose.yml`</summary>
|
||||
|
||||
<CodeBlock language="yaml">{ComposeStack}</CodeBlock>
|
||||
|
||||
</details>
|
||||
|
||||
Recommended configuration steps for docker or docker-compose usage:
|
||||
|
||||
#### Storage
|
||||
|
||||
You should bind a host directory into the container for storing configurations and credentials. Otherwise, these will be lost when the container is updated.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<Tabs groupId="runType" queryString>
|
||||
<TabItem value="docker" label="Docker">
|
||||
[Using `-v` method for docker](https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount):
|
||||
```shell
|
||||
docker run ... -v "$(pwd)/config:/config" foxxmd/multi-scrobbler
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
[Using docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-3):
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
volumes:
|
||||
- "./config:/config"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</details>
|
||||
|
||||
#### Networking
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
// highlight-start
|
||||
volumes:
|
||||
- "./config:/config"
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="networking" label="Networking">
|
||||
If you are using a [bridge network](https://www.appsdeveloperblog.com/docker-networking-bridging-host-and-overlay/) (default docker setup) you must map a port to the container in order to access the dashboard and use MS with some sources (Webscrobbler, LFM/LZ Endpoints). The default container port is `9078`.
|
||||
|
||||
<details>
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
// highlight-start
|
||||
ports:
|
||||
- "9078:9078"
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
<summary>Example</summary>
|
||||
|
||||
<Tabs groupId="runType" queryString>
|
||||
<TabItem value="docker" label="Docker">
|
||||
[Docker `run` publish options](https://docs.docker.com/engine/reference/commandline/run/#publish):
|
||||
```shell
|
||||
docker run ... -p 9078:9078 foxxmd/multi-scrobbler
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
[docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-1):
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
ports:
|
||||
- "9078:9078"
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
</details>
|
||||
|
||||
##### Base URL
|
||||
|
||||
Optionally, when
|
||||
</TabItem>
|
||||
<TabItem value="baseUrl" label="Base URL">
|
||||
**Optionally**, when
|
||||
|
||||
* using a [Source or Client](../configuration/configuration.mdx) that has a "Redirect URI" that you have not explicitly defined
|
||||
* and
|
||||
@@ -120,63 +78,89 @@ Optionally, when
|
||||
|
||||
set the [Base URL](../configuration/configuration.mdx#base-url) as the IP of the host machine. (This is the IP you would use to view the dashboard in a browser)
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Example</summary>
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
environment:
|
||||
// highlight-start
|
||||
- BASE_URL=http://hostMachineIP
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
<Tabs groupId="runType" queryString>
|
||||
<TabItem value="docker" label="Docker">
|
||||
```shell
|
||||
docker run ... -e BASE_URL="http://hostMachineIP" foxxmd/multi-scrobbler
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
[docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-1):
|
||||
</TabItem>
|
||||
<TabItem value="tz" label="Timezone">
|
||||
Set the [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the container using the environmental variable `TZ`.
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
environment:
|
||||
- BASE_URL=http://hostMachineIP
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
# ...
|
||||
environment:
|
||||
# Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
// highlight-start
|
||||
- TZ=America/New_York
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### Other
|
||||
|
||||
* (Optionally) set the [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the container using the environmental variable `TZ` ([docker](https://docs.docker.com/engine/reference/commandline/run/#env)) ([docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#environment))
|
||||
|
||||
#### Linux Host
|
||||
|
||||
::::info
|
||||
|
||||
If you are running this container with **Docker** on a **Linux Host** you must specify `user:group` permissions of the user who owns the **configuration directory** on the host to avoid [docker file permission problems.](https://ikriv.com/blog/?p=4698) These can be specified using the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-puid-and-pgid)
|
||||
</TabItem>
|
||||
<TabItem value="linuxHost" label="Linux Host">
|
||||
If you are running this container with **Docker** on a **Linux Host** you **should** specify `user:group` permissions of the user who owns the **configuration directory** on the host to avoid [docker file permission problems.](https://ikriv.com/blog/?p=4698) These can be specified using the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-puid-and-pgid)
|
||||
|
||||
To get the UID and GID for the current user run these commands from a terminal:
|
||||
|
||||
* `id -u` -- prints UID
|
||||
* `id -g` -- prints GID
|
||||
|
||||
::::
|
||||
|
||||
#### Read Only
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="ro" label="Read Only">
|
||||
MS can be hardended by setting the file system as read only with [`read_only`](https://docs.docker.com/reference/compose-file/services/#read_only), with a few exceptions:
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
# ...
|
||||
read_only: true
|
||||
tmpfs:
|
||||
- /run:exec
|
||||
- /tmp:noexec
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
# ...
|
||||
// highlight-start
|
||||
read_only: true
|
||||
tmpfs:
|
||||
- /run:exec
|
||||
- /tmp:noexec
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="caching" label="Caching">
|
||||
**Optionally**, add a [Valkey](https://valkey.io/) service to your stack for [secondary caching](/configuration/?cacheType=valkey#secondary-caching-configuration) to take advantage of faster performance and reduced memory usage.
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
# ...
|
||||
environment:
|
||||
# ...
|
||||
// highlight-start
|
||||
CACHE_METADATA=valkey
|
||||
CACHE_METADATA_CONN=redis://valkey:6379
|
||||
// highlight-end
|
||||
# ...
|
||||
|
||||
// highlight-start
|
||||
valkey:
|
||||
image: valkey/valkey
|
||||
volumes:
|
||||
- valkeydata:/data
|
||||
|
||||
volumes:
|
||||
valkeydata:
|
||||
driver: local
|
||||
// highlight-end
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Docker Usage Example
|
||||
|
||||
:::tip
|
||||
@@ -193,49 +177,43 @@ The example scenario:
|
||||
* Docker container located on a different IP (`192.168.0.100`) so use [Base URL](/configuration#base-url)
|
||||
* Config/data directory on host machine in a directory next to `docker-compose.yml`
|
||||
* Linux uid/gid is `1000:1000`
|
||||
* Optional caching using valkey (after uncommenting)
|
||||
|
||||
<Tabs groupId="runType" queryString>
|
||||
<TabItem value="docker" label="Docker">
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
```bash
|
||||
docker run --name multi-scrobbler -e "JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56bd6540c" -e "JELLYFIN_URL=192.168.0.101:8096" -e "JELLYFIN_USER=MyUser" -e "BASE_URL=192.168.0.100" -e "MALOJA_URL=http://domain.tld" -e "MALOJA_API_KEY=1234" -e "PUID=1000" -e "PGID=1000" -p 9078:9078 -v /home/myUser/ms:/config foxxmd/multi-scrobbler
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
```bash
|
||||
docker run --name multi-scrobbler -e "PUID=1000" -e "PGID=1000" -e "BASE_URL=192.168.0.100" -p 9078:9078 -v "$(pwd)/config:/config" foxxmd/multi-scrobbler
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
See [`docker-compose.yml`](#docker) sample above for more options and annotations.
|
||||
See [`docker-compose.yml`](#docker) sample above for more options and annotations.
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
container_name: multi-scrobbler
|
||||
environment:
|
||||
- TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
- JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56bd6540c
|
||||
- JELLYFIN_URL=192.168.0.101:8096
|
||||
- JELLYFIN_USER=MyUser
|
||||
- BASE_URL=http://192.168.0.100:9078
|
||||
- MALOJA_URL=http://domain.tld:42010
|
||||
- MALOJA_API_KEY=1234
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
volumes:
|
||||
- "./config:/config"
|
||||
ports:
|
||||
- "9078:9078"
|
||||
restart: unless-stopped
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
```yaml title="docker-compose.yml"
|
||||
services:
|
||||
multi-scrobbler:
|
||||
image: foxxmd/multi-scrobbler
|
||||
container_name: multi-scrobbler
|
||||
environment:
|
||||
- TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
- JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56bd6540c
|
||||
- JELLYFIN_URL=192.168.0.101:8096
|
||||
- JELLYFIN_USER=MyUser
|
||||
- BASE_URL=http://192.168.0.100:9078
|
||||
- MALOJA_URL=http://domain.tld:42010
|
||||
- MALOJA_API_KEY=1234
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
# uncomment along with valkey service/volume below for better caching
|
||||
#- CACHE_METADATA=valkey
|
||||
#- CACHE_METADATA_CONN=redis://valkey:6379
|
||||
volumes:
|
||||
- ./config:/config
|
||||
ports:
|
||||
- 9078:9078
|
||||
restart: unless-stopped
|
||||
|
||||
#valkey:
|
||||
# image: valkey/valkey
|
||||
# volumes:
|
||||
# - valkeydata:/data
|
||||
|
||||
#volumes:
|
||||
# valkeydata:
|
||||
# driver: local
|
||||
```
|
||||
## Local Installation
|
||||
|
||||
After installation see [service.md](service.md) to configure multi-scrobbler to run automatically in the background.
|
||||
|
||||
@@ -10,7 +10,7 @@ This guide will get you up and running with multi-scrobbler using [Docker](https
|
||||
|
||||
* the dashboard served on port `9078` of a host machine which has an IP of `192.168.0.100`
|
||||
* data saved to the same directory as the `docker-compose.yml` file
|
||||
* multi-scrobbler monitoring [Spotify](/configuration/sources/spotify), [Jellyfin](/configuration/sources/jellyfin), Navidrome, [Plex](/configuration/sources/plex), and/or [Last.fm](/configurations/sources/lastfm) for listening activity
|
||||
* multi-scrobbler monitoring [Spotify](/configuration/sources/spotify), [Jellyfin](/configuration/sources/jellyfin), Navidrome, [Plex](/configuration/sources/plex), and/or [Last.fm](/configuration/sources/lastfm-source) for listening activity
|
||||
* multi-scrobbler scrobbling to [Lastfm](/configuration/clients/lastfm), [Maloja](/configuration/clients/maloja), and/or [Koito](/configuration/clients/koito)
|
||||
|
||||
:::note
|
||||
@@ -166,7 +166,7 @@ Add these value to the `environment` section in the [`docker-compose.yml` you cr
|
||||
- MB_PRESETS=default,sensible,native
|
||||
```
|
||||
|
||||
**Presets** are found [here](http://localhost:3000/docs/configuration/transforms/musicbrainz/#env-configuration).
|
||||
**Presets** are found [here](/configuration/transforms/musicbrainz/#env-configuration).
|
||||
|
||||
<h3>Enable Musicbrainz For A Source</h3>
|
||||
|
||||
@@ -314,7 +314,7 @@ Modify the `lastfm.json` file you created in the [Setup Sources](#setup-sources)
|
||||
|
||||
:::tip
|
||||
|
||||
If you are running your multi-scrobbler container on a Linux host see [these instructions for setting proper file permissions.](/installation#linux-host)
|
||||
If you are running your multi-scrobbler container on a Linux host see [these instructions for setting proper file permissions.](/installation?dockerSetting=linuxHost#recommended-settings)
|
||||
|
||||
:::
|
||||
|
||||
@@ -336,6 +336,7 @@ Visit `http://192.168.0.100:9078` to see the dashboard where
|
||||
## Next Steps
|
||||
|
||||
* See more advanced docker options as well as other install methods in the [**Installation**](/installation#docker) docs
|
||||
* Setup [secondary caching](/configuration/?cacheType=valkey#secondary-caching-configuration) with [valkey](/installation?dockerSetting=caching#recommended-settings) for increased performance and reduced memory usage
|
||||
* Review the [**Configuration**](/configuration) docs
|
||||
* Learn about how to configure multi-scrobbler using files for more complicated Source/Client scenarios
|
||||
* See all available [**Sources**](/configuration/sources) and [**Clients**](/configuration/clients) alongside configuration examples
|
||||
|
||||
@@ -71,7 +71,7 @@ const config: Config = {
|
||||
],
|
||||
],
|
||||
themes: [
|
||||
"docusaurus-json-schema-plugin",
|
||||
//"docusaurus-json-schema-plugin",
|
||||
[
|
||||
"@easyops-cn/docusaurus-search-local",
|
||||
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
|
||||
@@ -90,6 +90,7 @@ const config: Config = {
|
||||
'docusaurus-theme-github-codeblock'
|
||||
],
|
||||
plugins: [
|
||||
'docusaurus-plugin-sass',
|
||||
[
|
||||
'@docusaurus/plugin-client-redirects',
|
||||
{
|
||||
@@ -160,7 +161,7 @@ const config: Config = {
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
@@ -251,4 +252,20 @@ if (process.env.RY_ANALYTICS !== undefined && process.env.RY_ANALYTICS !== '') {
|
||||
config.scripts.push(script)
|
||||
}
|
||||
|
||||
if(process.env.NETLIFY === 'true') {
|
||||
// @ts-ignore
|
||||
config.themeConfig.footer.links.push({
|
||||
title: 'Docs Powered By',
|
||||
items: [
|
||||
{
|
||||
html: `
|
||||
<a href="https://www.netlify.com">
|
||||
<img src="https://www.netlify.com/assets/badges/netlify-badge-color-accent.svg" alt="Deploys by Netlify" />
|
||||
</a>
|
||||
`
|
||||
}
|
||||
]
|
||||
});
|
||||
}
|
||||
|
||||
export default config;
|
||||
|
||||
@@ -11,7 +11,8 @@
|
||||
"serve": "docusaurus serve",
|
||||
"write-translations": "docusaurus write-translations",
|
||||
"write-heading-ids": "docusaurus write-heading-ids",
|
||||
"typecheck": "tsc"
|
||||
"typecheck": "tsc",
|
||||
"postinstall": "patch-package"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.8.1",
|
||||
@@ -20,15 +21,22 @@
|
||||
"@docusaurus/preset-classic": "3.8.1",
|
||||
"@easyops-cn/docusaurus-search-local": "0.51.1",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"ajv": "^8.18.0",
|
||||
"ajv-formats": "^3.0.1",
|
||||
"cf-json-schema-viz": "^0.3.0",
|
||||
"clsx": "^2.0.0",
|
||||
"docusaurus-json-schema-plugin": "^1.14.0",
|
||||
"docusaurus-plugin-sass": "^0.2.6",
|
||||
"docusaurus-theme-github-codeblock": "^2.0.2",
|
||||
"json5": "^2.2.3",
|
||||
"micromark-extension-directive": "^3.0.1",
|
||||
"modern-react-json-editor": "^1.0.2",
|
||||
"patch-package": "^8.0.1",
|
||||
"prism-react-renderer": "^2.3.0",
|
||||
"raw-loader": "^4.0.2",
|
||||
"react": "^19.0.0",
|
||||
"react-dom": "^19.0.0"
|
||||
"react-dom": "^19.0.0",
|
||||
"react-markdown": "^10.1.0",
|
||||
"sass": "^1.97.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "^3.6.3",
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
import React, { ReactNode, CSSProperties } from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Link from '@docusaurus/Link';
|
||||
|
||||
// Define the Button type to control the props that can be passed to the Button component.
|
||||
export type ButtonProps = {
|
||||
// The size prop can be one of the following values: 'sm', 'lg', 'small', 'medium', 'large', or null.
|
||||
// We'll convert 'small' to 'sm' and 'large' to 'lg' in the component. 'medium' will be considered null.
|
||||
size?: 'sm' | 'lg' | 'small' | 'medium' | 'large' | null;
|
||||
// The outline prop is a boolean that determines if the button should be an outline button.
|
||||
outline?: boolean;
|
||||
// The variant prop is a string that determines the color of the button.
|
||||
// It can be one of the following values: 'primary', 'secondary', 'danger', 'warning', 'success', 'info', 'link', or any other string.
|
||||
// The default value is 'primary'.
|
||||
variant: 'primary' | 'secondary' | 'danger' | 'warning' | 'success' | 'info' | 'link' | string;
|
||||
// The block prop is a boolean that determines if the button should be a block-level button.
|
||||
block?: boolean;
|
||||
// The disabled prop is a boolean that determines if the button should be disabled.
|
||||
disabled?: boolean;
|
||||
// The className prop is a string that allows you to add custom classes to the button.
|
||||
className?: string;
|
||||
// The style prop is an object that allows you to add custom styles to the button.
|
||||
style?: CSSProperties;
|
||||
// The link prop is a string that determines the URL the button should link to.
|
||||
link: string;
|
||||
// The label prop is a string that determines the text of the button.
|
||||
label: string;
|
||||
onClick?: () => any
|
||||
}
|
||||
|
||||
// Button component that accepts the specified props.
|
||||
export default function Button ({
|
||||
size = null,
|
||||
outline = false,
|
||||
variant = 'primary',
|
||||
block = false,
|
||||
disabled = false,
|
||||
className,
|
||||
style = {},
|
||||
link,
|
||||
label,
|
||||
onClick = () => null,
|
||||
...rest
|
||||
}: ButtonProps) {
|
||||
// Map the size prop values to corresponding CSS classes.
|
||||
const sizeMap = {
|
||||
sm: 'sm',
|
||||
small: 'sm',
|
||||
lg: 'lg',
|
||||
large: 'lg',
|
||||
medium: null,
|
||||
};
|
||||
const buttonSize = size ? sizeMap[size] : '';
|
||||
const sizeClass = buttonSize ? `button--${buttonSize}` : '';
|
||||
const outlineClass = outline ? 'button--outline' : '';
|
||||
const variantClass = variant ? `button--${variant}` : '';
|
||||
const blockClass = block ? 'button--block' : '';
|
||||
const disabledClass = disabled ? 'disabled' : '';
|
||||
// If the button is disabled, set the destination to null.
|
||||
const destination = disabled ? null : link;
|
||||
return (
|
||||
<Link to={destination}>
|
||||
<button
|
||||
className={clsx(
|
||||
'button',
|
||||
sizeClass,
|
||||
outlineClass,
|
||||
variantClass,
|
||||
blockClass,
|
||||
disabledClass,
|
||||
className
|
||||
)}
|
||||
style={style}
|
||||
role='button'
|
||||
aria-disabled={disabled}
|
||||
onClick={(e) => {
|
||||
e.preventDefault();
|
||||
onClick()
|
||||
}}
|
||||
{...rest}
|
||||
>
|
||||
{label}
|
||||
</button>
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
import React, { ReactNode, CSSProperties } from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Link from '@docusaurus/Link';
|
||||
import Button, { ButtonProps } from './Button';
|
||||
|
||||
const leftButton = {
|
||||
borderRadius: 'var(--ifm-button-border-radius) 0 0 var(--ifm-button-border-radius)'
|
||||
}
|
||||
|
||||
const rightButton = {
|
||||
borderRadius: '0 var(--ifm-button-border-radius) var(--ifm-button-border-radius) 0'
|
||||
}
|
||||
|
||||
const middleButton = {
|
||||
borderRadius: '0'
|
||||
}
|
||||
|
||||
// Define the Button type to control the props that can be passed to the Button component.
|
||||
type ButtonGroup = {
|
||||
options: [string, string][]
|
||||
value?: string
|
||||
defaultValue?: string
|
||||
// The size prop can be one of the following values: 'sm', 'lg', 'small', 'medium', 'large', or null.
|
||||
// We'll convert 'small' to 'sm' and 'large' to 'lg' in the component. 'medium' will be considered null.
|
||||
size?: 'sm' | 'lg' | 'small' | 'medium' | 'large' | null;
|
||||
|
||||
variant: 'primary' | 'secondary' | 'danger' | 'warning' | 'success' | 'info' | 'link' | string;
|
||||
// The block prop is a boolean that determines if the button should be a block-level button.
|
||||
block?: boolean;
|
||||
// The disabled prop is a boolean that determines if the button should be disabled.
|
||||
disabled?: boolean;
|
||||
// The className prop is a string that allows you to add custom classes to the button.
|
||||
className?: string;
|
||||
// The style prop is an object that allows you to add custom styles to the button.
|
||||
style?: CSSProperties;
|
||||
onChange?: (val: string) => any
|
||||
}
|
||||
|
||||
// Button component that accepts the specified props.
|
||||
export default function ButtonGroup ({
|
||||
size = null,
|
||||
variant = 'primary',
|
||||
block = false,
|
||||
disabled = false,
|
||||
className,
|
||||
style,
|
||||
options,
|
||||
value,
|
||||
defaultValue,
|
||||
onChange = () => null
|
||||
}: ButtonGroup) {
|
||||
|
||||
if(options === undefined || options.length === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const buttons = options.map((opt, index) => {
|
||||
const props: ButtonProps = {
|
||||
style: middleButton,
|
||||
outline: true,
|
||||
size,
|
||||
variant,
|
||||
label: opt[1],
|
||||
link: '#',
|
||||
onClick: () => onChange(opt[0])
|
||||
};
|
||||
if(index === 0) {
|
||||
props.style = leftButton;
|
||||
} else if(index === options.length - 1) {
|
||||
props.style = rightButton;
|
||||
}
|
||||
|
||||
if((value ?? defaultValue) === opt[0]) {
|
||||
props.outline = false;
|
||||
}
|
||||
|
||||
return <Button key={index} {...props}/>
|
||||
|
||||
});
|
||||
|
||||
return <span>{buttons}</span>;
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
import React, { Fragment, useMemo } from "react"
|
||||
import CodeBlock, {Props as CodeBlockProps} from '@theme/CodeBlock';
|
||||
import Admonition from '@theme/Admonition';
|
||||
import ErrorBoundary from "@docusaurus/ErrorBoundary"
|
||||
import Error from "@theme/Error"
|
||||
import { Simulate } from "react-dom/test-utils";
|
||||
import error = Simulate.error;
|
||||
import json5 from 'json5';
|
||||
import FileExample, { FileProps } from "./FileExample";
|
||||
|
||||
export interface FileConfigProps extends FileProps {
|
||||
data: string
|
||||
name: string
|
||||
configureAs?: 'client' | 'source'
|
||||
aio?: boolean
|
||||
filePathName?: string
|
||||
}
|
||||
|
||||
const FileConfigExample = (props: FileConfigProps) => {
|
||||
const {
|
||||
data,
|
||||
configureAs = 'source',
|
||||
aio = false,
|
||||
name,
|
||||
...rest
|
||||
} = props;
|
||||
|
||||
let configObj;
|
||||
// eslint-disable-next-line prefer-const
|
||||
try {
|
||||
configObj = json5.parse(data) as object[];
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
return <Admonition type="danger" title="Unexpected Error">
|
||||
<p>Example component crashed because of error!</p>
|
||||
<CodeBlock>{e.message}</CodeBlock>
|
||||
</Admonition>
|
||||
}
|
||||
|
||||
const transformed = useMemo(() => {
|
||||
let content: object;
|
||||
if(typeof data === 'string') {
|
||||
content = json5.parse(data);
|
||||
} else {
|
||||
content = data;
|
||||
}
|
||||
if(configureAs !== undefined && Array.isArray(content)) {
|
||||
const filtered = content.filter(x => x.configureAs === undefined || x.configureAs === configureAs);
|
||||
if(aio) {
|
||||
const configType = configureAs === 'client' ? 'clients' : 'sources';
|
||||
content = {[configType]: filtered.map(x => ({...x, type: name}))}
|
||||
} else {
|
||||
content = filtered;
|
||||
}
|
||||
}
|
||||
return content;
|
||||
},[data, configureAs, aio, name])
|
||||
|
||||
configObj = configObj.filter(x => x.configureAs === undefined || x.configureAs === configureAs);
|
||||
|
||||
return <FileExample data={transformed} {...rest}/>
|
||||
}
|
||||
|
||||
const WrappedFileConfigExample = (props: FileConfigProps) => {
|
||||
return <ErrorBoundary
|
||||
fallback={({error}) => (
|
||||
<div>
|
||||
<p>Example component crashed because of error: {error.message}.</p>
|
||||
</div>
|
||||
)}
|
||||
><FileConfigExample {...props} /></ErrorBoundary>
|
||||
}
|
||||
|
||||
export default WrappedFileConfigExample;
|
||||
@@ -1,44 +1,90 @@
|
||||
import React, { Fragment } from "react"
|
||||
import CodeBlock, {Props as CodeBlockProps} from '@theme/CodeBlock';
|
||||
import React, { Fragment, useMemo } from "react"
|
||||
import CodeBlock, { Props as CodeBlockProps } from '@theme/CodeBlock';
|
||||
import Admonition from '@theme/Admonition';
|
||||
import ErrorBoundary from "@docusaurus/ErrorBoundary"
|
||||
import Error from "@theme/Error"
|
||||
import { Simulate } from "react-dom/test-utils";
|
||||
import error = Simulate.error;
|
||||
import json5 from 'json5';
|
||||
import { useTypedLocalStorage } from "./useLocalStorage";
|
||||
import ButtonGroup from "./ButtonGroup";
|
||||
import EditorFetch from '@site/src/components/Schema/SchemaEditorFetch';
|
||||
import {useWindowSize} from '@docusaurus/theme-common';
|
||||
|
||||
export interface FileProps extends Omit<CodeBlockProps, 'children'> {
|
||||
data: string
|
||||
client?: boolean
|
||||
data: string | object
|
||||
filePathName?: string
|
||||
schemaName?: string
|
||||
interactive?: boolean
|
||||
defaultDisplay?: 'plain' | 'interactive'
|
||||
readOnlyAtWidth?: number
|
||||
}
|
||||
|
||||
const FileExample = (props: FileProps) => {
|
||||
const {
|
||||
data,
|
||||
client = false,
|
||||
interactive = true,
|
||||
defaultDisplay = 'interactive',
|
||||
schemaName,
|
||||
filePathName,
|
||||
readOnlyAtWidth = 1,
|
||||
...rest
|
||||
} = props;
|
||||
|
||||
let configObj;
|
||||
// eslint-disable-next-line prefer-const
|
||||
try {
|
||||
configObj = json5.parse(data) as object[];
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
return <Admonition type="danger" title="Unexpected Error">
|
||||
<p>Example component crashed because of error!</p>
|
||||
<CodeBlock>{e.message}</CodeBlock>
|
||||
</Admonition>
|
||||
const [fileExampleShow, setFileExampleShow] = useTypedLocalStorage('docusaurus.tab.fileExampleShow', defaultDisplay, false);
|
||||
|
||||
const windowSize = useWindowSize({desktopBreakpoint: readOnlyAtWidth});
|
||||
|
||||
let displaySwitch = null;
|
||||
|
||||
const isInteractive = interactive && windowSize === 'desktop'
|
||||
|
||||
if (isInteractive) {
|
||||
displaySwitch = (
|
||||
<ButtonGroup
|
||||
options={[['plain', 'Plain'], ['interactive', 'Interactive']]}
|
||||
defaultValue={defaultDisplay}
|
||||
value={fileExampleShow}
|
||||
variant="primary"
|
||||
size="medium"
|
||||
onChange={(val) => setFileExampleShow(val as 'interactive' | 'plain')}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
configObj = configObj.filter(x => x.configureAs === undefined || x.configureAs === (client ? 'client' : 'source'));
|
||||
let fileNameContent = null;
|
||||
if(filePathName !== undefined && (isInteractive && fileExampleShow === 'interactive')) {
|
||||
fileNameContent = <code style={{float: 'right', paddingRight: '0.5em', paddingLeft: '0.5em'}}>{filePathName}</code>
|
||||
}
|
||||
|
||||
return <CodeBlock {...rest} language="json5">{JSON.stringify(configObj, null, 2)}</CodeBlock>
|
||||
let header = null;
|
||||
if(displaySwitch !== null || fileNameContent !== null) {
|
||||
header = (
|
||||
<div style={{marginBottom: '1em'}}>
|
||||
{displaySwitch}{fileNameContent}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
const codeBlockContent = useMemo(() =>{
|
||||
if(isInteractive && fileExampleShow === 'interactive') {
|
||||
return null;
|
||||
}
|
||||
if(typeof data !== 'string') {
|
||||
return JSON.stringify(data, null, 2);
|
||||
}
|
||||
return data;
|
||||
}, [interactive, fileExampleShow, data]);
|
||||
|
||||
return (<Fragment>
|
||||
{header}
|
||||
{!isInteractive || fileExampleShow === 'plain' ? <CodeBlock title={filePathName} language="json5">{codeBlockContent}</CodeBlock> : null}
|
||||
{isInteractive && fileExampleShow === 'interactive' ? <EditorFetch configContent={data} schemaName={schemaName}/> : null}
|
||||
</Fragment>
|
||||
);
|
||||
}
|
||||
|
||||
const WrappedFileExample = (props: FileProps) => {
|
||||
return <ErrorBoundary
|
||||
fallback={({error}) => (
|
||||
fallback={({ error }) => (
|
||||
<div>
|
||||
<p>Example component crashed because of error: {error.message}.</p>
|
||||
</div>
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import ExplorerFetch from '@site/src/components/Schema/ExplorerFetch';
|
||||
import EditorFetch from '@site/src/components/Schema/SchemaEditorFetch';
|
||||
import './GenericConfiguration.scss';
|
||||
import FileConfigExample from './FileConfigExample';
|
||||
import {useWindowSize} from '@docusaurus/theme-common';
|
||||
|
||||
<Tabs groupId="configType" queryString>
|
||||
<TabItem value="env" label="ENV">
|
||||
@@ -10,19 +15,96 @@ import CodeBlock from '@theme/CodeBlock';
|
||||
</TabItem>
|
||||
<TabItem value="file" label="File">
|
||||
<FileType>
|
||||
<div
|
||||
className="schemaWrapper"
|
||||
style={{
|
||||
display: "flex"
|
||||
}}
|
||||
>
|
||||
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
|
||||
<DetailsAdmo type="note" summary="Config Structure">
|
||||
This displays the **structure** of the [File Configuration](/configuration?configType=aio#configuration-types) for a <strong children={props.name}/> type <strong children={props.client ? 'Client' : 'Source'}/> with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.
|
||||
</DetailsAdmo>
|
||||
<ExplorerFetch name={`schemas/${props.config}`} />
|
||||
</div>
|
||||
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
|
||||
<div className="fileEditor">
|
||||
<DetailsAdmo type="note" summary="Config Example">
|
||||
This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
|
||||
|
||||
<FileExample title={`CONFIG/${props.name}.json`} client={props.client ?? false} data={props.fileContent}/>
|
||||
* **text** mode lets you edit the JSON directly.
|
||||
* **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
|
||||
|
||||
or <SchemaLink lower objectName={props.config}/>
|
||||
Both modes **validate** that the configuraion is correct. Any errors show up as squiggly lines.
|
||||
|
||||
After you finish editing, switch to **text** and then copy all text to get a completed config.
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
<div className="fileEditorMobile">
|
||||
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
|
||||
This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
|
||||
|
||||
The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features.
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
<FileConfigExample
|
||||
filePathName={`CONFIG/${props.name}.json`}
|
||||
configureAs={props.client ? 'client' : 'source'}
|
||||
data={props.fileContent}
|
||||
schemaName={props.config}
|
||||
readOnlyAtWidth={500}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</FileType>
|
||||
</TabItem>
|
||||
<TabItem value="aio" label="AIO">
|
||||
<AIOType>
|
||||
<div
|
||||
className="schemaWrapper"
|
||||
style={{
|
||||
display: "flex"
|
||||
}}
|
||||
>
|
||||
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
|
||||
<DetailsAdmo type="note" summary="Config Structure">
|
||||
This displays the **structure** of the [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.
|
||||
|
||||
<AIOExample data={props.fileContent} client={props.client ?? false} name={props.name}/>
|
||||
Select the <strong children={props.name}/> type from the respective <code children={props.client ? 'clients' : 'sources'}/> node below, then expand it.
|
||||
</DetailsAdmo>
|
||||
<ExplorerFetch name={`schemas/aio`} />
|
||||
</div>
|
||||
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
|
||||
<div className="fileEditor">
|
||||
<DetailsAdmo type="note" summary="Config Example">
|
||||
This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**.
|
||||
|
||||
* **text** mode lets you edit the JSON directly.
|
||||
* **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
|
||||
|
||||
or <SchemaLink lower objectName={props.config}/>
|
||||
Both modes **validate** that the configuraion is correct. Any errors show up as squiggly lines.
|
||||
|
||||
After you finish editing, switch to **text** and then copy all text to get a completed config.
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
<div className="fileEditorMobile">
|
||||
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
|
||||
This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**.
|
||||
|
||||
The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features.
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
<FileConfigExample
|
||||
filePathName={`CONFIG/config.json`}
|
||||
configureAs={props.client ? 'client' : 'source'}
|
||||
data={props.fileContent}
|
||||
schemaName="aio"
|
||||
name={props.name}
|
||||
readOnlyAtWidth={500}
|
||||
aio
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</AIOType>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</Tabs>
|
||||
@@ -0,0 +1,26 @@
|
||||
.schemaWrapper {
|
||||
margin-top: 1em;
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
row-gap: 1em;
|
||||
column-gap: 1em;
|
||||
}
|
||||
|
||||
.fileEditorMobile {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1378px) {
|
||||
.schemaWrapper {
|
||||
flex-direction: column;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 500px) {
|
||||
.fileEditor {
|
||||
display: none;
|
||||
}
|
||||
.fileEditorMobile {
|
||||
display: block
|
||||
}
|
||||
}
|
||||
@@ -1,44 +0,0 @@
|
||||
import React from "react"
|
||||
import BrowserOnly from "@docusaurus/BrowserOnly"
|
||||
import { useColorMode } from "@docusaurus/theme-common"
|
||||
|
||||
import JSONSchemaEditor from "@theme/JSONSchemaEditor"
|
||||
// Context
|
||||
import { usePlaygroundContext } from "@site/src/contexts/PlaygroundContext"
|
||||
|
||||
// Common stringify of the JSON
|
||||
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
|
||||
|
||||
function JSONSchemaDataInner(): JSX.Element {
|
||||
const {
|
||||
state: { userSchema, editorRef, data: value },
|
||||
updateState,
|
||||
} = usePlaygroundContext()
|
||||
|
||||
const { colorMode } = useColorMode()
|
||||
|
||||
return (
|
||||
<div style={{ boxSizing: "border-box", width: "50%" }}>
|
||||
<JSONSchemaEditor
|
||||
value={value}
|
||||
schema={userSchema}
|
||||
theme={colorMode === "dark" ? "vs-dark" : "vs"}
|
||||
editorDidMount={(editor) => {
|
||||
updateState({ editorRef: editor })
|
||||
}}
|
||||
height={"70vh"}
|
||||
key={STRINGIFY_JSON(userSchema)}
|
||||
/>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
export default function JSONSchemaDataComponent(): JSX.Element {
|
||||
return (
|
||||
<BrowserOnly fallback={<div>Loading...</div>}>
|
||||
{() => {
|
||||
return <JSONSchemaDataInner />
|
||||
}}
|
||||
</BrowserOnly>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
.schemaWrapper2 {
|
||||
margin: 1em;
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
row-gap: 1em;
|
||||
column-gap: 1em;
|
||||
}
|
||||
|
||||
.fileEditorMobile2 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1280px) {
|
||||
.schemaWrapper2 {
|
||||
flex-direction: column;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 500px) {
|
||||
.fileEditor2 {
|
||||
display: none;
|
||||
}
|
||||
.fileEditorMobile2 {
|
||||
display: block
|
||||
}
|
||||
}
|
||||
@@ -1,50 +1,105 @@
|
||||
import React from "react"
|
||||
import React, {useEffect, useState} from "react"
|
||||
import BrowserOnly from "@docusaurus/BrowserOnly"
|
||||
import {useColorMode, useWindowSize} from '@docusaurus/theme-common';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
|
||||
import Schema from "@site/static/aio.json";
|
||||
import Schema from "@site/static/schemas/aio.json";
|
||||
import ConfigExample from "@site/static/configExample.json";
|
||||
import JSONSchemaViewer from "@theme/JSONSchemaViewer"
|
||||
import JSONSchemaEditor from "@theme/JSONSchemaEditor";
|
||||
import {useColorMode} from "@docusaurus/theme-common";
|
||||
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
|
||||
import './Playground.scss';
|
||||
import { JsonSchemaViewer } from 'cf-json-schema-viz';
|
||||
import "./json-schema-viewer-styles.css";
|
||||
import "./modern-json-react-styles.css";
|
||||
import { ReactJsonEditor, createAjvValidator, type Content } from 'modern-react-json-editor';
|
||||
import f from "ajv-formats"
|
||||
import DetailsAdmo from "./AdmonitionDetails";
|
||||
|
||||
const validator = createAjvValidator({
|
||||
schema: Schema,
|
||||
ajvOptions: {
|
||||
strict: "log",
|
||||
strictSchema: "log",
|
||||
allowUnionTypes: true,
|
||||
},
|
||||
onCreateAjv: (ajv) => {
|
||||
ajv.addKeyword('deprecationMessage');
|
||||
f.default(ajv);
|
||||
return ajv;
|
||||
}
|
||||
});
|
||||
|
||||
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
|
||||
function PlaygroundInner(): JSX.Element {
|
||||
|
||||
const { colorMode } = useColorMode()
|
||||
const {
|
||||
colorMode, // the "effective" color mode, never null
|
||||
// colorModeChoice, // the color mode chosen by the user, can be null
|
||||
// setColorMode, // set the color mode chosen by the user
|
||||
} = useColorMode();
|
||||
const windowSize = useWindowSize({desktopBreakpoint: 500});
|
||||
|
||||
const [data, setData] = useState<Content>({json: ConfigExample });
|
||||
|
||||
return (
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
flexDirection: "column",
|
||||
overflowY: "hidden",
|
||||
overflowX: "hidden",
|
||||
}}
|
||||
>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
flexDirection: "row",
|
||||
justifyContent: "space-between",
|
||||
}}
|
||||
>
|
||||
<div style={{width: '50%'}}>
|
||||
<JSONSchemaViewer
|
||||
schema={Schema}
|
||||
showExamples={true}
|
||||
<div className="schemaWrapper2">
|
||||
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
|
||||
<DetailsAdmo type="note" summary="Config Structure">
|
||||
<p>This displays the <strong>structure</strong> of the <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> with all possible properties, their shape, and descriptions/types.</p>
|
||||
|
||||
<p>Use this to understand how to write a valid config.</p>
|
||||
</DetailsAdmo>
|
||||
<JsonSchemaViewer
|
||||
name="Todos Model"
|
||||
schema={Schema}
|
||||
expanded={false}
|
||||
hideTopBar={false}
|
||||
renderRootTreeLines={true}
|
||||
emptyText="No schema defined"
|
||||
defaultExpandedDepth={0}
|
||||
markup
|
||||
/>
|
||||
</div>
|
||||
<div style={{ boxSizing: "border-box", width: "50%" }}>
|
||||
<JSONSchemaEditor
|
||||
value={STRINGIFY_JSON(ConfigExample)}
|
||||
theme={colorMode === "dark" ? "vs-dark" : "vs"}
|
||||
schema={Schema}
|
||||
height={"70vh"}
|
||||
/>
|
||||
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
|
||||
<div className="fileEditor2">
|
||||
<DetailsAdmo type="note" summary="Config Example">
|
||||
<p>
|
||||
This displays an <strong>example config file</strong> of a <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> that adheres to the shown <strong>Config Structure.</strong>
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<strong>text</strong> mode lets you edit the JSON directly.
|
||||
</li>
|
||||
<li>
|
||||
<strong>tree</strong> mode gives you a guided point-and-click editing experience that always keeps the JSON <i>syntax</i> valid.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>Both modes <strong>validate</strong> that the configuraion is correct. Any errors show up as squiggly lines.</p>
|
||||
|
||||
<p>After you finish editing, switch to <strong>text</strong> and then copy all text to get a completed config.</p>
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
<div className="fileEditorMobile2">
|
||||
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
|
||||
<p>
|
||||
This displays an <strong>example config file</strong> of a <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> that adheres to the shown <strong>Config Structure.</strong>
|
||||
</p>
|
||||
<p>
|
||||
The example config file editor is meant for a larger screen experience so <strong>only the read-only example is shown.</strong> Please use this site on a tablet/laptop/desktop to enable file editor features.
|
||||
</p>
|
||||
</DetailsAdmo>
|
||||
</div>
|
||||
{windowSize === 'mobile' ? (<CodeBlock title={`CONFIG/config.json`} language="json5">{JSON.stringify(data, null, 2)}</CodeBlock>) : (
|
||||
<ReactJsonEditor
|
||||
validator={validator}
|
||||
theme={colorMode}
|
||||
content={data}
|
||||
mode="text"
|
||||
style={{height: 'initial'}}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
import React, {useEffect, useState} from "react"
|
||||
import BrowserOnly from "@docusaurus/BrowserOnly"
|
||||
|
||||
//import './Explorer.scss';
|
||||
import { JsonSchemaViewer } from 'cf-json-schema-viz';
|
||||
import '../json-schema-viewer-styles.css'
|
||||
|
||||
export interface ExplorerProps {
|
||||
schema: object
|
||||
}
|
||||
|
||||
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
|
||||
export default function Explorer(props: ExplorerProps): JSX.Element {
|
||||
|
||||
//injectStyles();
|
||||
|
||||
return (
|
||||
<div>
|
||||
<JsonSchemaViewer
|
||||
schema={props.schema}
|
||||
renderRootTreeLines={true}
|
||||
emptyText="No schema defined"
|
||||
defaultExpandedDepth={0}
|
||||
markup
|
||||
/>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
// export default function PlaygroundComponent(): JSX.Element {
|
||||
// return (
|
||||
// <BrowserOnly fallback={<div>Loading...</div>}>
|
||||
// {() => {
|
||||
// return <PlaygroundInner />
|
||||
// }}
|
||||
// </BrowserOnly>
|
||||
// )
|
||||
// }
|
||||
@@ -0,0 +1,48 @@
|
||||
import React, {useEffect, useState, Fragment} from "react"
|
||||
//import BrowserOnly from "@docusaurus/BrowserOnly"
|
||||
|
||||
import Explorer from './Explorer';
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
export interface ExplorerFetchProps {
|
||||
name: string
|
||||
}
|
||||
|
||||
export default function ExplorerFetchFunc(props: ExplorerFetchProps): JSX.Element {
|
||||
|
||||
const [schema, setSchema] = useState(undefined as undefined | Error | object);
|
||||
|
||||
const url = useBaseUrl(`/${props.name}.json`);
|
||||
|
||||
useEffect( () => {
|
||||
fetch(
|
||||
url,
|
||||
{
|
||||
headers: {
|
||||
'Accept': 'application/json',
|
||||
}
|
||||
}
|
||||
)
|
||||
.then((response) => response.json())
|
||||
.then((data) => setSchema(data))
|
||||
.catch( (err) => setSchema(err) )
|
||||
}, [setSchema, url])
|
||||
|
||||
return (
|
||||
<Fragment>
|
||||
{schema === undefined && <div>Loading ...</div>}
|
||||
{schema !== undefined && schema instanceof Error && <div>Houston we have a problem : {schema.message}</div>}
|
||||
{schema !== undefined && !(schema instanceof Error) && <Explorer schema={schema}/>}
|
||||
</Fragment>
|
||||
)
|
||||
}
|
||||
|
||||
// export default function ExplorerFetch(props: ExplorerFetchProps): JSX.Element {
|
||||
// return (
|
||||
// <BrowserOnly fallback={<div>Loading...</div>}>
|
||||
// {() => {
|
||||
// return <ExplorerFetchFunc {...props} />
|
||||
// }}
|
||||
// </BrowserOnly>
|
||||
// )
|
||||
// }
|
||||
@@ -0,0 +1,7 @@
|
||||
import Schema from "@site/static/aio.json";
|
||||
import Explorer from './Explorer';
|
||||
|
||||
export default function ExplorerSSR(): JSX.Element {
|
||||
|
||||
return <Explorer schema={Schema}/>
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
import React, { useEffect, useState, useMemo } from "react"
|
||||
import BrowserOnly from "@docusaurus/BrowserOnly"
|
||||
import { useColorMode } from '@docusaurus/theme-common';
|
||||
|
||||
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t");
|
||||
import "../modern-json-react-styles.css";
|
||||
import { JSONSchema, ReactJsonEditor, createAjvValidator, type Content, type Validator } from 'modern-react-json-editor';
|
||||
import f from "ajv-formats"
|
||||
import json5 from 'json5';
|
||||
|
||||
export interface SchemaEditorProps {
|
||||
config: object | string
|
||||
schema?: object
|
||||
height?: string
|
||||
}
|
||||
|
||||
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
|
||||
function SchemaEditorInner(props: SchemaEditorProps): JSX.Element {
|
||||
|
||||
const validator: Validator | undefined = useMemo(() => {
|
||||
if(props.schema === undefined) {
|
||||
return undefined;
|
||||
}
|
||||
return createAjvValidator({
|
||||
schema: props.schema as JSONSchema,
|
||||
ajvOptions: {
|
||||
strict: "log",
|
||||
strictSchema: "log",
|
||||
allowUnionTypes: true,
|
||||
},
|
||||
onCreateAjv: (ajv) => {
|
||||
ajv.addKeyword('deprecationMessage');
|
||||
f.default(ajv);
|
||||
return ajv;
|
||||
}
|
||||
});
|
||||
}, [props.schema]);
|
||||
|
||||
const initialData = useMemo(() => {
|
||||
let content: object;
|
||||
if(typeof props.config === 'string') {
|
||||
content = json5.parse(props.config);
|
||||
} else {
|
||||
content = props.config;
|
||||
}
|
||||
return {json: content};
|
||||
},[props.config])
|
||||
|
||||
|
||||
// const [data, setData] = useState({ json: props.config });
|
||||
|
||||
const {
|
||||
colorMode, // the "effective" color mode, never null
|
||||
} = useColorMode();
|
||||
|
||||
//const val = typeof props.config === 'object' ? STRINGIFY_JSON(props.config) : props.config;
|
||||
return (
|
||||
<ReactJsonEditor
|
||||
validator={validator}
|
||||
theme={colorMode}
|
||||
mode="text"
|
||||
content={initialData}
|
||||
style={{height: 'initial'}}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
export default function SchemaEditor(props: SchemaEditorProps): JSX.Element {
|
||||
return (
|
||||
<BrowserOnly fallback={<div>Loading...</div>}>
|
||||
{() => {
|
||||
return <SchemaEditorInner {...props} />
|
||||
}}
|
||||
</BrowserOnly>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,74 @@
|
||||
import React, {useEffect, useState, Fragment} from "react"
|
||||
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
import SchemaEditor from "./SchemaEditor";
|
||||
import json5 from 'json5';
|
||||
|
||||
export interface SchemaEditorFetchProps {
|
||||
configContent: string | object
|
||||
schemaName?: string
|
||||
}
|
||||
|
||||
export default function ExplorerFetchFunc(props: SchemaEditorFetchProps): JSX.Element {
|
||||
|
||||
const {
|
||||
schemaName
|
||||
} = props;
|
||||
|
||||
const [schema, setSchema] = useState(undefined as undefined | Error | object | false);
|
||||
const [config, setConfig] = useState(undefined as undefined | Error | object);
|
||||
|
||||
const schemaUrl = schemaName === undefined ? undefined : useBaseUrl(`schemas/${props.schemaName}.json`);
|
||||
//const configUrl = props.configName !== undefined ? useBaseUrl(`/${props.configName}.json`) : undefined;
|
||||
useEffect( () => {
|
||||
if(schemaUrl === undefined) {
|
||||
setSchema(false);
|
||||
} else {
|
||||
fetch(
|
||||
schemaUrl,
|
||||
{
|
||||
headers: {
|
||||
'Accept': 'application/json',
|
||||
}
|
||||
}
|
||||
)
|
||||
.then((response) => response.json())
|
||||
.then((data) => setSchema(data))
|
||||
.catch( (err) => setSchema(err) )
|
||||
}
|
||||
}, [setSchema, schemaUrl])
|
||||
|
||||
// useEffect( () => {
|
||||
// if(configUrl !== undefined) {
|
||||
// fetch(
|
||||
// configUrl,
|
||||
// {
|
||||
// headers: {
|
||||
// 'Accept': 'application/json',
|
||||
// }
|
||||
// }
|
||||
// )
|
||||
// .then((response) => response.json())
|
||||
// .then((data) => setConfig(data))
|
||||
// .catch( (err) => setConfig(err) )
|
||||
// } else if(props.configContent !== undefined) {
|
||||
// if(typeof props.configContent === 'string') {
|
||||
// setConfig(json5.parse(props.configContent));
|
||||
// } else {
|
||||
// setConfig(props.configContent);
|
||||
// }
|
||||
// }
|
||||
// }, [setConfig, configUrl, props.configContent])
|
||||
|
||||
return (
|
||||
<Fragment>
|
||||
{schema === undefined && <div>Loading ...</div>}
|
||||
{schema !== undefined && schema instanceof Error && <div>Houston we have a problem : {schema.message}</div>}
|
||||
{schema !== undefined && !(schema instanceof Error) &&
|
||||
<SchemaEditor
|
||||
schema={schema === false ? undefined : schema}
|
||||
config={props.configContent}
|
||||
/>}
|
||||
</Fragment>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,480 @@
|
||||
/* JSON Schema Viewer - Pure CSS with CSS Custom Properties */
|
||||
|
||||
/* ========================================
|
||||
Theme Variables - Light Mode (default)
|
||||
Define at :root so portaled elements inherit them
|
||||
======================================== */
|
||||
:root {
|
||||
--jsv-font-sans: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
|
||||
--jsv-font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace;
|
||||
--jsv-font-size: 0.875rem;
|
||||
|
||||
/* Colors - Light Mode defaults */
|
||||
--jsv-color-body: #1a1a1a;
|
||||
--jsv-color-muted: #6b7280;
|
||||
--jsv-color-border: #e5e7eb;
|
||||
--jsv-color-canvas: #f4f4f5;
|
||||
--jsv-color-canvas-tint: #f4f4f5;
|
||||
--jsv-color-bg: #ffffff;
|
||||
|
||||
/* Semantic colors - Cloudflare orange as primary */
|
||||
--jsv-color-primary: #f6821f;
|
||||
--jsv-color-danger: #dc2626;
|
||||
--jsv-color-warning: #f97316;
|
||||
--jsv-color-success: #16a34a;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Theme Variables - Dark Mode
|
||||
Cloudflare docs dark theme colors
|
||||
======================================== */
|
||||
:root[data-theme="dark"],
|
||||
[data-theme="dark"] {
|
||||
--jsv-color-body: #e4e4e7;
|
||||
--jsv-color-muted: #a1a1aa;
|
||||
--jsv-color-border: #3f3f46;
|
||||
--jsv-color-canvas: #27272a;
|
||||
--jsv-color-canvas-tint: #3f3f46;
|
||||
--jsv-color-bg: #18181b;
|
||||
|
||||
--jsv-color-primary: #f6821f;
|
||||
--jsv-color-danger: #f87171;
|
||||
--jsv-color-warning: #fb923c;
|
||||
--jsv-color-success: #4ade80;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Base Styles
|
||||
======================================== */
|
||||
.jsv-root {
|
||||
font-size: var(--jsv-font-size);
|
||||
font-family: var(--jsv-font-sans);
|
||||
color: var(--jsv-color-body);
|
||||
line-height: 1.5;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.jsv-content {
|
||||
padding-left: 2rem;
|
||||
padding-right: 1rem;
|
||||
padding-bottom: 0.5rem;
|
||||
padding-top: 0.375rem;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Schema Row
|
||||
======================================== */
|
||||
.jsv-row {
|
||||
position: relative;
|
||||
padding-top: 0.25rem;
|
||||
padding-bottom: 0.25rem;
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.jsv-row-content {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.125rem;
|
||||
max-width: 100%;
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.jsv-row-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
max-width: 100%;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
/* Nubbin - horizontal connector from left border to property */
|
||||
.jsv-nubbin {
|
||||
width: 0.75rem;
|
||||
height: 0;
|
||||
border-top: 1px solid var(--jsv-color-border);
|
||||
flex-shrink: 0;
|
||||
margin-top: 0.5rem;
|
||||
margin-right: 0.5rem;
|
||||
margin-left: -1rem;
|
||||
}
|
||||
|
||||
.jsv-nubbin-short {
|
||||
width: 0.25rem;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Child Stack (nested content with left border)
|
||||
======================================== */
|
||||
.jsv-child-stack {
|
||||
font-size: var(--jsv-font-size);
|
||||
}
|
||||
|
||||
.jsv-child-stack-nested {
|
||||
border-left: 1px solid var(--jsv-color-border);
|
||||
margin-left: 0.5rem;
|
||||
padding-left: 1rem;
|
||||
margin-top: 0.25rem;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Property Name
|
||||
======================================== */
|
||||
.jsv-property-name {
|
||||
font-family: var(--jsv-font-mono);
|
||||
font-weight: 600;
|
||||
margin-right: 0.5rem;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Type Display
|
||||
======================================== */
|
||||
.jsv-type {
|
||||
color: var(--jsv-color-muted);
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.jsv-types-container {
|
||||
display: flex;
|
||||
align-items: baseline;
|
||||
font-size: var(--jsv-font-size);
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Badges (required, deprecated, read-only)
|
||||
======================================== */
|
||||
.jsv-badges {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.jsv-badge {
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.jsv-badge-required {
|
||||
color: var(--jsv-color-warning);
|
||||
}
|
||||
|
||||
.jsv-badge-deprecated {
|
||||
color: var(--jsv-color-warning);
|
||||
}
|
||||
|
||||
.jsv-badge-readonly {
|
||||
color: var(--jsv-color-muted);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Divider (horizontal line on hover)
|
||||
======================================== */
|
||||
.jsv-divider {
|
||||
height: 1px;
|
||||
flex: 1;
|
||||
margin-left: 0.75rem;
|
||||
margin-right: 0.75rem;
|
||||
min-width: 1rem;
|
||||
background-color: transparent;
|
||||
transition: background-color 0.15s ease;
|
||||
}
|
||||
|
||||
.jsv-divider-visible {
|
||||
background-color: var(--jsv-color-border);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Description
|
||||
======================================== */
|
||||
.jsv-description {
|
||||
font-size: var(--jsv-font-size);
|
||||
color: var(--jsv-color-muted);
|
||||
margin-top: 0.0625rem;
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Validations
|
||||
======================================== */
|
||||
.jsv-validations {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.25rem;
|
||||
align-items: center;
|
||||
margin-top: 0.125rem;
|
||||
}
|
||||
|
||||
.jsv-validations-row {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.25rem;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.jsv-validation {
|
||||
display: flex;
|
||||
align-items: baseline;
|
||||
gap: 0.375rem;
|
||||
color: var(--jsv-color-muted);
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.jsv-validation-label {
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.jsv-validation-values {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.25rem;
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.jsv-validation-value {
|
||||
padding: 0.0625rem 0.375rem;
|
||||
background-color: var(--jsv-color-canvas-tint);
|
||||
color: var(--jsv-color-muted);
|
||||
border: 1px solid var(--jsv-color-border);
|
||||
border-radius: 0.25rem;
|
||||
font-family: var(--jsv-font-mono);
|
||||
font-size: 0.75rem;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Caret (expand/collapse icon)
|
||||
======================================== */
|
||||
.jsv-caret {
|
||||
width: 1.25rem;
|
||||
height: 1.25rem;
|
||||
margin-left: -1.5rem;
|
||||
margin-right: 0.25rem;
|
||||
color: var(--jsv-color-muted);
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
cursor: pointer;
|
||||
flex-shrink: 0;
|
||||
transition: transform 0.15s ease;
|
||||
}
|
||||
|
||||
.jsv-caret:hover {
|
||||
color: var(--jsv-color-body);
|
||||
}
|
||||
|
||||
.jsv-caret-expanded {
|
||||
transform: rotate(90deg);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Error Display
|
||||
======================================== */
|
||||
.jsv-error {
|
||||
color: var(--jsv-color-danger);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Change Annotations (added/removed/modified)
|
||||
======================================== */
|
||||
.jsv-annotation {
|
||||
position: absolute;
|
||||
width: 0.25rem;
|
||||
height: 1rem;
|
||||
border-radius: 0.125rem;
|
||||
top: 50%;
|
||||
transform: translateY(-50%);
|
||||
}
|
||||
|
||||
.jsv-annotation-added {
|
||||
background-color: var(--jsv-color-success);
|
||||
}
|
||||
|
||||
.jsv-annotation-removed {
|
||||
background-color: var(--jsv-color-danger);
|
||||
}
|
||||
|
||||
.jsv-annotation-modified {
|
||||
background-color: var(--jsv-color-warning);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Path Crumbs (sticky breadcrumb header)
|
||||
Wrapper is sticky with height:0 (no layout impact)
|
||||
Inner crumbs div is absolute, overlays content
|
||||
======================================== */
|
||||
.jsv-crumbs {
|
||||
height: 2rem;
|
||||
padding-left: 2rem;
|
||||
padding-right: 1rem;
|
||||
font-family: var(--jsv-font-mono);
|
||||
font-size: var(--jsv-font-size);
|
||||
line-height: 1;
|
||||
z-index: 20;
|
||||
background-color: var(--sl-color-bg, var(--jsv-color-bg, #fff));
|
||||
color: var(--jsv-color-muted);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
border-bottom: 1px solid var(--jsv-color-border);
|
||||
border-top-left-radius: 0.5rem;
|
||||
border-top-right-radius: 0.5rem;
|
||||
box-sizing: border-box;
|
||||
/* Hidden by default */
|
||||
opacity: 0;
|
||||
pointer-events: none;
|
||||
}
|
||||
|
||||
[data-theme="dark"] .jsv-crumbs,
|
||||
:root[data-theme="dark"] .jsv-crumbs {
|
||||
border-bottom-color: var(--sl-color-gray-5, #52525b);
|
||||
}
|
||||
|
||||
.jsv-crumbs[data-visible="true"] {
|
||||
opacity: 1;
|
||||
pointer-events: auto;
|
||||
}
|
||||
|
||||
.jsv-crumb-current {
|
||||
color: var(--jsv-color-body);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Select / Menu Dropdown
|
||||
======================================== */
|
||||
.jsv-select-trigger {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.375rem;
|
||||
padding: 0.125rem 0.5rem;
|
||||
font-size: var(--jsv-font-size);
|
||||
font-family: var(--jsv-font-sans);
|
||||
background-color: transparent;
|
||||
border: 1px solid var(--jsv-color-border);
|
||||
border-radius: 0.25rem;
|
||||
cursor: pointer;
|
||||
color: var(--jsv-color-muted);
|
||||
line-height: 1.4;
|
||||
transition: background-color 0.15s ease, border-color 0.15s ease;
|
||||
}
|
||||
|
||||
.jsv-select-trigger:hover {
|
||||
background-color: var(--jsv-color-canvas);
|
||||
border-color: var(--jsv-color-muted);
|
||||
}
|
||||
|
||||
.jsv-select-trigger:focus {
|
||||
outline: none;
|
||||
box-shadow: 0 0 0 2px var(--jsv-color-primary);
|
||||
}
|
||||
|
||||
.jsv-select-positioner {
|
||||
z-index: 9999 !important;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.jsv-select-popup {
|
||||
background-color: var(--jsv-color-bg);
|
||||
border: 1px solid var(--jsv-color-border);
|
||||
border-radius: 0.375rem;
|
||||
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.15), 0 2px 4px rgba(0, 0, 0, 0.1);
|
||||
padding: 0.25rem 0;
|
||||
min-width: 10rem;
|
||||
overflow: hidden;
|
||||
font-family: var(--jsv-font-sans);
|
||||
font-size: var(--jsv-font-size);
|
||||
}
|
||||
|
||||
.jsv-select-item {
|
||||
padding: 0.5rem 0.75rem;
|
||||
padding-left: 2rem;
|
||||
font-size: var(--jsv-font-size);
|
||||
cursor: pointer;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
outline: none;
|
||||
color: var(--jsv-color-body);
|
||||
background-color: var(--jsv-color-bg);
|
||||
position: relative;
|
||||
transition: background-color 0.1s ease;
|
||||
}
|
||||
|
||||
.jsv-select-item:hover,
|
||||
.jsv-select-item:focus,
|
||||
.jsv-select-item[data-highlighted] {
|
||||
background-color: var(--jsv-color-canvas);
|
||||
}
|
||||
|
||||
.jsv-select-item[data-selected] {
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.jsv-select-item-indicator {
|
||||
position: absolute;
|
||||
left: 0.625rem;
|
||||
top: 50%;
|
||||
transform: translateY(-50%);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
color: var(--jsv-color-primary);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Top Level Styles
|
||||
======================================== */
|
||||
.jsv-top-label {
|
||||
font-family: var(--jsv-font-mono);
|
||||
font-weight: 600;
|
||||
font-size: var(--jsv-font-size);
|
||||
padding-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.jsv-top-section {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.75rem;
|
||||
padding-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.jsv-combiner-label {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
color: var(--jsv-color-muted);
|
||||
font-size: var(--jsv-font-size);
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Link Styles
|
||||
======================================== */
|
||||
.jsv-link {
|
||||
color: var(--jsv-color-primary);
|
||||
cursor: pointer;
|
||||
text-decoration: none;
|
||||
margin-left: 0.5rem;
|
||||
}
|
||||
|
||||
.jsv-link:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* ========================================
|
||||
Misc Helpers
|
||||
======================================== */
|
||||
.jsv-cursor-pointer {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.jsv-ml-2 {
|
||||
margin-left: 0.5rem;
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
.jse-theme-dark{--jse-theme: dark;--jse-theme-color: #2f6dd0;--jse-theme-color-highlight: #467cd2;--jse-background-color: #1e1e1e;--jse-text-color: #d4d4d4;--jse-text-color-inverse: #4d4d4d;--jse-main-border: 1px solid #4f4f4f;--jse-menu-color: #fff;--jse-modal-background: #2f2f2f;--jse-modal-overlay-background: rgba(0, 0, 0, .5);--jse-modal-code-background: #2f2f2f;--jse-tooltip-color: var(--jse-text-color);--jse-tooltip-background: #4b4b4b;--jse-tooltip-border: 1px solid #737373;--jse-tooltip-action-button-color: inherit;--jse-tooltip-action-button-background: #737373;--jse-panel-background: #333333;--jse-panel-background-border: 1px solid #464646;--jse-panel-color: var(--jse-text-color);--jse-panel-color-readonly: #737373;--jse-panel-border: 1px solid #3c3c3c;--jse-panel-button-color-highlight: #e5e5e5;--jse-panel-button-background-highlight: #464646;--jse-navigation-bar-background: #656565;--jse-navigation-bar-background-highlight: #7e7e7e;--jse-navigation-bar-dropdown-color: var(--jse-text-color);--jse-context-menu-background: #4b4b4b;--jse-context-menu-background-highlight: #595959;--jse-context-menu-separator-color: #595959;--jse-context-menu-color: var(--jse-text-color);--jse-context-menu-pointer-background: #737373;--jse-context-menu-pointer-background-highlight: #818181;--jse-context-menu-pointer-color: var(--jse-context-menu-color);--jse-key-color: #9cdcfe;--jse-value-color: var(--jse-text-color);--jse-value-color-number: #b5cea8;--jse-value-color-boolean: #569cd6;--jse-value-color-null: #569cd6;--jse-value-color-string: #ce9178;--jse-value-color-url: #ce9178;--jse-delimiter-color: #949494;--jse-edit-outline: 2px solid var(--jse-text-color);--jse-selection-background-color: #464646;--jse-selection-background-inactive-color: #333333;--jse-hover-background-color: #343434;--jse-active-line-background-color: rgba(255, 255, 255, .06);--jse-search-match-background-color: #343434;--jse-collapsed-items-background-color: #333333;--jse-collapsed-items-selected-background-color: #565656;--jse-collapsed-items-link-color: #b2b2b2;--jse-collapsed-items-link-color-highlight: #ec8477;--jse-search-match-color: #724c27;--jse-search-match-outline: 1px solid #966535;--jse-search-match-active-color: #9f6c39;--jse-search-match-active-outline: 1px solid #bb7f43;--jse-tag-background: #444444;--jse-tag-color: #bdbdbd;--jse-table-header-background: #333333;--jse-table-header-background-highlight: #424242;--jse-table-row-odd-background: rgba(255, 255, 255, .1);--jse-input-background: #3d3d3d;--jse-input-border: var(--jse-main-border);--jse-button-background: #808080;--jse-button-background-highlight: #7a7a7a;--jse-button-color: #e0e0e0;--jse-button-secondary-background: #494949;--jse-button-secondary-background-highlight: #5d5d5d;--jse-button-secondary-background-disabled: #9d9d9d;--jse-button-secondary-color: var(--jse-text-color);--jse-a-color: #55abff;--jse-a-color-highlight: #4387c9;--jse-svelte-select-background: #3d3d3d;--jse-svelte-select-border: 1px solid #4f4f4f;--list-background: #3d3d3d;--item-hover-bg: #505050;--multi-item-bg: #5b5b5b;--input-color: #d4d4d4;--multi-clear-bg: #8a8a8a;--multi-item-clear-icon-color: #d4d4d4;--multi-item-outline: 1px solid #696969;--list-shadow: 0 2px 8px 0 rgba(0, 0, 0, .4);--jse-color-picker-background: #656565;--jse-color-picker-border-box-shadow: #8c8c8c 0 0 0 1px}
|
||||
@@ -1,2 +1 @@
|
||||
[**AIO** Config Type](/configuration?configType=aio#configuration-types)
|
||||
{props.children}
|
||||
@@ -0,0 +1,10 @@
|
||||
<DetailsAdmo type="warning" summary="Insecure Communication">
|
||||
|
||||
This method of exposing Discord IPC is **not secure**. There is no authentication used for the traffic relayed to/from the opened TCP port.
|
||||
|
||||
You should only use this method if you trust the network your machine is on. Additionally:
|
||||
|
||||
* **Do** use a firewall to limit source (IP) of incoming traffic to this TCP port
|
||||
* **Do not** expose this port to the public internet
|
||||
|
||||
</DetailsAdmo>
|
||||
@@ -1,3 +1,5 @@
|
||||
[**ENV** Config Type](/configuration?configType=env#configuration-types)
|
||||
:::note[Configuration Type]
|
||||
This is configuration for the **ENV** [Config Type](/configuration?configType=env#configuration-types).
|
||||
:::
|
||||
|
||||
{props.children}
|
||||
@@ -1,3 +1 @@
|
||||
[**File** Config Type](/configuration?configType=file#configuration-types)
|
||||
|
||||
{props.children}
|
||||
@@ -0,0 +1,116 @@
|
||||
/**
|
||||
* Inspired by typings from https://github.com/michal-worwag/hooks-ts/blob/main/packages/hooks-ts/src/useLocalStorage/useLocalStorage.ts
|
||||
* and global updates/dedup from https://github.com/kaansey/react-localstorage-hook/blob/master/src/useLocalStorage/useLocalStorage.ts
|
||||
*/
|
||||
|
||||
import { useState, useEffect, useCallback } from 'react';
|
||||
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
|
||||
|
||||
const localTypedStorageHook = <T>(key: string, initialValue: T, json: boolean = true): [T, (value: T) => void] => {
|
||||
|
||||
const [storedValue, setStoredValue] = useState<T>(() => {
|
||||
const item = window.localStorage.getItem(key);
|
||||
if (json) {
|
||||
try {
|
||||
return item ? (JSON.parse(item) as T) : initialValue;
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
return initialValue;
|
||||
}
|
||||
} else {
|
||||
try {
|
||||
if (null === item) {
|
||||
return initialValue;
|
||||
}
|
||||
if (item === 'true') {
|
||||
return true as T;
|
||||
}
|
||||
if (item === 'false') {
|
||||
return false as T;
|
||||
}
|
||||
if (isNumeric(item)) {
|
||||
if (item.includes('.')) {
|
||||
return parseFloat(item) as T;
|
||||
}
|
||||
return parseInt(item) as T;
|
||||
}
|
||||
return item as T;
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
return initialValue;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
const updateValue = useCallback(
|
||||
newValue => {
|
||||
setStoredValue(() => {
|
||||
if(json) {
|
||||
localStorage.setItem(key, JSON.stringify(newValue))
|
||||
} else {
|
||||
localStorage.setItem(key, newValue)
|
||||
}
|
||||
return newValue
|
||||
})
|
||||
},
|
||||
[key]
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
const onStorage = (event: any) => {
|
||||
if (event.storageArea === localStorage && event.key === key) {
|
||||
setStoredValue(
|
||||
event.newValue === null ? initialValue : event.newValue
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
window.addEventListener('storage', onStorage)
|
||||
|
||||
return () => window.removeEventListener('storage', onStorage)
|
||||
});
|
||||
|
||||
return [storedValue, updateValue];
|
||||
|
||||
}
|
||||
|
||||
const isNumeric = (num: any) => (typeof(num) === 'number' || typeof(num) === "string" && num.trim() !== '') && !isNaN(num as number);
|
||||
|
||||
const createTypedLocalStorageHook = <T>(key: string, defaultValue: T, json?: boolean) => {
|
||||
const updates: Array<any> = []
|
||||
|
||||
return () => {
|
||||
const [value, setValue] = localTypedStorageHook<T>(key, defaultValue, json)
|
||||
const updateValue = useCallback((newValue: T) => {
|
||||
for (const update of updates) {
|
||||
update(newValue)
|
||||
}
|
||||
}, [])
|
||||
|
||||
useEffect(() => {
|
||||
updates.push(setValue)
|
||||
return () => {
|
||||
updates.splice(updates.indexOf(setValue), 1)
|
||||
}
|
||||
}, [setValue])
|
||||
|
||||
return [value, updateValue]
|
||||
}
|
||||
}
|
||||
|
||||
const hookInstances: Record<string, any> = {}
|
||||
|
||||
export const useTypedLocalStorage = <T>(key: string, defaultValue: T, json?: boolean): [T, (value: T) => void] => {
|
||||
if (key in hookInstances) {
|
||||
return hookInstances[key]()
|
||||
}
|
||||
|
||||
// prevents usage during server static rendering
|
||||
if(!ExecutionEnvironment.canUseDOM) {
|
||||
return [defaultValue, () => null];
|
||||
}
|
||||
|
||||
hookInstances[key] = createTypedLocalStorageHook(key, defaultValue, json)
|
||||
return hookInstances[key]()
|
||||
}
|
||||
@@ -32,7 +32,7 @@ export default function Playground(): JSX.Element {
|
||||
return (
|
||||
<Layout
|
||||
title={`Playground`}
|
||||
description="Playground of docusaurus-json-schema-plugin"
|
||||
description="Config Playground"
|
||||
>
|
||||
<PlaygroundComponent />
|
||||
</Layout>
|
||||
|
||||
@@ -9,6 +9,8 @@ import EnvType from "@site/src/components/snippets/_env-config.mdx";
|
||||
import FileType from "@site/src/components/snippets/_file-config.mdx";
|
||||
import AIOType from "@site/src/components/snippets/_aio-config.mdx";
|
||||
import Config from "@site/src/components/GenericConfiguration.mdx";
|
||||
import Button from '../components/Button';
|
||||
import ButtonGroup from '../components/ButtonGroup';
|
||||
|
||||
export default {
|
||||
// Re-use the default mapping
|
||||
@@ -20,5 +22,7 @@ export default {
|
||||
FileType,
|
||||
AIOType,
|
||||
Config,
|
||||
DetailsAdmo
|
||||
DetailsAdmo,
|
||||
Button,
|
||||
ButtonGroup
|
||||
};
|
||||
|
After Width: | Height: | Size: 934 KiB |
|
After Width: | Height: | Size: 8.9 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 7.2 KiB |
|
After Width: | Height: | Size: 9.2 KiB |
|
After Width: | Height: | Size: 240 KiB |
@@ -0,0 +1,925 @@
|
||||
{
|
||||
"annotations": {
|
||||
"list": [
|
||||
{
|
||||
"builtIn": 1,
|
||||
"datasource": { "type": "grafana", "uid": "-- Grafana --" },
|
||||
"enable": true,
|
||||
"hide": true,
|
||||
"iconColor": "rgba(0, 211, 255, 1)",
|
||||
"name": "Annotations & Alerts",
|
||||
"type": "dashboard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"editable": true,
|
||||
"fiscalYearStartMonth": 0,
|
||||
"graphTooltip": 0,
|
||||
"id": null,
|
||||
"links": [],
|
||||
"liveNow": false,
|
||||
"panels": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "red", "value": 1 }
|
||||
]
|
||||
}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 0, "y": 0 },
|
||||
"id": 1,
|
||||
"options": {
|
||||
"colorMode": "background",
|
||||
"graphMode": "none",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "sum(multiscrobbler_source_issues)",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Total Source Issues",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "red", "value": 1 }
|
||||
]
|
||||
}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 4, "y": 0 },
|
||||
"id": 2,
|
||||
"options": {
|
||||
"colorMode": "background",
|
||||
"graphMode": "none",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "sum(multiscrobbler_client_issues)",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Total Client Issues",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "yellow", "value": 300000000 },
|
||||
{ "color": "red", "value": 500000000 }
|
||||
]
|
||||
},
|
||||
"unit": "decbytes"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 8, "y": 0 },
|
||||
"id": 25,
|
||||
"options": {
|
||||
"colorMode": "value",
|
||||
"graphMode": "area",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "process_resident_memory_bytes{job=\"multi-scrobbler\"}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Memory (RSS)",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"max": 1,
|
||||
"min": 0,
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "yellow", "value": 0.5 },
|
||||
{ "color": "red", "value": 0.8 }
|
||||
]
|
||||
},
|
||||
"unit": "percentunit"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 12, "y": 0 },
|
||||
"id": 26,
|
||||
"options": {
|
||||
"colorMode": "value",
|
||||
"graphMode": "area",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "rate(process_cpu_seconds_total{job=\"multi-scrobbler\"}[1m])",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "CPU Usage",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "yellow", "value": 0.05 },
|
||||
{ "color": "red", "value": 0.1 }
|
||||
]
|
||||
},
|
||||
"unit": "s"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 16, "y": 0 },
|
||||
"id": 27,
|
||||
"options": {
|
||||
"colorMode": "value",
|
||||
"graphMode": "area",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_eventloop_lag_seconds{job=\"multi-scrobbler\"}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Event Loop Lag",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "short"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 20, "y": 0 },
|
||||
"id": 3,
|
||||
"options": {
|
||||
"legend": { "calcs": [], "displayMode": "list", "placement": "bottom", "showLegend": false },
|
||||
"tooltip": { "mode": "single", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "sum(rate(multiscrobbler_source_discovered[5m]))",
|
||||
"legendFormat": "Discoveries/sec",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Discovery Rate",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 4 },
|
||||
"id": 5,
|
||||
"panels": [],
|
||||
"title": "Sources",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 0, "y": 5 },
|
||||
"id": 6,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "right", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_source_discovered",
|
||||
"legendFormat": "{{name}} ({{type}})",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Plays Discovered by Source",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [{ "color": "green", "value": null }, { "color": "red", "value": 1 }]
|
||||
}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 12, "y": 5 },
|
||||
"id": 7,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "right", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_source_issues",
|
||||
"legendFormat": "{{name}} ({{type}})",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Source Issues",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 13 },
|
||||
"id": 8,
|
||||
"panels": [],
|
||||
"title": "Clients",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 0, "y": 14 },
|
||||
"id": 9,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_client_scrobbled",
|
||||
"legendFormat": "{{name}}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Total Scrobbles by Client",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "normal" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 8, "y": 14 },
|
||||
"id": 10,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_client_queued",
|
||||
"legendFormat": "{{name}}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Queued Plays by Client",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [{ "color": "green", "value": null }, { "color": "red", "value": 1 }]
|
||||
}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 16, "y": 14 },
|
||||
"id": 11,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_client_issues",
|
||||
"legendFormat": "{{name}}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Client Issues",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 22 },
|
||||
"id": 12,
|
||||
"panels": [],
|
||||
"title": "Node.js Performance",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "decbytes"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 0, "y": 23 },
|
||||
"id": 17,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last", "max"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "process_resident_memory_bytes{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "Resident Memory (RSS)",
|
||||
"refId": "A"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_heap_size_total_bytes{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "Heap Total",
|
||||
"refId": "B"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_heap_size_used_bytes{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "Heap Used",
|
||||
"refId": "C"
|
||||
}
|
||||
],
|
||||
"title": "Memory Usage",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "absolute",
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "yellow", "value": 0.05 },
|
||||
{ "color": "red", "value": 0.1 }
|
||||
]
|
||||
},
|
||||
"unit": "s"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 8, "y": 23 },
|
||||
"id": 18,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "max"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_eventloop_lag_seconds{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "Current Lag",
|
||||
"refId": "A"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_eventloop_lag_mean_seconds{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "Mean Lag",
|
||||
"refId": "B"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_eventloop_lag_p99_seconds{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "P99 Lag",
|
||||
"refId": "C"
|
||||
}
|
||||
],
|
||||
"title": "Event Loop Lag",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "percentunit"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 8, "x": 16, "y": 23 },
|
||||
"id": 19,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "max"], "displayMode": "table", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "rate(process_cpu_user_seconds_total{job=\"multi-scrobbler\"}[5m])",
|
||||
"legendFormat": "User CPU",
|
||||
"refId": "A"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "rate(process_cpu_system_seconds_total{job=\"multi-scrobbler\"}[5m])",
|
||||
"legendFormat": "System CPU",
|
||||
"refId": "B"
|
||||
}
|
||||
],
|
||||
"title": "CPU Usage",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 0, "y": 31 },
|
||||
"id": 20,
|
||||
"options": {
|
||||
"colorMode": "value",
|
||||
"graphMode": "none",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_active_handles_total{job=\"multi-scrobbler\"}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Active Handles",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 4, "x": 4, "y": 31 },
|
||||
"id": 21,
|
||||
"options": {
|
||||
"colorMode": "value",
|
||||
"graphMode": "none",
|
||||
"justifyMode": "auto",
|
||||
"orientation": "auto",
|
||||
"reduceOptions": { "values": false, "calcs": ["lastNotNull"], "fields": "" },
|
||||
"textMode": "auto"
|
||||
},
|
||||
"pluginVersion": "10.0.0",
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "process_open_fds{job=\"multi-scrobbler\"}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Open File Descriptors",
|
||||
"type": "stat"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "s"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 8, "x": 8, "y": 31 },
|
||||
"id": 22,
|
||||
"options": {
|
||||
"legend": { "calcs": [], "displayMode": "list", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "rate(nodejs_gc_duration_seconds_sum{job=\"multi-scrobbler\"}[5m])",
|
||||
"legendFormat": "{{kind}} GC",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Garbage Collection Time",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "normal" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "decbytes"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 4, "w": 8, "x": 16, "y": 31 },
|
||||
"id": 23,
|
||||
"options": {
|
||||
"legend": { "calcs": [], "displayMode": "list", "placement": "bottom", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "nodejs_heap_space_size_used_bytes{job=\"multi-scrobbler\"}",
|
||||
"legendFormat": "{{space}}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Heap Space Breakdown",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 35 },
|
||||
"id": 24,
|
||||
"panels": [],
|
||||
"title": "Cache Performance",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"max": 100,
|
||||
"min": 0,
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "percent"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 0, "y": 36 },
|
||||
"id": 13,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "last"], "displayMode": "table", "placement": "right", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "100 * multiscrobbler_cache_hits / (multiscrobbler_cache_hits + multiscrobbler_cache_misses)",
|
||||
"legendFormat": "{{cacheType}} ({{tier}})",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Cache Hit Rate",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] },
|
||||
"unit": "ops"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 12, "y": 36 },
|
||||
"id": 14,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "last"], "displayMode": "table", "placement": "right", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "rate(multiscrobbler_cache_sets[5m])",
|
||||
"legendFormat": "{{cacheType}} ({{tier}})",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Cache Set Rate",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": {
|
||||
"axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "",
|
||||
"axisPlacement": "auto", "barAlignment": 0, "drawStyle": "line",
|
||||
"fillOpacity": 10, "gradientMode": "none",
|
||||
"hideFrom": { "tooltip": false, "viz": false, "legend": false },
|
||||
"lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5,
|
||||
"scaleDistribution": { "type": "linear" }, "showPoints": "auto",
|
||||
"spanNulls": false, "stacking": { "group": "A", "mode": "none" },
|
||||
"thresholdsStyle": { "mode": "off" }
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": { "mode": "absolute", "steps": [{ "color": "green", "value": null }] }
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"matcher": { "id": "byRegexp", "options": ".*hits.*" },
|
||||
"properties": [{ "id": "color", "value": { "fixedColor": "green", "mode": "fixed" } }]
|
||||
},
|
||||
{
|
||||
"matcher": { "id": "byRegexp", "options": ".*misses.*" },
|
||||
"properties": [{ "id": "color", "value": { "fixedColor": "red", "mode": "fixed" } }]
|
||||
}
|
||||
]
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 0, "y": 44 },
|
||||
"id": 16,
|
||||
"options": {
|
||||
"legend": { "calcs": ["last"], "displayMode": "table", "placement": "right", "showLegend": true },
|
||||
"tooltip": { "mode": "multi", "sort": "none" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_cache_hits",
|
||||
"legendFormat": "{{cacheType}} hits ({{tier}})",
|
||||
"refId": "A"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "${DS_PROMETHEUS}" },
|
||||
"expr": "multiscrobbler_cache_misses",
|
||||
"legendFormat": "{{cacheType}} misses ({{tier}})",
|
||||
"refId": "B"
|
||||
}
|
||||
],
|
||||
"title": "Cache Hits vs Misses",
|
||||
"type": "timeseries"
|
||||
}
|
||||
],
|
||||
"refresh": "10s",
|
||||
"schemaVersion": 38,
|
||||
"style": "dark",
|
||||
"tags": ["multiscrobbler", "scrobbling", "music"],
|
||||
"templating": {
|
||||
"list": [
|
||||
{
|
||||
"current": { "selected": false, "text": "Prometheus", "value": "Prometheus" },
|
||||
"hide": 0,
|
||||
"includeAll": false,
|
||||
"label": "Datasource",
|
||||
"multi": false,
|
||||
"name": "DS_PROMETHEUS",
|
||||
"options": [],
|
||||
"query": "prometheus",
|
||||
"refresh": 1,
|
||||
"regex": "",
|
||||
"skipUrlSync": false,
|
||||
"type": "datasource"
|
||||
}
|
||||
]
|
||||
},
|
||||
"time": { "from": "now-6h", "to": "now" },
|
||||
"timepicker": {},
|
||||
"timezone": "",
|
||||
"title": "Multiscrobbler Dashboard",
|
||||
"uid": "multiscrobbler",
|
||||
"version": 1,
|
||||
"weekStart": ""
|
||||
}
|
||||
@@ -4,7 +4,6 @@
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"resolveJsonModule": true,
|
||||
// Extending "@tsconfig/docusaurus/tsconfig.json".types with "docusaurus-json-schema-plugin"
|
||||
"types": ["node", "@docusaurus/module-type-aliases", "@docusaurus/theme-classic", "docusaurus-json-schema-plugin"]
|
||||
"types": ["node", "@docusaurus/module-type-aliases", "@docusaurus/theme-classic","docusaurus-plugin-sass"]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
// For more info, see https://github.com/storybookjs/eslint-plugin-storybook#configuration-flat-config-format
|
||||
import storybook from "eslint-plugin-storybook";
|
||||
|
||||
// @ts-check
|
||||
|
||||
import eslint from '@eslint/js';
|
||||
@@ -33,4 +36,4 @@ export default tsEslint.config({
|
||||
"arrow-body-style": ["warn", "as-needed"],
|
||||
"@typescript-eslint/no-explicit-any": "warn"
|
||||
}
|
||||
});
|
||||
}, storybook.configs["flat/recommended"]);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "multi-scrobbler",
|
||||
"version": "0.11.3",
|
||||
"version": "0.12.1",
|
||||
"type": "module",
|
||||
"description": "scrobble plays from multiple sources to multiple clients",
|
||||
"scripts": {
|
||||
@@ -19,9 +19,12 @@
|
||||
"docs:install": "cd docsite && npm ci --no-audit",
|
||||
"docs:start": "cd docsite && npm start",
|
||||
"docs:build": "npm run -s schema:docs && cd docsite && npm run build",
|
||||
"docs:netlify": "npm run -s docs:install && npm run -s docs:build",
|
||||
"postinstall": "patch-package",
|
||||
"install:parallel": "concurrently --kill-others-on-fail --names app,docs \"npm ci --no-audit\" \"npm run docs:install\"",
|
||||
"cliff": "git-cliff --unreleased"
|
||||
"cliff": "git-cliff --unreleased",
|
||||
"storybook": "storybook dev -p 6006",
|
||||
"build-storybook": "storybook build"
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
@@ -50,14 +53,17 @@
|
||||
"@atproto/api": "^0.18.0",
|
||||
"@atproto/oauth-client-node": "^0.3.10",
|
||||
"@awaitjs/express": "^0.6.3",
|
||||
"@chakra-ui/react": "^3.34.0",
|
||||
"@curvenote/ansi-to-react": "^7.0.0",
|
||||
"@donedeal0/superdiff": "^1.1.1",
|
||||
"@emotion/react": "^11.14.0",
|
||||
"@ewanc26/tid": "^1.0.2",
|
||||
"@fortawesome/fontawesome-svg-core": "^6.4.2",
|
||||
"@fortawesome/free-solid-svg-icons": "^6.4.2",
|
||||
"@fortawesome/react-fontawesome": "^0.2.0",
|
||||
"@foxxmd/chromecast-client": "^1.0.4",
|
||||
"@foxxmd/get-version": "^0.0.3",
|
||||
"@foxxmd/logging": "^0.2.5",
|
||||
"@foxxmd/logging": "^0.2.6",
|
||||
"@foxxmd/redact-string": "^0.1.2",
|
||||
"@foxxmd/regex-buddy-core": "^0.1.2",
|
||||
"@foxxmd/string-sameness": "^0.4.0",
|
||||
@@ -71,6 +77,7 @@
|
||||
"@svrooij/sonos": "^2.5.0",
|
||||
"@tailwindcss/vite": "^4.1.16",
|
||||
"@types/express-serve-static-core": "^4.19.6",
|
||||
"@xhayper/discord-rpc": "^1.3.0",
|
||||
"address": "^1.2.2",
|
||||
"ajv": "^8.12.0",
|
||||
"ajv-formats": "^3.0.1",
|
||||
@@ -88,6 +95,7 @@
|
||||
"cors": "^2.8.5",
|
||||
"dayjs": "^1.10.4",
|
||||
"dbus-ts": "^0.0.7",
|
||||
"discord.js": "^14.25.1",
|
||||
"dotenv": "^10.0.0",
|
||||
"express": "^4.17.1",
|
||||
"express-session": "^1.17.2",
|
||||
@@ -102,9 +110,10 @@
|
||||
"icecast-metadata-stats": "^0.1.12",
|
||||
"iso-websocket": "^0.3.0",
|
||||
"iti": "^0.7.0",
|
||||
"jest-diff": "^30.2.0",
|
||||
"json-diff-ts": "^5.0.0-alpha.2",
|
||||
"json5": "^2.2.3",
|
||||
"jsondiffpatch": "^0.7.3",
|
||||
"jsondiffpatch-react": "^1.0.8",
|
||||
"keyv": "^5.5.0",
|
||||
"kodi-api": "^0.2.1",
|
||||
"lastfm-ts-api": "^2.6.0",
|
||||
@@ -113,22 +122,28 @@
|
||||
"mpd-api": "^1.1.2",
|
||||
"musicbrainz-api": "^0.27.0",
|
||||
"nanoid": "^3.3.1",
|
||||
"next-themes": "^0.4.6",
|
||||
"node-object-hash": "^3.1.1",
|
||||
"normalize-url": "^8.0.1",
|
||||
"ntfy": "^1.7.6",
|
||||
"p-event": "^4.2.0",
|
||||
"p-map": "^7.0.4",
|
||||
"p-retry": "^7.1.1",
|
||||
"passport": "^0.6.0",
|
||||
"passport-deezer": "^0.2.0",
|
||||
"patch-package": "^8.0.0",
|
||||
"prom-client": "^15.1.3",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0",
|
||||
"react-error-boundary": "^6.1.1",
|
||||
"react-icons": "^5.6.0",
|
||||
"react-redux": "^8.1.2",
|
||||
"react-router-dom": "^6.15.0",
|
||||
"react-virtuoso": "^4.18.3",
|
||||
"round-robin-js": "^3.0.10",
|
||||
"sass": "^1.93.3",
|
||||
"serialize-error": "^13.0.1",
|
||||
"shiki": "^4.0.2",
|
||||
"spotify-web-api-node": "^5.0.2",
|
||||
"superagent": "^8.0.9",
|
||||
"tailwindcss": "^4.1.16",
|
||||
@@ -145,11 +160,17 @@
|
||||
"youtubei.js": "^15.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@chromatic-com/storybook": "^5.0.1",
|
||||
"@dbus-types/notifications": "^0.0.5",
|
||||
"@eslint/js": "^8.56.0",
|
||||
"@faker-js/faker": "^9.0.1",
|
||||
"@gr2m/net-interceptor": "^1.0.0",
|
||||
"@istanbuljs/nyc-config-typescript": "^1.0.2",
|
||||
"@storybook/addon-a11y": "10.1.11",
|
||||
"@storybook/addon-docs": "10.1.11",
|
||||
"@storybook/addon-onboarding": "10.1.11",
|
||||
"@storybook/addon-vitest": "10.1.11",
|
||||
"@storybook/react-vite": "10.1.11",
|
||||
"@testing-library/jest-dom": "^5.17.0",
|
||||
"@testing-library/react": "^13.4.0",
|
||||
"@testing-library/user-event": "^13.5.0",
|
||||
@@ -166,29 +187,38 @@
|
||||
"@types/jest": "^27.5.2",
|
||||
"@types/jscodeshift": "^0.11.6",
|
||||
"@types/mocha": "^9.1.0",
|
||||
"@types/node": "^18.0.0",
|
||||
"@types/node": "^20.19.2",
|
||||
"@types/object-hash": "^3.0.0",
|
||||
"@types/passport": "^1.0.12",
|
||||
"@types/react": "^18.2.18",
|
||||
"@types/react-dom": "^18.2.7",
|
||||
"@types/react-window": "^1.8.5",
|
||||
"@types/sinon": "^21.0.0",
|
||||
"@types/spotify-web-api-node": "^5.0.7",
|
||||
"@types/superagent": "^8.1.9",
|
||||
"@types/xml2js": "^0.4.11",
|
||||
"@vitejs/plugin-react": "^4.2.1",
|
||||
"@vitest/browser-playwright": "^4.1.0",
|
||||
"@vitest/coverage-v8": "^4.1.0",
|
||||
"chai": "^4.3.6",
|
||||
"chai-as-promised": "^7.1.1",
|
||||
"eslint": "^8.56.0",
|
||||
"eslint-plugin-prefer-arrow-functions": "^3.2.4",
|
||||
"eslint-plugin-storybook": "10.1.11",
|
||||
"git-cliff": "^2.12.0",
|
||||
"mocha": "^10.3.0",
|
||||
"mockdate": "^3.0.5",
|
||||
"msw": "^2.1.2",
|
||||
"msw": "^2.12.10",
|
||||
"neotraverse": "^0.6.18",
|
||||
"nodemon": "^3.0.3",
|
||||
"ts-essentials": "^9.1.2",
|
||||
"typescript": "5.5.4",
|
||||
"playwright": "^1.58.2",
|
||||
"sinon": "^21.0.2",
|
||||
"storybook": "^10.2.0",
|
||||
"ts-essentials": "^10.1.1",
|
||||
"typescript": "^5.9.3",
|
||||
"typescript-eslint": "^7.0.1",
|
||||
"vite": "^5.2.12",
|
||||
"vitest": "^4.1.0",
|
||||
"with-local-tmp-dir": "^6.0.0"
|
||||
},
|
||||
"browserslist": {
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
diff --git a/node_modules/@xhayper/discord-rpc/dist/transport/IPC.d.ts b/node_modules/@xhayper/discord-rpc/dist/transport/IPC.d.ts
|
||||
index 6da3fb1..796344d 100644
|
||||
--- a/node_modules/@xhayper/discord-rpc/dist/transport/IPC.d.ts
|
||||
+++ b/node_modules/@xhayper/discord-rpc/dist/transport/IPC.d.ts
|
||||
@@ -6,7 +6,7 @@ export declare enum IPC_OPCODE {
|
||||
PING = 3,
|
||||
PONG = 4
|
||||
}
|
||||
-export type FormatFunction = (id: number) => string;
|
||||
+export type FormatFunction = (id: number) => string | [number, string];
|
||||
export type PathData = {
|
||||
platform: NodeJS.Platform[];
|
||||
format: FormatFunction;
|
||||
diff --git a/node_modules/@xhayper/discord-rpc/dist/transport/IPC.js b/node_modules/@xhayper/discord-rpc/dist/transport/IPC.js
|
||||
index 2a9a7b3..074f5bb 100644
|
||||
--- a/node_modules/@xhayper/discord-rpc/dist/transport/IPC.js
|
||||
+++ b/node_modules/@xhayper/discord-rpc/dist/transport/IPC.js
|
||||
@@ -59,9 +59,12 @@ const createSocket = async (path) => {
|
||||
socket.removeListener("error", onError);
|
||||
resolve(socket);
|
||||
};
|
||||
- const socket = node_net_1.default.createConnection(path);
|
||||
+ let socket;
|
||||
+ if (typeof path === "string") socket = node_net_1.default.createConnection(path);
|
||||
+ else socket = node_net_1.default.createConnection(path[0], path[1]);
|
||||
socket.once("connect", onConnect);
|
||||
socket.once("error", onError);
|
||||
+ socket.setKeepAlive(true, 10000);
|
||||
});
|
||||
};
|
||||
class IPCTransport extends Transport_1.Transport {
|
||||
@@ -100,14 +103,19 @@ class IPCTransport extends Transport_1.Transport {
|
||||
else
|
||||
for (let i = 0; i < 10; i++)
|
||||
pipeIdList.push(i);
|
||||
- for (const pipeId of pipeIdList) {
|
||||
- const socketPath = pat.format(pipeId);
|
||||
- if (process.platform !== "win32" && !node_fs_1.default.existsSync(socketPath))
|
||||
- continue;
|
||||
- useablePath.push(socketPath);
|
||||
+ const test = pat.format(pipeId);
|
||||
+ if(Array.isArray(test)) {
|
||||
+ useablePath.push(test);
|
||||
+ } else {
|
||||
+ for (const pipeId of pipeIdList) {
|
||||
+ const socketPath = pat.format(pipeId);
|
||||
+ if (process.platform !== "win32" && typeof socketPath === 'string' && !node_fs_1.default.existsSync(socketPath))
|
||||
+ continue;
|
||||
+ useablePath.push(socketPath);
|
||||
+ }
|
||||
}
|
||||
}
|
||||
- this.client.emit("debug", `CLIENT | Found ${useablePath.length} Discord client path;\n${useablePath.join("\n")}`);
|
||||
+ this.client.emit("debug", `CLIENT | Found ${useablePath.length} Discord client path;\n${useablePath.map(x => Array.isArray(x) ? `${x[1]}:${x[0]}` : x).join("\n")}`);
|
||||
if (useablePath.length < 0)
|
||||
return reject(new RPCError_1.RPCError(Transport_1.CUSTOM_RPC_ERROR_CODE.COULD_NOT_FIND_CLIENT, "Unable to find any Discord client"));
|
||||
for (const path of useablePath) {
|
||||
@@ -134,11 +142,12 @@ class IPCTransport extends Transport_1.Transport {
|
||||
const chunk = this.socket?.read();
|
||||
if (!chunk)
|
||||
break;
|
||||
- this.client.emit("debug", `SERVER => CLIENT | ${chunk
|
||||
- .toString("hex")
|
||||
- .match(/.{1,2}/g)
|
||||
- ?.join(" ")
|
||||
- .toUpperCase()}`);
|
||||
+ // this.client.emit("debug", `SERVER => CLIENT | ${chunk
|
||||
+ // .toString("hex")
|
||||
+ // .match(/.{1,2}/g)
|
||||
+ // ?.join(" ")
|
||||
+ // .toUpperCase()}`);
|
||||
+ this.client.emit("debug", `SERVER => CLIENT | ${chunk.toString()}`);
|
||||
data = Buffer.concat([data, chunk]);
|
||||
} while (true);
|
||||
if (data.length < 8) {
|
||||
@@ -187,6 +196,9 @@ class IPCTransport extends Transport_1.Transport {
|
||||
this.socket = undefined;
|
||||
this.emit("close", "Closed by Discord");
|
||||
});
|
||||
+ this.socket.on("error", (e) => {
|
||||
+ this.emit("error", e);
|
||||
+ });
|
||||
}
|
||||
send(message, op = IPC_OPCODE.FRAME) {
|
||||
this.client.emit("debug", `CLIENT => SERVER | OPCODE.${IPC_OPCODE[op]} |`, message);
|
||||
@@ -4,33 +4,32 @@ import {
|
||||
} from "@foxxmd/regex-buddy-core";
|
||||
import deepEqual from 'fast-deep-equal';
|
||||
import { Simulate } from "react-dom/test-utils";
|
||||
import { PlayData, PlayObject, TransformResult } from "../../core/Atomic.js";
|
||||
import { LifecycleStep, PlayData, PlayObject, TransformResult } from "../../core/Atomic.js";
|
||||
import { buildPlayHumanDiffable, buildTrackString } from "../../core/StringUtils.js";
|
||||
import { CommonClientConfig } from "./infrastructure/config/client/index.js";
|
||||
import { CommonSourceConfig } from "./infrastructure/config/source/index.js";
|
||||
import { mergeSimpleError, SkipTransformStageError, StagePrerequisiteError, StageTransformError, TransformRulesError } from "./errors/MSErrors.js";
|
||||
import {
|
||||
FLOW_CONTROL_TERM,
|
||||
PlayTransformRules,
|
||||
StageConfig,
|
||||
TRANSFORM_HOOK,
|
||||
TransformHook
|
||||
} from "./infrastructure/Transform.js";
|
||||
import AbstractInitializable from "./AbstractInitializable.js";
|
||||
import play = Simulate.play;
|
||||
import TransformerManager from "./transforms/TransformerManager.js";
|
||||
import { getRoot } from "../ioc.js";
|
||||
import { nanoid } from "nanoid";
|
||||
import {diffStringsUnified, DiffOptionsColor} from 'jest-diff';
|
||||
import chalk from 'chalk';
|
||||
import { isDebugMode } from "../utils.js";
|
||||
import { findCauseByReference } from "../utils/ErrorUtils.js";
|
||||
import { hashObject } from "../utils/StringUtils.js";
|
||||
import { metaInvariantTransform, playContentInvariantTransform } from "../utils/PlayComparisonUtils.js";
|
||||
import { MSCache } from "./Cache.js";
|
||||
import { jdiff } from "../utils/DataUtils.js";
|
||||
import ConsoleFormatter from "jsondiffpatch/formatters/console";
|
||||
import { diffObjects, diffObjectsConsoleOutput, patchObject } from "../../core/DataUtils.js";
|
||||
import clone from "clone";
|
||||
import { loggerNoop } from "./MaybeLogger.js";
|
||||
|
||||
const console = new ConsoleFormatter();
|
||||
export type AbstractComponentConfig = (CommonClientConfig | CommonSourceConfig) & { transformManager?: TransformerManager };
|
||||
|
||||
export default abstract class AbstractComponent extends AbstractInitializable {
|
||||
|
||||
@@ -41,9 +40,9 @@ export default abstract class AbstractComponent extends AbstractInitializable {
|
||||
protected transformManager: TransformerManager;
|
||||
protected cache: MSCache;
|
||||
|
||||
protected constructor(config: CommonClientConfig | CommonSourceConfig) {
|
||||
protected constructor(config: AbstractComponentConfig) {
|
||||
super(config);
|
||||
this.transformManager = getRoot().items.transformerManager;
|
||||
this.transformManager = config.transformManager ?? getRoot().items.transformerManager;
|
||||
this.cache = getRoot().items.cache();
|
||||
}
|
||||
|
||||
@@ -166,7 +165,7 @@ export default abstract class AbstractComponent extends AbstractInitializable {
|
||||
return partArr.map(x => this.transformManager.parseTransformerConfig(x));
|
||||
}
|
||||
|
||||
public transformPlay = async (play: PlayObject, hookType: TransformHook, log?: boolean) => {
|
||||
public transformPlay = async (play: PlayObject, hookType: TransformHook, log?: boolean | 'all') => {
|
||||
|
||||
|
||||
const asyncId = nanoid(6);
|
||||
@@ -196,164 +195,229 @@ export default abstract class AbstractComponent extends AbstractInitializable {
|
||||
|
||||
const shouldLog = log ?? this.config.options?.playTransform?.log ?? isDebugMode();
|
||||
|
||||
const transformHash = `playTransform-${hashObject(hook)}-${hashObject(metaInvariantTransform(play))}`;
|
||||
const cachedTransformPlay = await this.cache.cacheTransform.get<PlayObject>(transformHash);
|
||||
if(cachedTransformPlay !== undefined) {
|
||||
// if(shouldLog) {
|
||||
// logger.debug(`Used cached Transform for => ${buildTrackString(play)}`);
|
||||
// }
|
||||
//logger.debug(`Cache hit ${transformHash}`);
|
||||
return cachedTransformPlay;
|
||||
const transformHash = `playTransform-${hashObject(hook)}-${hashObject(playContentInvariantTransform(play))}`;
|
||||
const cachedSteps = await this.cache.cacheTransform.get<LifecycleStep[]>(transformHash);
|
||||
if(cachedSteps !== undefined) {
|
||||
logger.trace(`Cache hit for Steps => ${transformHash}`);
|
||||
//return cachedTransformPlay;
|
||||
}
|
||||
|
||||
logger.debug(`Transform start for => ${buildTrackString(play)}`);
|
||||
let transformedPlay: PlayObject = play;
|
||||
let transformHistory: TransformResult[] = [];
|
||||
for(const hookItem of hook) {
|
||||
let transformedPlay: PlayObject = clone(play);
|
||||
let cacheOk: boolean = true;
|
||||
const steps: LifecycleStep[] = [];
|
||||
|
||||
const {
|
||||
onSuccess = 'continue',
|
||||
onFailure = 'stop',
|
||||
onSkip = 'continue',
|
||||
failureReturnPartial = false
|
||||
} = hookItem;
|
||||
const opts = {
|
||||
logger,
|
||||
asyncId
|
||||
}
|
||||
|
||||
let newTransformedPlay: PlayObject,
|
||||
stageName: string = 'Unnamed',
|
||||
err: Error,
|
||||
cacheOk: boolean = true;
|
||||
try {
|
||||
[newTransformedPlay, stageName] = await this.transformManager.handleStage(hookItem, transformedPlay, asyncId);
|
||||
} catch (e) {
|
||||
err = e;
|
||||
if(e instanceof StageTransformError) {
|
||||
stageName = e.stageName;
|
||||
}
|
||||
if(cachedSteps !== undefined) {
|
||||
// don't re-cache cached steps
|
||||
cacheOk = false;
|
||||
// only patch play if steps didn't end in a failure that we are okay with returning partial from
|
||||
let shouldTransform = true;
|
||||
const lastCachedStep = cachedSteps[cachedSteps.length - 1];
|
||||
if(lastCachedStep.error !== undefined && lastCachedStep.flowKnownState !== 'skip' && !lastCachedStep.returnPartial) {
|
||||
shouldTransform = false;
|
||||
}
|
||||
|
||||
if(err !== undefined) {
|
||||
const merged = mergeSimpleError(err);
|
||||
const skipError = findCauseByReference(err, SkipTransformStageError);
|
||||
if(skipError !== undefined) {
|
||||
let skipMsg = `Stage '${stageName}' was skipped`;
|
||||
if(onSkip === 'stop') {
|
||||
skipMsg += ' and will stop transform due to onSkip: stop';
|
||||
}
|
||||
logger.debug(merged, skipMsg);
|
||||
if(onSkip === 'stop') {
|
||||
break;
|
||||
}
|
||||
} else if(onFailure === 'continue') {
|
||||
logger.warn(merged, 'A transform encounte[red an error but continuing due to onFailure: continue');
|
||||
} else {
|
||||
const reqError = findCauseByReference(err, StagePrerequisiteError);
|
||||
if(reqError !== undefined) {
|
||||
logger.warn(merged, 'Transform could not be completed due to prerequisite failure');
|
||||
} else {
|
||||
logger.error(merged, 'Transform encountered an error');
|
||||
cacheOk = false;
|
||||
}
|
||||
|
||||
if(!failureReturnPartial) {
|
||||
// rewind to original play so we don't return partial transform
|
||||
for(const s of cachedSteps) {
|
||||
steps.push({...s, cached: true});
|
||||
if(shouldTransform && s.patch !== undefined) {
|
||||
transformedPlay.data = patchObject(transformedPlay.data, s.patch); // jdiff.patch(clone(transformedPlay.data),s.patch);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
for(const hookItem of hook) {
|
||||
const [step, stepPlay] = await this.generateStepFromStage(transformedPlay, hookItem, hookType, opts);
|
||||
steps.push(step);
|
||||
cacheOk = step.error === undefined || (step.error !== undefined && step.flowKnownState !== undefined);
|
||||
if(step.flowResult === FLOW_CONTROL_TERM.stop) {
|
||||
if(step.error !== undefined && step.flowKnownState !== 'skip' && !step.returnPartial) {
|
||||
// revert to original play but keep steps for paper trail
|
||||
transformedPlay = play;
|
||||
transformHistory = [];
|
||||
transformedPlay.meta.lifecycle.steps = steps;
|
||||
} else {
|
||||
transformedPlay = stepPlay;
|
||||
}
|
||||
break;
|
||||
} else {
|
||||
transformedPlay = stepPlay;
|
||||
}
|
||||
} else {
|
||||
transformHistory.push({
|
||||
type: hookItem.type,
|
||||
name: stageName,
|
||||
play: newTransformedPlay.data
|
||||
});
|
||||
transformedPlay = newTransformedPlay;
|
||||
}
|
||||
|
||||
if(err === undefined && onSuccess === 'stop') {
|
||||
logger.debug(`Stopping transform due to onSuccess: stop`);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
const orig = play.data;
|
||||
|
||||
// if(transformedPlay.meta.transforms === undefined) {
|
||||
// transformedPlay.meta.transforms = {
|
||||
// original: play.data
|
||||
// };
|
||||
// }
|
||||
|
||||
const o = JSON.parse(JSON.stringify(play));
|
||||
const t = JSON.parse(JSON.stringify(transformedPlay));
|
||||
const patch = jdiff.diff(o,t);
|
||||
const historyToDiff: {name: string, data?: PlayData}[] = [
|
||||
{name: 'Pre Transform', data: play.data}
|
||||
];
|
||||
if(steps.length > 0 && transformedPlay.meta?.lifecycle?.steps === undefined) {
|
||||
const {
|
||||
meta: {
|
||||
lifecycle: {
|
||||
steps = [],
|
||||
...lifecycleRest
|
||||
},
|
||||
} = {}
|
||||
} = transformedPlay;
|
||||
transformedPlay.meta.lifecycle = {
|
||||
...lifecycleRest,
|
||||
steps
|
||||
}
|
||||
}
|
||||
steps.forEach((s, index) => {
|
||||
const existingStepIndex = transformedPlay.meta.lifecycle.steps.findIndex(x => x.name === 'hookType' && x.source === this.getIdentifier());
|
||||
if(existingStepIndex !== -1) {
|
||||
transformedPlay.meta.lifecycle.steps[existingStepIndex] = s;
|
||||
} else {
|
||||
transformedPlay.meta.lifecycle.steps.push(s);
|
||||
}
|
||||
|
||||
if(shouldLog === 'all') {
|
||||
if(s.patch === undefined) {
|
||||
historyToDiff.push({name: `${s.source}-${s.name}`});
|
||||
} else {
|
||||
const patched = patchObject(historyToDiff[historyToDiff.length - 1].data, s.patch);
|
||||
historyToDiff.push({name: `${s.source}-${s.name}${s.cached ? ' (Cached)' : ''}`, data: patched});
|
||||
}
|
||||
}
|
||||
});
|
||||
if(shouldLog !== false) {
|
||||
if(transformHistory.length === 0) {
|
||||
if(steps.filter(x => x.patch !== undefined).length === 0) {
|
||||
logger.debug('Transform Diff: No Change');
|
||||
} else {
|
||||
const historyToDiff: {name: string, data: PlayData}[] = [
|
||||
{name: 'Original', data: play.data}
|
||||
];
|
||||
if(shouldLog === true) {
|
||||
const last = transformHistory[transformHistory.length - 1];
|
||||
historyToDiff.push({name: `${last.type}-${last.name}`, data: last.play});
|
||||
} else {
|
||||
for(const t of transformHistory) {
|
||||
historyToDiff.push({name: `${t.type}-${t.name}`, data: t.play})
|
||||
}
|
||||
}
|
||||
const diffs: string[] = [];
|
||||
|
||||
historyToDiff.forEach((curr, index) => {
|
||||
if(index === 0) {
|
||||
return;
|
||||
}
|
||||
const last = historyToDiff[index - 1];
|
||||
if(deepEqual(last.data, curr.data)) {
|
||||
if(curr.data === undefined) {
|
||||
diffs.push(`${last.name} => ${curr.name} -- No Change`);
|
||||
} else {
|
||||
const unchanged = index - 1 === 0 ? last.data : undefined;
|
||||
|
||||
const formattedDiff = console.format(jdiff.diff(last.data, curr.data), unchanged);
|
||||
const formattedDiff = diffObjectsConsoleOutput(last.data, curr.data);
|
||||
diffs.push(`${last.name} => ${curr.name}\n${formattedDiff}`);
|
||||
}
|
||||
});
|
||||
|
||||
if(shouldLog === true || steps.filter(x => x.patch !== undefined).length > 2) {
|
||||
const finalData = transformedPlay.data;
|
||||
const formattedDiff = diffObjectsConsoleOutput(play.data, finalData, true);
|
||||
diffs.push(`Original => Final\n${formattedDiff}`);
|
||||
}
|
||||
|
||||
logger.debug(`Transform Diff\n${diffs.join('\n')}`);
|
||||
}
|
||||
}
|
||||
|
||||
const existingStepIndex = transformedPlay.meta.lifecycle.steps.findIndex(x => x.name === 'hookType' && x.source === this.getIdentifier());
|
||||
if(existingStepIndex !== -1) {
|
||||
transformedPlay.meta.lifecycle.steps[existingStepIndex].patch = patch;
|
||||
transformedPlay.meta.lifecycle.steps[existingStepIndex].inputs = transformedPlay.meta.lifecycleInputs;
|
||||
} else {
|
||||
transformedPlay.meta.lifecycle.steps.push({
|
||||
name: hookType,
|
||||
source: this.getIdentifier(),
|
||||
patch: patch,
|
||||
inputs: transformedPlay.meta.lifecycleInputs
|
||||
});
|
||||
if(cacheOk) {
|
||||
await this.cache.cacheTransform.set<LifecycleStep[]>(transformHash, steps, '2m');
|
||||
}
|
||||
delete transformedPlay.meta.lifecycleInputs;
|
||||
|
||||
// transformedPlay.meta.lifecycle = {
|
||||
// ...(transformedPlay.meta.lifecycle ?? {
|
||||
// original: play
|
||||
// }),
|
||||
// steps: [
|
||||
// ...(transformedPlay.meta.lifecycle?.steps ?? []),
|
||||
// {
|
||||
// name: hookType,
|
||||
// source: this.getIdentifier(),
|
||||
// patch: patch
|
||||
// }
|
||||
// ]
|
||||
// }
|
||||
await this.cache.cacheTransform.set<PlayObject>(transformHash, transformedPlay, '5m');
|
||||
return transformedPlay;
|
||||
} catch (e) {
|
||||
logger.warn(new Error(`Unexpected error occurred, returning original play.`, {cause: e}));
|
||||
return play;
|
||||
}
|
||||
}
|
||||
|
||||
protected generateStepFromStage = async (playTruth: PlayObject, hookItem: StageConfig, hookType: TransformHook, opts: { logger?: Logger, asyncId?: string } = {}): Promise<[LifecycleStep, PlayObject]> => {
|
||||
const {
|
||||
onSuccess = 'continue',
|
||||
onFailure = 'stop',
|
||||
onSkip = 'continue',
|
||||
failureReturnPartial = false
|
||||
} = hookItem;
|
||||
|
||||
const {
|
||||
logger = loggerNoop,
|
||||
asyncId = nanoid(6)
|
||||
} = opts;
|
||||
|
||||
const stepName = `${hookType} - ${hookItem.type} - ${hookItem.name}`
|
||||
const existingStepIndex = playTruth.meta.lifecycle.steps.findIndex(x => x.name === stepName && x.source === this.getIdentifier());
|
||||
const step: LifecycleStep = existingStepIndex !== -1 ? playTruth.meta.lifecycle.steps[existingStepIndex] : {
|
||||
name: stepName,
|
||||
source: this.getIdentifier(),
|
||||
}
|
||||
|
||||
let newTransformedPlay: PlayObject,
|
||||
stageName: string = 'Unnamed',
|
||||
err: Error;
|
||||
try {
|
||||
[newTransformedPlay, stageName] = await this.transformManager.handleStage(hookItem, playTruth, asyncId);
|
||||
newTransformedPlay = clone(newTransformedPlay);
|
||||
} catch (e) {
|
||||
err = e;
|
||||
if (e instanceof StageTransformError) {
|
||||
stageName = e.stageName;
|
||||
}
|
||||
}
|
||||
|
||||
if (err !== undefined) {
|
||||
const merged = mergeSimpleError(err);
|
||||
step.error = merged;
|
||||
|
||||
const skipError = findCauseByReference(err, SkipTransformStageError);
|
||||
if (skipError !== undefined) {
|
||||
let skipMsg = `Stage '${stageName}' was skipped`;
|
||||
step.flowResult = onSkip;
|
||||
step.flowKnownState = 'skip';
|
||||
|
||||
if (onSkip === 'stop') {
|
||||
skipMsg += ' and will stop transform due to onSkip: stop';
|
||||
}
|
||||
step.flowReason = skipMsg;
|
||||
|
||||
logger.debug(merged, skipMsg);
|
||||
} else {
|
||||
step.flowResult = onFailure;
|
||||
let reason: string;
|
||||
|
||||
const reqError = findCauseByReference(err, StagePrerequisiteError);
|
||||
if (reqError !== undefined) {
|
||||
reason = 'Transform could not be completed due to prerequisite failure';
|
||||
step.flowKnownState = 'prereq';
|
||||
} else {
|
||||
reason = 'Transform encountered an error';
|
||||
}
|
||||
|
||||
if (onFailure === 'continue') {
|
||||
reason += ' but will continue due to onFailure: continue';
|
||||
logger.warn(merged, reason);
|
||||
} else {
|
||||
if (failureReturnPartial) {
|
||||
reason += ' | Preserving play transformations up to this point due to failureReturnPartial=true';
|
||||
step.returnPartial = true;
|
||||
}
|
||||
|
||||
logger[reqError !== undefined ? 'warn' : 'error'](merged, reason);
|
||||
}
|
||||
step.flowReason = reason;
|
||||
|
||||
return [step, playTruth];
|
||||
}
|
||||
} else {
|
||||
step.flowResult = onSuccess;
|
||||
|
||||
if (!deepEqual(playTruth.data, newTransformedPlay.data)) {
|
||||
const o = JSON.parse(JSON.stringify(playTruth.data));
|
||||
const t = JSON.parse(JSON.stringify(newTransformedPlay.data));
|
||||
const patch = diffObjects(o, t); // jdiff.diff(o, t);
|
||||
step.patch = patch;
|
||||
}
|
||||
|
||||
if (newTransformedPlay.meta.lifecycleInputs?.length > 0) {
|
||||
step.inputs = clone(newTransformedPlay.meta.lifecycleInputs)
|
||||
} else if (playTruth.meta.lifecycleInputs?.length > 0) {
|
||||
logger.warn({ label: `${hookItem.type} - ${hookItem.name}` }, `Should only be adding inputs to transformed play!`);
|
||||
step.inputs = clone(playTruth.meta.lifecycleInputs)
|
||||
}
|
||||
|
||||
delete newTransformedPlay.meta.lifecycleInputs;
|
||||
}
|
||||
|
||||
return [step, newTransformedPlay];
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Cacheable, createKeyv, Keyv, KeyvStoreAdapter, KeyvOptions, CacheableOptions } from 'cacheable';
|
||||
import { Cacheable, createKeyv, Keyv, KeyvStoreAdapter, KeyvOptions, CacheableOptions, KeyvCacheableMemory } from 'cacheable';
|
||||
import { FlatCache, FlatCacheOptions } from 'flat-cache';
|
||||
import KeyvValkey from '@keyv/valkey';
|
||||
import KeyvValkey, { KeyvValkeyOptions } from '@keyv/valkey';
|
||||
import dayjs, { Dayjs } from 'dayjs';
|
||||
import duration from 'dayjs/plugin/duration.js';
|
||||
import isBetween from 'dayjs/plugin/isBetween.js';
|
||||
@@ -13,13 +13,14 @@ import { childLogger, Logger } from '@foxxmd/logging';
|
||||
import { projectDir } from './index.js';
|
||||
import path from 'path';
|
||||
import { cacheFunctions } from "@foxxmd/regex-buddy-core";
|
||||
import { fileOrDirectoryIsWriteable } from '../utils.js';
|
||||
import { asCacheAuthProvider, asCacheMetadataProvider, asCacheScrobbleProvider, CacheAuthProvider, CacheConfig, CacheConfigOptions, CacheMetadataProvider, CacheProvider, CacheScrobbleProvider } from './infrastructure/Atomic.js';
|
||||
import { fileOrDirectoryIsWriteable } from '../utils/FSUtils.js';
|
||||
import { asCacheAuthProvider, asCacheConfig, asCacheMetadataProvider, asCacheScrobbleProvider, CacheAuthProvider, CacheConfig, CacheConfigOptions, CacheMetadataProvider, CacheProvider, CacheScrobbleProvider } from './infrastructure/Atomic.js';
|
||||
import { Typeson } from 'typeson';
|
||||
import { builtin } from 'typeson-registry';
|
||||
import { MaybeLogger } from './logging.js';
|
||||
import { loggerNoop } from './MaybeLogger.js';
|
||||
import { ListenProgressPositional, ListenProgressTS } from '../sources/PlayerState/ListenProgress.js';
|
||||
const configDir = process.env.CONFIG_DIR || path.resolve(projectDir, `./config`);
|
||||
import prom, { Gauge } from 'prom-client';
|
||||
|
||||
dayjs.extend(utc)
|
||||
dayjs.extend(isBetween);
|
||||
@@ -50,15 +51,24 @@ export class MSCache {
|
||||
cacheAuth: Cacheable;
|
||||
regexCache: ReturnType<typeof cacheFunctions>;
|
||||
cacheTransform: Cacheable;
|
||||
cacheClientScrobbles: Cacheable;
|
||||
cacheApi: Cacheable;
|
||||
hasInit: boolean = false;
|
||||
|
||||
logger: Logger;
|
||||
|
||||
cacheHits: Gauge;
|
||||
cacheMisses: Gauge;
|
||||
cacheSets: Gauge;
|
||||
cacheCount: Gauge;
|
||||
//cacheVSize: Gauge;
|
||||
|
||||
constructor(logger: Logger, config: CacheConfigOptions = {}) {
|
||||
this.logger = childLogger(logger, 'Cache');
|
||||
|
||||
const {
|
||||
metadata: {
|
||||
provider: mProvider = (process.env.CACHE_METADATA as (CacheMetadataProvider | undefined) ?? 'memory'),
|
||||
provider: mProvider = (process.env.CACHE_METADATA as (CacheMetadataProvider | undefined) ?? false),
|
||||
connection: mConn = process.env.CACHE_METADATA_CONN,
|
||||
...restMetadata
|
||||
} = {},
|
||||
@@ -95,86 +105,232 @@ export class MSCache {
|
||||
};
|
||||
|
||||
this.regexCache = cacheFunctions(this.config.regex);
|
||||
this.cacheTransform = new Cacheable({primary: initMemoryCache({lruSize: 500})});
|
||||
|
||||
// for testing we default to in memory
|
||||
const inMemory = new Cacheable({primary: initMemoryCache({lruSize: 500, ttl: '1m'})});
|
||||
this.cacheTransform = inMemory;
|
||||
this.cacheClientScrobbles = inMemory;
|
||||
this.cacheMetadata = inMemory;
|
||||
this.cacheAuth = inMemory;
|
||||
this.cacheScrobble = inMemory;
|
||||
this.cacheApi = inMemory;
|
||||
}
|
||||
|
||||
init = async () => {
|
||||
init = async (enableCollectors: boolean = false) => {
|
||||
await this.initMetadataCache();
|
||||
await this.initScrobbleCache();
|
||||
await this.initAuthCache();
|
||||
//this.cacheTransform = await this.initCacheable({provider: false, memory: {lruSize: 500}}, 'transform');
|
||||
|
||||
if(enableCollectors) {
|
||||
this.enableCollectors();
|
||||
}
|
||||
}
|
||||
|
||||
protected initCacheable = async (config: CacheConfig, cacheFor: string) => {
|
||||
protected enableCollectors = () => {
|
||||
|
||||
const collectors: {cache: Cacheable, name: string}[] = [
|
||||
{ cache: this.cacheMetadata, name: 'metadata' },
|
||||
{ cache: this.cacheScrobble, name: 'queued_scrobbles' },
|
||||
{ cache: this.cacheTransform, name: 'transformer' },
|
||||
{ cache: this.cacheClientScrobbles, name: 'historical_scrobbles' },
|
||||
{ cache: this.cacheApi, name: 'external_apis' }
|
||||
];
|
||||
|
||||
this.cacheHits = new prom.Gauge({
|
||||
name: 'multiscrobbler_cache_hits',
|
||||
help: 'cache hits',
|
||||
labelNames: ['cacheType', 'tier'],
|
||||
collect() {
|
||||
for(const set of collectors) {
|
||||
const [primary, secondary] = getStat(set.cache, 'hits');
|
||||
this.labels({cacheType: set.name, tier: 'primary'}).set(primary);
|
||||
if(secondary !== undefined) {
|
||||
this.labels({cacheType: set.name, tier: 'secondary'}).set(secondary);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
});
|
||||
this.cacheMisses = new prom.Gauge({
|
||||
name: 'multiscrobbler_cache_misses',
|
||||
help: 'cache misses',
|
||||
labelNames: ['cacheType', 'tier'],
|
||||
collect() {
|
||||
for(const set of collectors) {
|
||||
const [primary, secondary] = getStat(set.cache, 'misses');
|
||||
this.labels({cacheType: set.name, tier: 'primary'}).set(primary);
|
||||
if(secondary !== undefined) {
|
||||
this.labels({cacheType: set.name, tier: 'secondary'}).set(secondary);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
});
|
||||
|
||||
this.cacheMisses = new prom.Gauge({
|
||||
name: 'multiscrobbler_cache_sets',
|
||||
help: 'cache sets',
|
||||
labelNames: ['cacheType', 'tier'],
|
||||
collect() {
|
||||
for(const set of collectors) {
|
||||
const [primary, secondary] = getStat(set.cache, 'sets');
|
||||
this.labels({cacheType: set.name, tier: 'primary'}).set(primary);
|
||||
if(secondary !== undefined) {
|
||||
this.labels({cacheType: set.name, tier: 'secondary'}).set(secondary);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
});
|
||||
|
||||
this.cacheCount = new prom.Gauge({
|
||||
name: 'multiscrobbler_cache_count',
|
||||
help: 'number of keys in cache',
|
||||
labelNames: ['cacheType', 'tier'],
|
||||
collect() {
|
||||
for(const set of collectors) {
|
||||
const [primary] = getStat(set.cache, 'count', false);
|
||||
this.labels({cacheType: set.name, tier: 'primary'}).set(primary);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// this.cacheVSize = new prom.Gauge({
|
||||
// name: 'multiscrobbler_cache_vsize',
|
||||
// help: 'estimated byte size of values in cache',
|
||||
// labelNames: ['cacheType', 'tier'],
|
||||
// collect() {
|
||||
// for(const set of collectors) {
|
||||
// const [primary] = getStat(set.cache, 'vsize', false);
|
||||
// this.labels({cacheType: set.name, tier: 'primary'}).set(primary);
|
||||
// }
|
||||
// }
|
||||
// });
|
||||
}
|
||||
|
||||
protected initCacheable = async (cacheFor: string, primaryConfig: CacheConfig, secondaryConfig?: CacheConfig) => {
|
||||
|
||||
let logger = childLogger(this.logger, cacheFor);
|
||||
const providerHints = ['In-Memory (Primary)'];
|
||||
if(config.provider !== false) {
|
||||
providerHints.push(`${config.provider} (Secondary)`)
|
||||
const providerHints = [];
|
||||
if(primaryConfig.provider === false) {
|
||||
const cache = new Cacheable({primary: noopKeyv});
|
||||
cache.stats.enabled = true;
|
||||
logger.verbose(`Cache Providers: Disabled`);
|
||||
return cache;
|
||||
}
|
||||
logger.verbose(`Cache Providers: ${providerHints.join(' | ')}`)
|
||||
|
||||
providerHints.push(`${primaryConfig.provider} (Primary)`)
|
||||
|
||||
if(secondaryConfig === undefined || secondaryConfig.provider !== false) {
|
||||
providerHints.push(`Disabled (Secondary)`)
|
||||
} else {
|
||||
providerHints.push(`${secondaryConfig.provider} (Secondary)`);
|
||||
}
|
||||
logger.verbose(`Cache Providers: ${providerHints.join(' | ')}`);
|
||||
|
||||
const ns = `ms-${cacheFor.toLocaleLowerCase()}`;
|
||||
|
||||
const cacheOpts: CacheableOptions = {
|
||||
primary: initMemoryCache({ namespace: ns, lruSize: config.memory?.lruSize, ttl: config.memory?.ttl })
|
||||
|
||||
}
|
||||
|
||||
let secondaryCache: Keyv | KeyvStoreAdapter | undefined;
|
||||
try {
|
||||
cacheOpts.primary = await this.initCachableType(ns, primaryConfig, logger);
|
||||
} catch (e) {
|
||||
throw new Error('Could not init primary cache', {cause: e});
|
||||
}
|
||||
|
||||
if(secondaryConfig !== undefined && secondaryConfig.provider !== false) {
|
||||
try {
|
||||
cacheOpts.secondary = await this.initCachableType(ns, secondaryConfig, logger);
|
||||
} catch (e) {
|
||||
this.logger.warn(e);
|
||||
}
|
||||
}
|
||||
|
||||
const cache = new Cacheable(cacheOpts);
|
||||
cache.stats.enabled = true;
|
||||
return cache;
|
||||
|
||||
}
|
||||
|
||||
protected initCachableType = async (namespace: string, config: CacheConfig, logger: Logger): Promise<Keyv<any> | KeyvStoreAdapter> => {
|
||||
|
||||
if (config.provider === 'memory') {
|
||||
return initMemoryCache({ namespace, lruSize: config.lruSize, ttl: config.ttl });
|
||||
}
|
||||
|
||||
if (config.provider === 'valkey') {
|
||||
logger.debug(`Building valkey cache from ${config.connection}`);
|
||||
try {
|
||||
secondaryCache = await initValkeyCache(ns, config.connection);
|
||||
const cache = await initValkeyCache(namespace, config.connection, undefined, {ttl: config.ttl});
|
||||
logger.debug('valkey cache connected');
|
||||
return cache;
|
||||
} catch (e) {
|
||||
this.logger.warn(e);
|
||||
throw e;
|
||||
}
|
||||
} else if (config.provider === 'file') {
|
||||
logger.debug(`Building file cache from ${path.join(config.connection, `${ns}.cache`)}`);
|
||||
}
|
||||
if (config.provider === 'file') {
|
||||
logger.debug(`Building file cache from ${path.join(config.connection, `${namespace}.cache`)}`);
|
||||
|
||||
try {
|
||||
const [keyvFile] = await initFileCache({ ...config, cacheDir: config.connection, cacheId: `${ns}.cache` }, logger);
|
||||
secondaryCache = keyvFile;
|
||||
const [keyvFile] = await initFileCache({ ...config, cacheDir: config.connection, cacheId: `${namespace}.cache` }, {ttl: config.ttl}, logger);
|
||||
return keyvFile;
|
||||
} catch (e) {
|
||||
logger.warn(e);
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
if(secondaryCache !== undefined) {
|
||||
cacheOpts.secondary = secondaryCache;
|
||||
}
|
||||
return new Cacheable(cacheOpts);
|
||||
|
||||
}
|
||||
|
||||
initScrobbleCache = async () => {
|
||||
if (this.cacheScrobble === undefined) {
|
||||
if (!asCacheScrobbleProvider(this.config.scrobble.provider)) {
|
||||
throw new Error(`Cache Scrobble provider '${this.config.scrobble.provider}' must be one of: memory, valkey, file`);
|
||||
if (!this.hasInit) {
|
||||
let scrobbleConfig: CacheConfig | undefined;
|
||||
try {
|
||||
if(asCacheConfig(this.config.scrobble)) {
|
||||
scrobbleConfig = this.config.scrobble;
|
||||
this.cacheScrobble = await this.initCacheable('Scrobble', this.config.scrobble);
|
||||
}
|
||||
} catch (e) {
|
||||
this.logger.warn(new Error('Could not validate scrobble config! No fallback is possible', {cause: e}));
|
||||
this.cacheScrobble = await this.initCacheable('Scrobble', {provider: false});
|
||||
}
|
||||
|
||||
this.cacheScrobble = await this.initCacheable(this.config.scrobble, 'Scrobble');
|
||||
}
|
||||
}
|
||||
|
||||
initMetadataCache = async () => {
|
||||
if (this.cacheMetadata === undefined) {
|
||||
if (!asCacheMetadataProvider(this.config.metadata.provider)) {
|
||||
throw new Error(`Cache Metadata provider '${this.config.metadata.provider}' must be one of: memory, valkey`);
|
||||
if (!this.hasInit) {
|
||||
let metadataConfig: CacheConfig | undefined;
|
||||
try {
|
||||
if(asCacheConfig(this.config.metadata)) {
|
||||
metadataConfig = this.config.metadata;
|
||||
}
|
||||
} catch (e) {
|
||||
this.logger.warn(new Error('Could not validate metadata config, will fallback to memory cache only', {cause: e}));
|
||||
}
|
||||
|
||||
this.cacheMetadata = await this.initCacheable(this.config.metadata, 'Metadata');
|
||||
this.cacheMetadata = await this.initCacheable('Metadata', {provider: 'memory', ttl: '3m', lruSize: 100}, metadataConfig === undefined ? undefined : {...this.config.metadata, ttl: '15m'});
|
||||
this.cacheMetadata.stats.enabled = true;
|
||||
this.cacheClientScrobbles = await this.initCacheable('Historical Scrobbles', {provider: 'memory', ttl: '2m', lruSize: 50}, metadataConfig === undefined ? undefined : {...this.config.metadata, ttl: '10m'});
|
||||
this.cacheClientScrobbles.stats.enabled = true;
|
||||
this.cacheTransform = await this.initCacheable('Transform Data', {provider: 'memory', ttl: '2m', lruSize: 100}, metadataConfig === undefined ? undefined : {...this.config.metadata, ttl: '5m'});
|
||||
this.cacheTransform.stats.enabled = true;
|
||||
this.cacheApi = await this.initCacheable('External API Responses', {provider: 'memory', ttl: '30s', lruSize: 100}, metadataConfig === undefined ? undefined : {...this.config.metadata, ttl: '20m'});
|
||||
this.cacheApi.stats.enabled = true;
|
||||
}
|
||||
}
|
||||
|
||||
initAuthCache = async () => {
|
||||
if (this.cacheAuth === undefined) {
|
||||
if (!asCacheAuthProvider(this.config.auth.provider)) {
|
||||
throw new Error(`Cache Auth provider '${this.config.auth.provider}' must be one of: memory, valkey, file`);
|
||||
if (!this.hasInit) {
|
||||
let authConfig: CacheConfig | undefined;
|
||||
try {
|
||||
if(asCacheConfig(this.config.scrobble)) {
|
||||
authConfig = this.config.auth;
|
||||
}
|
||||
} catch (e) {
|
||||
this.logger.warn(new Error('Could not validate auth config! will fallback to memory cache only', {cause: e}));
|
||||
this.cacheScrobble = await this.initCacheable('Scrobble', {provider: false});
|
||||
}
|
||||
|
||||
this.cacheAuth = await this.initCacheable(this.config.auth, 'Auth');
|
||||
this.cacheAuth = await this.initCacheable('Auth', {provider: 'memory', ttl: '3m'}, authConfig);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -183,13 +339,15 @@ export class MSCache {
|
||||
|
||||
export const initMemoryCache = <T = any>(opts: Parameters<typeof createKeyv>[0] = {}): Keyv<T> | KeyvStoreAdapter => {
|
||||
const {
|
||||
ttl = '1h',
|
||||
ttl = '60s',
|
||||
lruSize = 200,
|
||||
...restOpts
|
||||
} = opts;
|
||||
const memory = createKeyv({
|
||||
ttl,
|
||||
lruSize,
|
||||
// millisecond interval before checking for expired keys and deleting
|
||||
checkInterval: 10000,
|
||||
...restOpts,
|
||||
useClone: false,
|
||||
});
|
||||
@@ -198,6 +356,7 @@ export const initMemoryCache = <T = any>(opts: Parameters<typeof createKeyv>[0]
|
||||
memory.serialize = (data) => {
|
||||
return clone(data) as string;
|
||||
}
|
||||
memory.stats.enabled = true;
|
||||
return memory;
|
||||
}
|
||||
|
||||
@@ -213,7 +372,7 @@ export const flatCacheCreate = (opts: FlatCacheOptions) => {
|
||||
});
|
||||
}
|
||||
|
||||
export const flatCacheLoad = async (flatCache: FlatCache, logger: MaybeLogger): Promise<void> => {
|
||||
export const flatCacheLoad = async (flatCache: FlatCache, logger: Logger = loggerNoop): Promise<void> => {
|
||||
|
||||
const cachePath = path.join(flatCache.cacheDir, flatCache.cacheId);
|
||||
try {
|
||||
@@ -224,7 +383,7 @@ export const flatCacheLoad = async (flatCache: FlatCache, logger: MaybeLogger):
|
||||
|
||||
const streamPromise = new Promise((resolve, reject) => {
|
||||
flatCache.loadFileStream(cachePath, (progress: number, total: number) => {
|
||||
logger.debug(`Loading ${progress}/${total} chunks...`);
|
||||
logger.trace(`Loading ${progress}/${total} chunks...`);
|
||||
}, () => {
|
||||
resolve(true);
|
||||
}, (err: Error) => {
|
||||
@@ -260,7 +419,7 @@ export const flatCacheLoad = async (flatCache: FlatCache, logger: MaybeLogger):
|
||||
}
|
||||
}
|
||||
|
||||
export const initFileCache = async (opts: FlatCacheOptions = {}, logger: MaybeLogger = new MaybeLogger()): Promise<[Keyv | KeyvStoreAdapter | undefined, FlatCache | undefined]> => {
|
||||
export const initFileCache = async (opts: FlatCacheOptions = {}, keyvOpts: KeyvOptions = {}, logger: Logger = loggerNoop): Promise<[Keyv | KeyvStoreAdapter | undefined, FlatCache | undefined]> => {
|
||||
const flatCache = flatCacheCreate(opts);
|
||||
try {
|
||||
await flatCacheLoad(flatCache, logger);
|
||||
@@ -274,33 +433,36 @@ export const initFileCache = async (opts: FlatCacheOptions = {}, logger: MaybeLo
|
||||
const cache = new Keyv({
|
||||
store: flatCache,
|
||||
throwOnErrors: true,
|
||||
...typesonMarshalling
|
||||
...typesonMarshalling,
|
||||
...keyvOpts
|
||||
});
|
||||
cache.stats.enabled = true;
|
||||
return [cache, flatCache];
|
||||
} catch (e) {
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
export const valkeyCacheCreate = (ns: string, ...args: ConstructorParameters<typeof KeyvValkey>): Keyv => {
|
||||
const [connection, valkeyOpts = {}] = args;
|
||||
export const valkeyCacheCreate = (ns: string, connection: string, valkeyOpts: KeyvValkeyOptions = {}, keyvOpts: KeyvOptions = {}): Keyv => {
|
||||
const valkey = new KeyvValkey(connection, { maxRetriesPerRequest: 5, connectTimeout: 1100, ...valkeyOpts });
|
||||
const kv = new Keyv({
|
||||
store: valkey,
|
||||
throwOnErrors: true,
|
||||
namespace: ns,
|
||||
...typesonMarshalling
|
||||
...typesonMarshalling,
|
||||
...keyvOpts
|
||||
});
|
||||
kv.stats.enabled = true;
|
||||
return kv;
|
||||
}
|
||||
|
||||
export const initValkeyCache = async (ns: string, ...args: ConstructorParameters<typeof KeyvValkey>): Promise<Keyv> => {
|
||||
const kv = valkeyCacheCreate(ns, ...args);
|
||||
export const initValkeyCache = async (ns: string, connection: string, valkeyOpts: KeyvValkeyOptions = {}, keyvOpts: KeyvOptions = {}): Promise<Keyv> => {
|
||||
const kv = valkeyCacheCreate(ns, connection, valkeyOpts, keyvOpts);
|
||||
try {
|
||||
await kv.get('test');
|
||||
return kv;
|
||||
} catch (e) {
|
||||
throw new Error(`Unable to connect to cache ${args[0]}`, { cause: e })
|
||||
throw new Error(`Unable to connect to cache ${connection}`, { cause: e })
|
||||
}
|
||||
}
|
||||
|
||||
@@ -313,4 +475,26 @@ const typesonMarshalling: Pick<KeyvOptions, 'serialize' | 'deserialize'> = {
|
||||
const data = typeson.parseSync(str);
|
||||
return data;
|
||||
}
|
||||
}
|
||||
|
||||
const getStat = (cache: Cacheable, statName: string, getSecondary: boolean = true): [number, number?] => {
|
||||
let primary = cache.stats[statName];
|
||||
if(statName === 'count' && cache.primary.store instanceof KeyvCacheableMemory) {
|
||||
primary = cache.primary.store.store.size;
|
||||
}
|
||||
let secondary: number;
|
||||
if(getSecondary && cache.secondary !== undefined) {
|
||||
secondary = cache.secondary.stats[statName];
|
||||
}
|
||||
return [primary, secondary];
|
||||
}
|
||||
|
||||
const noopKeyv: KeyvStoreAdapter = {
|
||||
opts: {},
|
||||
namespace: 'noop',
|
||||
get: (_) => undefined,
|
||||
set: (_, __, ___) => undefined,
|
||||
delete: (_) => undefined,
|
||||
clear: () => Promise.resolve(),
|
||||
on: (_, __) => undefined
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
import { Logger } from "@foxxmd/logging";
|
||||
|
||||
|
||||
export class MaybeLogger {
|
||||
logger?: Logger;
|
||||
|
||||
constructor(logger?: Logger, label?: string) {
|
||||
if (logger !== undefined && label !== undefined) {
|
||||
this.logger = logger;//this.logger = childLogger(logger, label);
|
||||
} else {
|
||||
this.logger = logger;
|
||||
}
|
||||
}
|
||||
|
||||
public info(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.info(first, ...rest);
|
||||
}
|
||||
}
|
||||
|
||||
public debug(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.debug(first, ...rest);
|
||||
}
|
||||
}
|
||||
|
||||
public trace(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.trace(first, ...rest);
|
||||
}
|
||||
}
|
||||
|
||||
public warn(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.warn(first, ...rest);
|
||||
}
|
||||
}
|
||||
|
||||
public verbose(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.verbose(first, ...rest);
|
||||
}
|
||||
}
|
||||
|
||||
public error(first: any, ...rest: any) {
|
||||
if (this.logger) {
|
||||
this.logger.error(first, ...rest);
|
||||
}
|
||||
}
|
||||
}
|
||||
const noopLog = (_: any, ...rest: any) => undefined;
|
||||
|
||||
export const loggerNoop: Logger = {
|
||||
trace: noopLog,
|
||||
debug: noopLog,
|
||||
log: noopLog,
|
||||
info: noopLog,
|
||||
verbose: noopLog,
|
||||
warn: noopLog,
|
||||
error: noopLog,
|
||||
fatal: noopLog,
|
||||
silent: noopLog,
|
||||
level: 'silent',
|
||||
child: (_: any, ...rest: any) => loggerNoop as Logger
|
||||
} as unknown as Logger;
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ export class UpstreamError extends Error {
|
||||
|
||||
constructor(message: string, options?: UpstreamErrorOptions | undefined) {
|
||||
super(message, options);
|
||||
const {showStopper = false, response, responseBody} = options;
|
||||
const {showStopper = false, response, responseBody} = options ?? {};
|
||||
this.showStopper = showStopper;
|
||||
this.response = response;
|
||||
this.responseBody = responseBody;
|
||||
|
||||
@@ -1,140 +1,18 @@
|
||||
import { Logger } from '@foxxmd/logging';
|
||||
import { Dayjs } from "dayjs";
|
||||
import { Dayjs, ManipulateType } from "dayjs";
|
||||
import { Request, Response } from "express";
|
||||
import { NextFunction, ParamsDictionary, Query } from "express-serve-static-core";
|
||||
import { FixedSizeList } from 'fixed-size-list';
|
||||
import { isPlayObject, PlayMeta, PlayObject, PlayObjectLifecycleless } from "../../../core/Atomic.js";
|
||||
import { isPlayObject, PlayMetaLifecycleless, PlayObject, PlayObjectLifecycleless, UnixTimestamp } from "../../../core/Atomic.js";
|
||||
import TupleMap from "../TupleMap.js";
|
||||
import { MusicBrainzApi } from 'musicbrainz-api';
|
||||
|
||||
export type SourceType =
|
||||
'spotify'
|
||||
| 'plex'
|
||||
| 'subsonic'
|
||||
| 'jellyfin'
|
||||
| 'lastfm'
|
||||
| 'librefm'
|
||||
| 'deezer'
|
||||
| 'endpointlz'
|
||||
| 'endpointlfm'
|
||||
| 'ytmusic'
|
||||
| 'mpris'
|
||||
| 'mopidy'
|
||||
| 'musiccast'
|
||||
| 'listenbrainz'
|
||||
| 'jriver'
|
||||
| 'kodi'
|
||||
| 'webscrobbler'
|
||||
| 'chromecast'
|
||||
| 'maloja'
|
||||
| 'musikcube'
|
||||
| 'mpd'
|
||||
| 'vlc'
|
||||
| 'icecast'
|
||||
| 'azuracast'
|
||||
| 'koito'
|
||||
| 'tealfm'
|
||||
| 'rocksky'
|
||||
| 'sonos';
|
||||
|
||||
export const sourceTypes: SourceType[] = [
|
||||
'spotify',
|
||||
'plex',
|
||||
'subsonic',
|
||||
'jellyfin',
|
||||
'lastfm',
|
||||
'librefm',
|
||||
'deezer',
|
||||
'endpointlz',
|
||||
'endpointlfm',
|
||||
'ytmusic',
|
||||
'mpris',
|
||||
'mopidy',
|
||||
'musiccast',
|
||||
'listenbrainz',
|
||||
'jriver',
|
||||
'kodi',
|
||||
'webscrobbler',
|
||||
'chromecast',
|
||||
'maloja',
|
||||
'musikcube',
|
||||
'mpd',
|
||||
'vlc',
|
||||
'icecast',
|
||||
'azuracast',
|
||||
'koito',
|
||||
'tealfm',
|
||||
'rocksky',
|
||||
'sonos'
|
||||
];
|
||||
|
||||
export const sourceInterfaces = [
|
||||
'AIOSourceRelaxedConfig',
|
||||
'SpotifySourceConfig',
|
||||
'PlexCompatConfig',
|
||||
'DeezerCompatConfig',
|
||||
'ListenbrainzEndpointSourceConfig',
|
||||
'LastFMEndpointSourceConfig',
|
||||
'IcecastSourceConfig',
|
||||
'SubSonicSourceConfig',
|
||||
'JellyfinCompatConfig',
|
||||
'LastfmSourceConfig',
|
||||
'LibrefmSourceConfig',
|
||||
'YTMusicSourceConfig',
|
||||
'MalojaSourceConfig',
|
||||
'MPRISSourceConfig',
|
||||
'MopidySourceConfig',
|
||||
'ListenBrainzSourceConfig',
|
||||
'JRiverSourceConfig',
|
||||
'KodiSourceConfig',
|
||||
'ChromecastSourceConfig',
|
||||
'WebScrobblerSourceConfig',
|
||||
'MusikcubeSourceConfig',
|
||||
'MusicCastSourceConfig',
|
||||
'MPDSourceConfig',
|
||||
'VLCSourceConfig',
|
||||
'AzuracastSourceConfig',
|
||||
'KoitoSourceConfig',
|
||||
'TealSourceConfig',
|
||||
'RockskySourceConfig',
|
||||
'SonosSourceConfig'
|
||||
]
|
||||
|
||||
export const isSourceType = (data: string): data is SourceType => {
|
||||
return sourceTypes.includes(data as SourceType);
|
||||
}
|
||||
import { SourceType } from './config/source/sources.js';
|
||||
import { ClientType, clientTypes } from './config/client/clients.js';
|
||||
import assert, { AssertionError } from 'assert';
|
||||
import { SimpleError } from '../errors/MSErrors.js';
|
||||
|
||||
export const lowGranularitySources: SourceType[] = ['subsonic', 'ytmusic'];
|
||||
|
||||
export type ClientType =
|
||||
'maloja'
|
||||
| 'lastfm'
|
||||
| 'librefm'
|
||||
| 'listenbrainz'
|
||||
| 'koito'
|
||||
| 'tealfm'
|
||||
| 'rocksky';
|
||||
export const clientTypes: ClientType[] = [
|
||||
'maloja',
|
||||
'lastfm',
|
||||
'librefm',
|
||||
'listenbrainz',
|
||||
'koito',
|
||||
'tealfm',
|
||||
'rocksky'
|
||||
];
|
||||
|
||||
export const clientInterfaces = [
|
||||
'AIOClientRelaxedConfig',
|
||||
'MalojaClientConfig',
|
||||
'LastfmClientConfig',
|
||||
'LibrefmClientConfig',
|
||||
'ListenBrainzClientConfig',
|
||||
'KoitoClientConfig',
|
||||
'TealClientConfig',
|
||||
'RockSkyClientConfig'
|
||||
];
|
||||
|
||||
export const isClientType = (data: string): data is ClientType => {
|
||||
return clientTypes.includes(data as ClientType);
|
||||
}
|
||||
@@ -222,14 +100,15 @@ export interface FormatPlayObjectOptions {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export interface ProgressAwarePlayObject extends PlayObject {
|
||||
meta: PlayMeta & {
|
||||
export interface ProgressAwarePlayObject extends PlayObjectLifecycleless {
|
||||
meta: PlayMetaLifecycleless & {
|
||||
initialTrackProgressPosition?: number
|
||||
}
|
||||
}
|
||||
export type DeviceId = string;
|
||||
export type PlayUserId = string;
|
||||
export type PlayPlatformId = [DeviceId, PlayUserId];
|
||||
export type PlayPlatformIdStr = string;
|
||||
|
||||
export type GroupedPlays = TupleMap<DeviceId,PlayUserId,ProgressAwarePlayObject[]>;
|
||||
|
||||
@@ -239,6 +118,7 @@ export const NO_DEVICE = 'NoDevice';
|
||||
export const NO_USER = 'SingleUser';
|
||||
|
||||
export const SINGLE_USER_PLATFORM_ID: PlayPlatformId = [NO_DEVICE, NO_USER];
|
||||
export const SINGLE_USER_PLATFORM_ID_STR = `${NO_DEVICE}-${NO_USER}`;
|
||||
|
||||
export interface ScrobbledPlayObject {
|
||||
play: PlayObject
|
||||
@@ -305,18 +185,6 @@ export type ExpressRequest = Request<ParamsDictionary, any, any, Query, Record<s
|
||||
export type ExpressResponse = Response<any, Record<string, any>>;
|
||||
export type ExpressHandler = (req: ExpressRequest, res: ExpressResponse, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>
|
||||
|
||||
export interface numberFormatOptions {
|
||||
toFixed: number,
|
||||
defaultVal?: any,
|
||||
prefix?: string,
|
||||
suffix?: string,
|
||||
round?: {
|
||||
type?: string,
|
||||
enable: boolean,
|
||||
indicate?: boolean,
|
||||
}
|
||||
}
|
||||
|
||||
export const DELIMITERS = [',','&','/','\\'];
|
||||
export const DELIMITERS_NO_AMP = [',','/','\\'];
|
||||
export const DELIMETERS_REGEX: RegExp = new RegExp(/[,&\/\\]/);
|
||||
@@ -341,6 +209,10 @@ export interface Authenticatable {
|
||||
testAuth: () => Promise<any>
|
||||
}
|
||||
|
||||
export interface ScrobbleRangeFetchable {
|
||||
getScrobblesForTimeRange: TimeRangeListensFetcher
|
||||
}
|
||||
|
||||
export interface MdnsDeviceInfo {
|
||||
name: string
|
||||
type: string
|
||||
@@ -360,21 +232,52 @@ export interface CacheConfig<T extends CacheProvider = CacheProvider> {
|
||||
connection?: string;
|
||||
[key: string]: any
|
||||
}
|
||||
export interface CacheMemoryConfig extends CacheConfig<'memory'> {
|
||||
lruSize?: number
|
||||
ttl?: number
|
||||
}
|
||||
export interface CacheValkeyConfig extends CacheConfig<'valkey'> {
|
||||
}
|
||||
export interface CacheFileConfig extends CacheConfig<'file'> {
|
||||
}
|
||||
export interface CacheNoopConfig extends CacheConfig<false> {
|
||||
}
|
||||
|
||||
export type CacheConfigType = CacheMemoryConfig | CacheValkeyConfig | CacheFileConfig | CacheNoopConfig;
|
||||
|
||||
export type CacheMetadataProvider = CacheProvider;//Exclude<CacheProvider, 'file'>;
|
||||
export type CacheMetadataConfig = CacheConfig<CacheMetadataProvider>;
|
||||
export type CacheMetadataConfig = CacheConfigType;
|
||||
export const asCacheProvider = (val: boolean | string): val is CacheProvider => {
|
||||
if(typeof val === 'string') {
|
||||
return ['memory', 'valkey', 'file'].includes(val);
|
||||
}
|
||||
return val === false;
|
||||
}
|
||||
export const asCacheEphemeralConfig = (val: Record<string, any>): val is (CacheMemoryConfig | CacheNoopConfig) => {
|
||||
return val.provider === false || val.provider === 'memory';
|
||||
}
|
||||
export const asCacheConnectableConfig = (val: Record<string, any>): val is (CacheValkeyConfig | CacheFileConfig) => {
|
||||
if(!['valkey', 'file'].includes(val.provider)) {
|
||||
return false;
|
||||
}
|
||||
return typeof val.connection === 'string';
|
||||
}
|
||||
export const asCacheConfig = (val: Record<string, any>): val is CacheConfigType => {
|
||||
if(!asCacheProvider(val.provider)) {
|
||||
assert(asCacheProvider(val.provider), `Cache provider must be one of: 'memory', 'valkey', 'file', or false`);
|
||||
}
|
||||
if(asCacheConnectableConfig(val) || asCacheEphemeralConfig(val)) {
|
||||
return true;
|
||||
}
|
||||
throw new SimpleError(`${val.provider} must have a connection property that is a string`);
|
||||
}
|
||||
export const asCacheMetadataProvider = (val: any): val is CacheScrobbleProvider => asCacheProvider(val);
|
||||
export type CacheScrobbleProvider = CacheProvider;
|
||||
export type CacheScrobbleConfig = CacheConfig<CacheScrobbleProvider>;
|
||||
export type CacheScrobbleConfig = CacheConfigType;
|
||||
export const asCacheScrobbleProvider = (val: any): val is CacheScrobbleProvider => asCacheProvider(val);
|
||||
|
||||
export type CacheAuthProvider = CacheProvider;
|
||||
export type CacheAuthConfig = CacheConfig<CacheAuthProvider>;
|
||||
export type CacheAuthConfig = CacheConfigType;
|
||||
export const asCacheAuthProvider = (val: any): val is CacheAuthProvider => asCacheProvider(val);
|
||||
export interface CacheConfigOptions {
|
||||
metadata?: CacheMetadataConfig;
|
||||
@@ -391,7 +294,6 @@ export interface MusicbrainzApiConfigData {
|
||||
url?: string
|
||||
rateLimit?: [number, number]
|
||||
contact: string,
|
||||
ttl?: string
|
||||
apiKey?: string
|
||||
requestTimeout?: number
|
||||
}
|
||||
@@ -399,4 +301,109 @@ export interface MusicbrainzApiConfigData {
|
||||
export const MUSICBRAINZ_URL = 'https://musicbrainz.org';
|
||||
export const MBID_VARIOUS_ARTISTS = "89ad4ac3-39f7-470e-963a-56509c546377";
|
||||
|
||||
export type MusicBrainzSingletonMap = Map<string,MusicBrainzApi>;
|
||||
export type MusicBrainzSingletonMap = Map<string,MusicBrainzApi>;
|
||||
|
||||
|
||||
|
||||
/* https://websocket.org/reference/close-codes/ */
|
||||
export const WEBSOCKET_CLOSE_CODE_REASONS = {
|
||||
1000: 'Closed gracefully',
|
||||
1001: 'Going Away',
|
||||
1002: 'Protocol Error',
|
||||
1003: 'Unsupported Data',
|
||||
1005: 'No Status Received',
|
||||
1006: 'Abnormal Closure (Connection lost unexpectedly)',
|
||||
1008: 'Policy Violation',
|
||||
1009: 'Message Too Big',
|
||||
1011: 'Server-side exception',
|
||||
1012: 'Service Restart',
|
||||
1013: 'Try Again Later',
|
||||
1014: 'Bad Gateway',
|
||||
1015: 'TLD handshake fail'
|
||||
}
|
||||
|
||||
export const WEBSOCKET_CLOSE_CODE = {
|
||||
AbnormalClosure: 1006,
|
||||
InternalError: 1011
|
||||
}
|
||||
|
||||
export const WEBSOCKET_CLOSE_CODES_RETRY = [1006,1011,1001];export interface PaginatedLimit {
|
||||
/** per page max number of results to return */
|
||||
limit?: number
|
||||
}
|
||||
|
||||
export interface PaginatedTimeRangeOptions {
|
||||
/** Unix timestamp */
|
||||
from: UnixTimestamp
|
||||
/** Unix timestamp */
|
||||
to: UnixTimestamp
|
||||
/** maximum number of results to fetch before returning early */
|
||||
fetchMax?: number
|
||||
}
|
||||
|
||||
export type PaginatedTimeRangeCommonOptions = Partial<PaginatedTimeRangeOptions> & PaginatedLimit;
|
||||
|
||||
export type CursorType = number | string;
|
||||
|
||||
export interface PaginatedListensOptions<T extends CursorType> extends PaginatedLimit {
|
||||
cursor: T
|
||||
}
|
||||
|
||||
export interface PagelessListensTimeRangeOptions extends PaginatedTimeRangeCommonOptions {
|
||||
}
|
||||
|
||||
export interface PaginatedListensTimeRangeOptions<T extends CursorType = CursorType> extends Partial<PaginatedTimeRangeOptions>, PaginatedListensOptions<T> {
|
||||
}
|
||||
|
||||
export interface PaginatedResults<T extends CursorType = CursorType> {
|
||||
total?: number
|
||||
more?: boolean
|
||||
cursorNext?: T
|
||||
order?: 'desc' | 'asc'
|
||||
}
|
||||
|
||||
export interface PaginatedListens {
|
||||
getPaginatedListens(params: PaginatedListensOptions<CursorType>): Promise<{data: PlayObject[], meta: PaginatedListensOptions<CursorType> & PaginatedResults<CursorType>}>
|
||||
}
|
||||
|
||||
export const hasPaginagedListens = (obj: Object): obj is PaginatedListens => {
|
||||
return 'getPaginatedListens' in obj;
|
||||
}
|
||||
|
||||
export interface PaginatedTimeRangeListensResult<T extends CursorType> {
|
||||
data: PlayObject[];
|
||||
meta: PaginatedListensTimeRangeOptions<T> & PaginatedResults<T>;
|
||||
}
|
||||
export interface PaginatedTimeRangeListens<T extends CursorType = CursorType> {
|
||||
getPaginatedTimeRangeListens(params: PaginatedListensTimeRangeOptions<T>): Promise<PaginatedTimeRangeListensResult<T>>
|
||||
getPaginatedUnitOfTime(): ManipulateType;
|
||||
}
|
||||
|
||||
export const hasPaginatedTimeRangeListens = (obj: Object): obj is PaginatedTimeRangeListens => {
|
||||
return 'getPaginatedTimeRangeListens' in obj;
|
||||
}
|
||||
|
||||
export interface PagelessTimeRangeListensResult {
|
||||
data: PlayObject[]
|
||||
meta: PagelessListensTimeRangeOptions & PaginatedResults
|
||||
}
|
||||
export interface PagelessTimeRangeListens {
|
||||
getPagelessTimeRangeListens(params: PagelessListensTimeRangeOptions): Promise<PagelessTimeRangeListensResult>
|
||||
getPaginatedUnitOfTime(): ManipulateType;
|
||||
}
|
||||
|
||||
export const hasPagelessTimeRangeListens = (obj: Object): obj is PagelessTimeRangeListens => {
|
||||
return 'getPagelessTimeRangeListens' in obj;
|
||||
}
|
||||
|
||||
export type PaginatedTimeRangeSource = PaginatedTimeRangeListens | PagelessTimeRangeListens;
|
||||
export type PaginatedSource = PaginatedListens | PaginatedTimeRangeSource;
|
||||
|
||||
export type TimeRangeListensFetcher<T extends CursorType = CursorType> = (opts: PaginatedTimeRangeCommonOptions | PaginatedListensTimeRangeOptions<T>) => Promise<PlayObject[]>
|
||||
|
||||
export interface ScrobbleRangeResult {
|
||||
plays: PlayObject[]
|
||||
fetchedAt: Dayjs
|
||||
}
|
||||
|
||||
export const REFRESH_STALE_DEFAULT = 60;
|
||||
@@ -50,6 +50,10 @@ export interface Whennable {
|
||||
}
|
||||
|
||||
export type FlowControlTerm = 'continue' | 'stop'
|
||||
export const FLOW_CONTROL_TERM = {
|
||||
continue: 'continue',
|
||||
stop: 'stop'
|
||||
} as const satisfies Record<string, FlowControlTerm>;
|
||||
|
||||
export interface FlowControl {
|
||||
onSuccess: FlowControlTerm
|
||||
|
||||
@@ -5,7 +5,7 @@ import { RequestRetryOptions } from "./common.js";
|
||||
import { WebhookConfig } from "./health/webhooks.js";
|
||||
import { CommonSourceOptions, SourceRetryOptions } from "./source/index.js";
|
||||
import { SourceAIOConfig } from "./source/sources.js";
|
||||
import { CacheConfigOptions, ClientType, SourceType } from "../Atomic.js";
|
||||
import { CacheConfigOptions } from "../Atomic.js";
|
||||
import { TransformerCommonConfig } from "../../../../core/Atomic.js";
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,75 @@ import { MalojaClientAIOConfig, MalojaClientConfig } from "./maloja.js";
|
||||
import { TealClientAIOConfig, TealClientConfig } from "./tealfm.js";
|
||||
import { RockSkyClientAIOConfig, RockSkyClientConfig } from "./rocksky.js";
|
||||
import { LibrefmClientConfig, LibrefmClientAIOConfig } from "./librefm.js";
|
||||
import { DiscordClientAIOConfig, DiscordClientConfig } from "./discord.js";
|
||||
|
||||
export type ClientConfig = MalojaClientConfig | LastfmClientConfig | LibrefmClientConfig | ListenBrainzClientConfig | KoitoClientConfig | TealClientConfig | RockSkyClientConfig;
|
||||
export type ClientConfig =
|
||||
MalojaClientConfig
|
||||
| LastfmClientConfig
|
||||
| LibrefmClientConfig
|
||||
| ListenBrainzClientConfig
|
||||
| KoitoClientConfig
|
||||
| TealClientConfig
|
||||
| RockSkyClientConfig
|
||||
| DiscordClientConfig;
|
||||
|
||||
export type ClientAIOConfig = MalojaClientAIOConfig | LastfmClientAIOConfig | LibrefmClientAIOConfig | ListenBrainzClientAIOConfig | KoitoClientAIOConfig | TealClientAIOConfig | RockSkyClientAIOConfig;
|
||||
export type ClientAIOConfig = MalojaClientAIOConfig
|
||||
| LastfmClientAIOConfig
|
||||
| LibrefmClientAIOConfig
|
||||
| ListenBrainzClientAIOConfig
|
||||
| KoitoClientAIOConfig
|
||||
| TealClientAIOConfig
|
||||
| RockSkyClientAIOConfig
|
||||
| DiscordClientAIOConfig;
|
||||
|
||||
/** Used for docusaurus schemas
|
||||
* We need to show "array of" for each type of config when looking at File Config
|
||||
*
|
||||
* This is defined in the AIO config and we *assume* arrays in individual files when parsing in builders
|
||||
* But we don't have any actual definitions for this that we can pull for generating individual schema files
|
||||
*/
|
||||
export type MalojaClientConfigs = MalojaClientConfig[];
|
||||
export type LastfmClientConfigs = LastfmClientConfig[];
|
||||
export type LibrefmClientConfigs = LibrefmClientConfig[];
|
||||
export type ListenBrainzClientConfigs = ListenBrainzClientConfig[];
|
||||
export type KoitoClientConfigs = KoitoClientConfig[];
|
||||
export type TealClientConfigs = TealClientConfig[];
|
||||
export type RockSkyClientConfigs = RockSkyClientConfig[];
|
||||
export type DiscordClientConfigs = DiscordClientConfig[];
|
||||
|
||||
export const atomicClientInterfaces = [
|
||||
'MalojaClientConfig',
|
||||
'LastfmClientConfig',
|
||||
'LibrefmClientConfig',
|
||||
'ListenBrainzClientConfig',
|
||||
'KoitoClientConfig',
|
||||
'TealClientConfig',
|
||||
'RockSkyClientConfig',
|
||||
'DiscordClientConfig'
|
||||
];
|
||||
|
||||
export const clientInterfaces = [
|
||||
'AIOClientRelaxedConfig',
|
||||
...atomicClientInterfaces
|
||||
];
|
||||
|
||||
export type ClientType =
|
||||
'maloja'
|
||||
| 'lastfm'
|
||||
| 'librefm'
|
||||
| 'listenbrainz'
|
||||
| 'koito'
|
||||
| 'tealfm'
|
||||
| 'rocksky'
|
||||
| 'discord';
|
||||
|
||||
export const clientTypes: ClientType[] = [
|
||||
'maloja',
|
||||
'lastfm',
|
||||
'librefm',
|
||||
'listenbrainz',
|
||||
'koito',
|
||||
'tealfm',
|
||||
'rocksky',
|
||||
'discord'
|
||||
];
|
||||
@@ -0,0 +1,125 @@
|
||||
import { ActivityType, StatusDisplayType } from "discord.js"
|
||||
import { CommonClientConfig, CommonClientData } from "./index.js"
|
||||
|
||||
export interface DiscordData {
|
||||
token?: string
|
||||
applicationId?: string
|
||||
artwork?: boolean | string | string[]
|
||||
artworkDefaultUrl?: string
|
||||
statusOverrideAllow?: string | StatusType[]
|
||||
listeningActivityAllow?: string | string[]
|
||||
ipcLocations?: string | (string | [number, string])[]
|
||||
}
|
||||
|
||||
export interface DiscordClientData extends DiscordData, CommonClientData {}
|
||||
|
||||
export interface DiscordClientConfig extends CommonClientConfig {
|
||||
/**
|
||||
* Should always be `client` when using Koito as a client
|
||||
*
|
||||
* @default client
|
||||
* @examples ["client"]
|
||||
* */
|
||||
configureAs?: 'client' | 'source'
|
||||
data: DiscordClientData
|
||||
}
|
||||
|
||||
export interface DiscordClientAIOConfig extends DiscordClientConfig {
|
||||
type: 'discord'
|
||||
}
|
||||
|
||||
export type ActivityTypeString = 'playing' | 'streaming' | 'listening' | 'watching' | 'custom' | 'competing' | 'hanging';
|
||||
export const ActivityTypes: ActivityTypeString[] = ['playing','streaming','listening','watching','custom','competing', 'hanging'];
|
||||
export type StatusType = 'online' | 'idle' | 'dnd' | 'invisible';
|
||||
|
||||
export interface DiscordStrongData extends DiscordData {
|
||||
artwork?: boolean | string[]
|
||||
statusOverrideAllow?: StatusType[]
|
||||
listeningActivityAllow?: string[]
|
||||
ipcLocations?: (string | [number, string])[]
|
||||
}
|
||||
|
||||
export interface DiscordWSData extends DiscordStrongData {
|
||||
token: string
|
||||
}
|
||||
|
||||
export interface DiscordIPCData extends DiscordStrongData {
|
||||
applicationId: string
|
||||
//ipcLocations: (string | [number, string])[]
|
||||
}
|
||||
|
||||
export interface ActivityAssets {
|
||||
largeImage?: string
|
||||
largeText?: string
|
||||
largeUrl?: string
|
||||
smallImage?: string
|
||||
smallText?: string
|
||||
smallUrl?: string
|
||||
}
|
||||
|
||||
export interface ActivityTimestamps {
|
||||
start?: number
|
||||
end?: number
|
||||
}
|
||||
|
||||
export enum ActivityTypeOthers {
|
||||
Hanging = 6
|
||||
}
|
||||
|
||||
export declare enum ActivityTypeReal {
|
||||
/**
|
||||
* Playing \{game\}
|
||||
*/
|
||||
Playing = 0,
|
||||
/**
|
||||
* Streaming \{details\}
|
||||
*/
|
||||
Streaming = 1,
|
||||
/**
|
||||
* Listening to \{name\}
|
||||
*/
|
||||
Listening = 2,
|
||||
/**
|
||||
* Watching \{details\}
|
||||
*/
|
||||
Watching = 3,
|
||||
/**
|
||||
* \{emoji\} \{state\}
|
||||
*/
|
||||
Custom = 4,
|
||||
/**
|
||||
* Competing in \{name\}
|
||||
*/
|
||||
Competing = 5,
|
||||
|
||||
Hanging = 6
|
||||
}
|
||||
|
||||
export interface ActivityData {
|
||||
name: string
|
||||
details?: string
|
||||
detailsUrl?: string
|
||||
state?: string
|
||||
stateUrl?: string
|
||||
|
||||
activityType?: ActivityType
|
||||
statusDisplayType?: StatusDisplayType
|
||||
|
||||
assets?: ActivityAssets
|
||||
timestamps?: ActivityTimestamps
|
||||
|
||||
createdAt: number
|
||||
}
|
||||
|
||||
export const ACTIVITY_TYPE = {
|
||||
Playing: 0,
|
||||
Streaming: 1,
|
||||
Listening: 2,
|
||||
Watching: 3,
|
||||
Custom: 4,
|
||||
Competing: 5,
|
||||
Hanging: 6
|
||||
} as const satisfies Record<string, ActivityTypeReal>
|
||||
|
||||
export const ARTWORK_PLACEHOLDER = 'https://raw.githubusercontent.com/FoxxMD/multi-scrobbler/master/assets/default-artwork.png';
|
||||
export const MS_ART = 'https://raw.githubusercontent.com/FoxxMD/multi-scrobbler/master/assets/icon.png';
|
||||