Merge branch 'develop'

.dockerignore

@@ -10,6 +10,7 @@ Dockerfile
 .idea
 config/*.json
 config/*.bak
+config/*.p8
 /docs
 /logs
 .flatpak-builder
@@ -20,3 +21,4 @@ docsite/node_modules
 docsite/.docusaurus
 docsite/.cache-loader
 build
+*.secrets

.github/workflows/docsDeploy.yml

@@ -12,10 +12,10 @@ jobs:
  name: Deploy to GitHub Pages
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-node@v3
+ - uses: actions/checkout@v4
+ - uses: actions/setup-node@v4
  with:
- node-version: 18
+ node-version: 20
  cache: npm
 
  - name: Install dependencies

.github/workflows/publishImage.yml

@@ -15,55 +15,69 @@ jobs:
  push_to_registry:
  name: Push Docker image to Docker Hub
  runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ include:
+ - dockerfile: ./Dockerfile
+ suffix: ''
+ platforms: 'linux/amd64,linux/arm64'
+ - dockerfile: ./debian.Dockerfile
+ suffix: '-debian'
+ # can't build arm64 due to a TLS issue when running npm install??
+ # https://github.com/FoxxMD/multi-scrobbler/issues/126
+ platforms: 'linux/amd64'
  # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
  permissions:
  packages: write
  contents: read
  steps:
  - name: Check out the repo
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Log in to Docker Hub
  if: github.event_name != 'pull_request'
- uses: docker/login-action@v2
+ uses: docker/login-action@v3
  with:
  username: ${{ secrets.DOCKER_USERNAME }}
  password: ${{ secrets.DOCKER_PASSWORD }}
 
  - name: Login to GitHub Container Registry
  if: github.event_name != 'pull_request'
- uses: docker/login-action@v2
+ uses: docker/login-action@v3
  with:
  registry: ghcr.io
  username: ${{ github.repository_owner }}
  password: ${{ secrets.GITHUB_TOKEN }}
 
  - name: Extract metadata (tags, labels) for Docker
  id: meta
- uses: docker/metadata-action@v3
+ uses: docker/metadata-action@v5
  with:
  images: |
  foxxmd/multi-scrobbler
  ghcr.io/foxxmd/multi-scrobbler
  # generate Docker tags based on the following events/attributes
+ # https://github.com/docker/metadata-action/issues/247#issuecomment-1511259674 for NOT is default branch, eventually
  tags: |
- type=raw,value=latest,enable=${{ endsWith(github.ref, 'master') }}
- type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
- type=semver,pattern={{version}}
+ type=raw,value=latest,enable={{is_default_branch}},suffix=${{ matrix.suffix }}
+ type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }},suffix=${{ matrix.suffix }}
+ type=semver,pattern={{version}},suffix=${{ matrix.suffix }}
  flavor: |
  latest=false
 
  - name: Set up QEMU
- uses: docker/setup-qemu-action@v2
+ uses: docker/setup-qemu-action@v3
 
  - name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v2
+ uses: docker/setup-buildx-action@v3
 
  - name: Build and push Docker image
- uses: docker/build-push-action@v4
+ uses: docker/build-push-action@v5
  with:
  context: .
+ file: ${{ matrix.dockerfile }}
  push: ${{ github.event_name != 'pull_request' && !env.ACT}}
  tags: ${{ steps.meta.outputs.tags }}
  labels: ${{ steps.meta.outputs.labels }}
- platforms: linux/amd64,linux/arm64
+ platforms: ${{ matrix.platforms }}

.gitignore

@@ -125,8 +125,10 @@ src/**/**.js
 src/**/**.js.map
 
 *.bak
+*.p8
 .flatpak-builder
 flatpak/generated-sources.json
+*.secrets
 
 build
 !setupProxy.js

debian.Dockerfile

