Merge branch 'refs/heads/develop'

# Conflicts:
#	docsite/docs/configuration/configuration.md

.dockerignore

@@ -15,7 +15,7 @@ config/*.p8
 /docs
 /logs
 .flatpak-builder
-flatpak/generated-sources.json
+**/generated-sources.*
 flatpak/.flatpak-builder
 docsite/build
 docsite/node_modules

.github/workflows/docsDeploy.yml

@@ -27,6 +27,7 @@ jobs:
         env:
           ANALYTICS: ${{ vars.ANALYTICS }}
           ANALYTICS_DOMAIN: ${{ vars.ANALYTICS_DOMAIN }}
+          DOCS_BASE: '/multi-scrobbler'
         run: npm run build
         working-directory: ./docsite
 

.github/workflows/publishImage.yml

@@ -10,9 +10,8 @@ on:
       - '*.*.*'
     # don't trigger if just updating docs
     paths-ignore:
-      - '**.md'
+      - 'README.md'
       - '.github/**'
-      - 'docsite/**'
       - 'flatpak/**'
   # use release instead of tags once version is correctly parsed
   # https://github.com/docker/metadata-action/issues/422

.gitignore

@@ -132,3 +132,4 @@ flatpak/generated-sources.json
 
 build
 !setupProxy.js
+**/generated-sources.*

Dockerfile

@@ -84,14 +84,15 @@ 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
+RUN npm run docs:install && npm run build && rm -rf node_modules && rm -rf docsite/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=build --chown=abc:abc /app/docsite /app/docsite
 COPY --from=base /usr/bin /usr/bin
 COPY --from=base /usr/lib /usr/lib
 

README.md