@@ -0,0 +1,116 @@
+#FROM ghcr.io/linuxserver/baseimage-ubuntu:jammy as base
+FROM ghcr.io/linuxserver/baseimage-debian:bookworm as base
+
+ENV TZ=Etc/GMT
+ENV NODE_VERSION 18.19.0
+
+# borrowing openssl header removal trick from offical docker-node
+# https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L8
+RUN \
+ ARCH= OPENSSL_ARCH= && dpkgArch="$(dpkg --print-architecture)" \
+ && case "${dpkgArch##*-}" in \
+ amd64) ARCH='x64' OPENSSL_ARCH='linux-x86_64';; \
+ ppc64el) ARCH='ppc64le' OPENSSL_ARCH='linux-ppc64le';; \
+ s390x) ARCH='s390x' OPENSSL_ARCH='linux*-s390x';; \
+ arm64) ARCH='arm64' OPENSSL_ARCH='linux-aarch64';; \
+ armhf) ARCH='armv7l' OPENSSL_ARCH='linux-armv4';; \
+ i386) ARCH='x86' OPENSSL_ARCH='linux-elf';; \
+ *) echo "unsupported architecture"; exit 1 ;; \
+ esac && \
+ set -ex && \
+ echo "**** install build packages ****" && \
+ apt-get update && \
+ apt-get install --no-install-recommends -y \
+ #ca-certificates \
+ xz-utils \
+ curl && \
+ echo "**** Fetch and install node****" && \
+ # get node/npm directly from nodejs dist \
+ # https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L41
+ curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH.tar.xz" && \
+ tar -xJf "node-v$NODE_VERSION-linux-$ARCH.tar.xz" -C /usr --strip-components=1 --no-same-owner && \
+ rm "node-v$NODE_VERSION-linux-$ARCH.tar.xz" && \
+ ln -s /usr/bin/node /usr/bin/nodejs && \
+# curl -sL https://deb.nodesource.com/setup_18.x | bash - && \
+# apt-get install --no-install-recommends -y nodejs && \
+ npm update -g npm && \
+ echo "**** cleanup ****" && \
+ # https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L49
+ # Remove unused OpenSSL headers to save ~34MB
+ # (does not affect arm64 issue below)
+ find /usr/include/node/openssl/archs -mindepth 1 -maxdepth 1 ! -name "$OPENSSL_ARCH" -exec rm -rf {} \; && \
+ apt-get purge --auto-remove -y perl xz-utils && \
+ apt-get autoclean && \
+ apt-get autoremove && \
+ rm -rf \
+ /config/.cache \
+ /root/cache \
+ /var/lib/apt/lists/* \
+ /var/tmp/* \
+ /tmp/*
+
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+
+ARG data_dir=/config
+VOLUME $data_dir
+ENV CONFIG_DIR=$data_dir
+
+COPY docker/root /
+
+RUN npm install -g \
+ patch-package \
+ && chown -R root:root /usr/lib/node_modules/patch-package
+
+WORKDIR /app
+
+FROM base as build
+
+COPY --chown=abc:abc package*.json tsconfig.json ./
+COPY --chown=abc:abc patches ./patches
+
+# for debugging, so the build fails faster when timing out (arm64)
+#RUN npm config set fetch-retries 1 && \
+# npm config set fetch-retry-mintimeout 5000 && \
+# npm config set fetch-retry-maxtimeout 5000
+
+# https://www.npmjs.com/package/tls-test
+# used to test that the OS supports downloading packages over HTTPS with TLS 1.2 enforced
+# -- this always succeeds but a good sanity check
+#RUN npm install -g https://tls-test.npmjs.com/tls-test-1.0.0.tgz
+
+# This FAILS when building arm64 but not amd64 (and alpine-based Dockerfile has no issues building arm64)
+# see https://github.com/FoxxMD/multi-scrobbler/issues/126
+RUN npm ci \
+ --verbose \
+# --no-audit \
+ && chown -R root:root node_modules
+# running with --no-audit does not have any affect even though the error only logs with prefix 'npm verb audit error'
+
+COPY --chown=abc:abc . /app
+
+# need to set before build so server/client build is optimized and has constants (if needed)
+ENV NODE_ENV=production
+
+RUN npm run build && rm -rf node_modules
+
+FROM base as app
+
+COPY --chown=abc:abc package*.json ./
+COPY --chown=abc:abc patches ./patches
+COPY --from=build --chown=abc:abc /app/dist /app/dist
+COPY --from=build --chown=abc:abc /app/src /app/src
+COPY --from=base /usr/bin /usr/bin
+COPY --from=base /usr/lib /usr/lib
+
+ENV NODE_ENV=production
+ENV IS_DOCKER=true
+
+RUN npm ci --omit=dev \
+ && npm cache clean --force \
+ && chown -R abc:abc node_modules \
+ && rm -rf node_modules/@types \
+ /root/.cache
+
+ARG webPort=9078
+ENV PORT=$webPort
+EXPOSE $PORT

docsite/docs/FAQ.md

@@ -4,6 +4,7 @@
  * [Jellyfin has warnings about undefined or missing data](#jellyfin-has-warnings-about-undefined-or-missing-data)
  * [Jellyfin has warnings about missing headers](#jellyfin-has-warnings-about-missing-headers)
  * [Spotify/Deezer/LastFM won't authenticate](#spotifydeezerlastfm-wont-authenticate)
+ * [Sporadic network problems on docker](#sporadic-network-problems-on-docker)
 * [Configuration Issues](#configuration-issues)
  * [Config could not be parsed](#config-could-not-be-parsed)
 * [Scrobbling Issues](#scrobbling-issues)
@@ -130,6 +131,16 @@ 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`
 
+## Sporadic network problems on docker
+
+If you encounter networking issues like:
+
+* sporadic timeouts (`ETIMEDOUT`) without a pattern
+* DNS errors (`EAI_AGAIN`) that do no occur consistently
+* Failures to reach a host that was previously fine (`EHOSTUNREACH`)
+
+there may be an issue with the underlying docker image OS (alpine) that may be solved by switching to a different image. Try switching to a `*-debian` variant tag (only available for ARM hosts) to see if this resolves your issue. IE `multi-scrobbler:latest-debian` or `multi-scrobbler:develop-debian`
+
 # Configuration Issues
 
 ## Config could not be parsed

docsite/docs/installation/installation.md

@@ -22,6 +22,25 @@ npm run build
 npm run start
 ```
 
+#### Rollup build error
+
+During building if you encounter an error like: `Your current platform "XXX" and architecture "XXX" combination is not yet supported by the native Rollup build.`
+
+Modify `overrides` in `package.json` to use `@rollup/wasm-node` as a drop-in replacement for rollup:
+
+```json
+"overrides": {
+ "spotify-web-api-node": {
+ "superagent": "$superagent"
+ }
+ "vite": {
+ "rollup": "npm:@rollup/wasm-node@^4.9.6"
+ }
+}
+```
+
+See [this issue](https://github.com/FoxxMD/multi-scrobbler/issues/135#issuecomment-1927080260) for more detail.
+
 ### Usage Examples
 
 * The web UI and API is served on port `9078`. This can be modified using the `PORT` environmental variable.
@@ -46,6 +65,11 @@ You must have [Flatpak](https://flatpak.org/) installed on your system.
 flatpak install flathub io.github.foxxmd.multiscrobbler
 ```
 
+**Note:** Flatpak users have experienced issues when using multi-scrobbler as a long-running process. Due to the relative difficulty in debugging issues with flatpak installations it is recommended:
+
+* to use a [Docker](#docker) installation if possible or
+* only if you need access to host-level resources like dbus for [MPRIS](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris) and cannot run a [nodejs](#nodejs) installation
+
 ### Usage Examples
 
 #### Using [file-based](../configuration/configuration.md#file-based-configuration) configuration
@@ -132,6 +156,16 @@ To get the UID and GID for the current user run these commands from a terminal:
 * `id -u` -- prints UID
 * `id -g` -- prints GID
 
+### Network Issues
+
+If you encounter networking issues like:
+
+* sporadic timeouts (`ETIMEDOUT`) without a pattern
+* DNS errors (`EAI_AGAIN`) that do no occur consistently
+* Failures to reach a host that was previously fine (`EHOSTUNREACH`)
+
+there may be an issue with the underlying docker image OS (alpine) that may be solved by switching to a different image. Try switching to a `*-debian` variant tag (only available for ARM hosts) to see if this resolves your issue. IE `multi-scrobbler:latest-debian` or `multi-scrobbler:develop-debian`
+
 ## Docker Usage Examples
 
 If installing on a different machine make sure all redirect URIs are defined or that you have set a [Base URL](#base-url).