@@ -3,39 +3,45 @@
 [![Latest Release](https://img.shields.io/github/v/release/foxxmd/multi-scrobbler)](https://github.com/FoxxMD/multi-scrobbler/releases)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)](https://hub.docker.com/r/foxxmd/multi-scrobbler)
+[![Docs](https://img.shields.io/badge/Read%20The%20Docs-1082c2)](https://foxxmd.github.io/multi-scrobbler/)
+
 
 <img src="/assets/icon.png" align="right"
 alt="multi-scrobbler logo" width="180" height="180">
 
 A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), and [ListenBrainz](https://listenbrainz.org)
 
 * Supports scrobbling from many **Sources**
-  * [Spotify](/docsite/docs/configuration/configuration.md#spotify)
-  * [Plex](/docsite/docs/configuration/configuration.md#plex) or [Tautulli](/docsite/docs/configuration/configuration.md#tautulli)
-  * [Subsonic-compatible APIs](/docsite/docs/configuration/configuration.md#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
-  * [Jellyfin](/docsite/docs/configuration/configuration.md#jellyfin)
-  * [WebScrobbler](/docsite/docs/configuration/configuration.md#webscrobbler)
-  * [Youtube Music](/docsite/docs/configuration/configuration.md#youtube-music)
-  * [Last.fm](/docsite/docs/configuration/configuration.md#lastfm-source)
-  * [ListenBrainz](/docsite/docs/configuration/configuration.md#listenbrainz--source-)
-  * [Deezer](/docsite/docs/configuration/configuration.md#deezer)
-  * [MPRIS (Linux Desktop)](/docsite/docs/configuration/configuration.md#mpris)
-  * [Mopidy](/docsite/docs/configuration/configuration.md#mopidy)
-  * [JRiver](/docsite/docs/configuration/configuration.md#jriver)
-  * [Kodi](/docsite/docs/configuration/configuration.md#kodi)
-  * [Google Cast (Chromecast)](/docsite/docs/configuration/configuration.md#google-cast--chromecast-)
-  * [Musikcube](/docsite/docs/configuration/configuration.md#muikcube)
+  * [Spotify](https://foxxmd.github.io/multi-scrobbler/docs/configuration#spotify)
+  * [Plex](https://foxxmd.github.io/multi-scrobbler/docs/configuration#plex) or [Tautulli](https://foxxmd.github.io/multi-scrobbler/docs/configuration#tautulli)
+  * [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/docs/configuration#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+  * [Jellyfin](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jellyfin)
+  * [WebScrobbler](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webscrobbler)
+  * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/docs/configuration#youtube-music)
+  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source)
+  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source)
+  * [Deezer](https://foxxmd.github.io/multi-scrobbler/docs/configuration#deezer)
+  * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris)
+  * [Mopidy](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mopidy)
+  * [JRiver](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jriver)
+  * [Kodi](https://foxxmd.github.io/multi-scrobbler/docs/configuration#kodi)
+  * [Google Cast (Chromecast)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#google-cast-chromecast)
+  * [Musikcube](https://foxxmd.github.io/multi-scrobbler/docs/configuration#muikcube)
 * Supports scrobbling to many **Clients**
-  * [Maloja](/docsite/docs/configuration/configuration.md#maloja)
-  * [Last.fm](/docsite/docs/configuration/configuration.md#lastfm)
-  * [ListenBrainz](/docsite/docs/configuration/configuration.md#listenbrainz)
-* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](/docsite/docs/configuration/configuration.md#webhook-configurations) or [healthcheck endpoint](/docsite/docs/configuration/configuration.md#health-endpoint)
+  * [Maloja](https://foxxmd.github.io/multi-scrobbler/docs/configuration#maloja)
+  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm)
+  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz)
+* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webhook-configurations) or [healthcheck endpoint](https://foxxmd.github.io/multi-scrobbler/docs/configuration#health-endpoint)
 * Supports configuring for single or multiple users (scrobbling for your friends and family!)
 * Web server interface for stats, basic control, and detailed logs
 * Graceful network and client failure handling (queued scrobbles that auto-retry)
 * Smart handling of credentials (persistent, authorization through app)
 * Easy configuration through ENVs or JSON
-* Install using [Docker images for x86/ARM](/docsite/docs/installation/installation.md#docker), [flatpak](/docsite/docs/installation/installation.md#flatpak), or [locally with NodeJS](/docsite/docs/installation/installation.md#nodejs)
+* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker#docker), [flatpak](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker#flatpak), or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker#nodejs)
+
+[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+
+<img src="/assets/status-ui.png" width="800">
 
 **Why should I use this over a browser extension and/or mobile app scrobbler?**
 
@@ -46,9 +52,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
 
 **But I already scrobble my music to Last.fm/ListenBrainz, is multi-scrobbler for me?**
 
-Yes! You can use [Last.fm as a **Source**](/docsite/docs/configuration/configuration.md#lastfm--source-) or [Listenbrainz as a **Source**](/docsite/docs/configuration/configuration.md#listenbrainz--source-) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location.
-
-<img src="/assets/status-ui.png" width="800">
+Yes! You can use [Last.fm as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source) or [Listenbrainz as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location.
 
 ## How Does multi-scrobbler (MS) Work?
 
@@ -73,13 +77,17 @@ Client configurations consist of:
 * A friendly name.
 * Any data needed to communicate or authenticate with the Client.
 
+## Quick Start
+
+[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+
 ## Installation
 
-[See the **Installation** documentation](/docsite/docs/installation/installation.md)
+[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/docs/installation)
 
 ## Configuration
 
-[See the **Configuration** documentation](/docsite/docs/configuration/configuration.md)
+[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration)
 
 ## Usage
 
@@ -94,11 +102,11 @@ On first startup you may need to authorize Spotify and/or Last.fm by visiting th
 
 ## Help/FAQ
 
-Having issues with connections or configuration? Check the [FAQ](/docsite/docs/FAQ.md) before creating an issue!
+Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ) before creating an issue!
 
 ## Development
 
-[Detailed architecture and development guides for Sources/Clients](/docsite/docs/development/dev-common.md)
+[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/docs/development/dev-common)
 
 ## License
 

alpine.Dockerfile

@@ -40,7 +40,7 @@ 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
+RUN npm run docs:install && npm run build && rm -rf node_modules && rm -rf docsite/node_modules
 
 FROM base as app
 
@@ -49,6 +49,7 @@ 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=build --chown=abc:abc /app/docsite /app/docsite
 COPY --from=base /usr/local/bin /usr/local/bin
 COPY --from=base /usr/local/lib /usr/local/lib