Merge branch 'develop'

Author: FoxxMD

.dockerignore

@@ -12,3 +12,6 @@ config/*.json
 config/*.bak
 /docs
 /logs
+.flatpak-builder
+flatpak/generated-sources.json
+flatpak/.flatpak-builder

.gitignore

@@ -125,3 +125,5 @@ src/**/**.js
 src/**/**.js.map
 
 *.bak
+.flatpak-builder
+flatpak/generated-sources.json

README.md

@@ -4,6 +4,9 @@
 [![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)
 
+<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**
@@ -28,7 +31,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
 * Web server interface for stats, basic control, and detailed logs
 * Smart handling of credentials (persistent, authorization through app)
 * Easy configuration through ENVs or JSON
-* Docker images for x86/ARM
+* Install using [Docker images for x86/ARM](/docs/installation.md#docker), [flatpak](/docs/installation.md#flatpak), or [locally with NodeJS](/docs/installation.md#nodejs)
 
 **Why should I use this over a browser extension and/or mobile app scrobbler?**
 

assets/icon.png

@@ -1,10 +1,14 @@
 # Installation
 
-## Local
+# Local
+
+After installation see [service.md](/docs/service.md) to configure multi-scrobbler to run automatically in the background.
+
+## Nodejs
 
 Clone this repository somewhere and then install from the working directory
 
-```bash
+```shell
 git clone https://github.com/FoxxMD/multi-scrobbler.git .
 cd multi-scrobbler
 nvm use # optional, to set correct Node version
@@ -13,23 +17,49 @@ npm build
 npm start
 ```
 
-### Local Usage Examples
+### Usage Examples
 
 * The web UI is served on port `9078`. This can be modified using the `PORT` environmental variable.
 
 #### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
 
-```bash
+```shell
 npm start
 ```
 
 #### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
 
-```bash
+```shell
 SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret MALOJA_URL="http://domain.tld" node src/index.js
 ```
 
-## [Docker](https://hub.docker.com/r/foxxmd/multi-scrobbler)
+## Flatpak
+
+You must have [Flatpak](https://flatpak.org/) installed on your system.
+
+```shell
+flatpak install flathub io.github.foxxmd.multiscrobbler
+```
+
+### Usage Examples
+
+#### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
+
+The config directory for multi-scrobbler as a flatpak can be found under `/home/YourUser/.var/app/io.github.foxxmd.multiscrobbler/config`
+
+```shell
+flatpak run io.github.multiscrobbler
+```
+
+#### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
+
+There are a few [options for running flatpak applications with temporary or permanent environmental variables.](https://ardasevinc.dev/launch-flatpak-apps-with-custom-args-and-environment-variables)
+
+```shell
+flatpak run --env=SPOTIFY_CLIENT_ID=yourId --envSPOTIFY_CLIENT_SECRET=yourSecret --env=MALOJA_URL="http://domain.tld" io.github.foxxmd.multiscrobbler
+```
+
+# [Docker](https://hub.docker.com/r/foxxmd/multi-scrobbler)
 
 Cross-platform images are built for x86 (Intel/AMD) and ARM (IE Raspberry Pi)
 
@@ -65,15 +95,15 @@ To get the UID and GID for the current user run these commands from a terminal:
 * `id -u` -- prints UID
 * `id -g` -- prints GID
 
-### Docker Usage Examples
+## Docker Usage Examples
 
-#### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
+### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
 
 ```bash
 docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" -e "MALOJA_URL=http://domain.tld" -e "MALOJA_API_KEY=1234" -e "PUID=1000" -e "PGID=1000" -p 9078:9078 -v /path/on/host/config:/config foxxmd/multi-scrobbler
 ```
 
-#### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
+### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
 
 ```bash
 docker run -e "PUID=1000" -e "PGID=1000" -p 9078:9078 -v /path/on/host/config:/config foxxmd/multi-scrobbler

assets/icon.svg

@@ -0,0 +1,68 @@
+If you have multi-scrobbler installed [locally](/docs/installation.md#local) you can enable it to run as a background service when you login.
+
+Before running as a service you should run it at least once in the foreground to ensure it can start up correctly!
+
+# [Systemd](https://systemd.io/)
+
+Systemd is system and service manager that is used by [most popular linux distros](https://en.wikipedia.org/wiki/Systemd#Adoption) including [Ubuntu](https://wiki.ubuntu.com/SystemdForUpstartUsers), [Fedora](https://docs.fedoraproject.org/en-US/quick-docs/understanding-and-administering-systemd/), Pop!_OS, [Debian](https://wiki.debian.org/systemd), and [Arch](https://wiki.archlinux.org/title/systemd).
+
+This setup will create a [user service](https://wiki.archlinux.org/title/systemd/User) that runs on login.
+
+## Create A Unit File
+
+Create a new service file for multi-scrobbler under your HOME config:
+
+```console
+mkdir -p ~/.config/systemd/user
+touch ~/.config/systemd/user/multi-scrobbler.service
+```
+
+In a text editor add contents below to the file you created, `multi-scrobbler.service`:
+
+```ini
+[Unit]
+Description=multi-scrobbler
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=flatpak run io.github.multiscrobbler
+Restart=no
+
+[Install]
+WantedBy=default.target
+```
+
+The above assumes you [installed multi-scrobbler using flatpak](/docs/installation.md#flatpak)
+
+### Node.js Installs
+
+If you are running multi-scrobbler directly with [nodejs from a clone repository directory](/docs/installation.md#nodejs) you should modify the `[Service]`:
+
+```ini
+[Service]
+Type=simple
+WorkingDirectory=/path/to/multi-scrobbler/directory
+ExecStart=node src/index.js
+Restart=no
+```
+
+## Start the Service
+
+Save the file then run:
+
+```console
+systemctl daemon-reload
+systemctl --user enable multi-scrobbler.service
+systemctl --user start multi-scrobbler.service
+```
+
+This will
+
+* scan for new services and pickup our multi-scrobbler user service
+* enable the service to run at login automatically
+* start the service now
+
+# Other Service Methods
+
+Open a PR if you would like to document setting up multi-scrobbler for other service managers!

docs/installation.md

@@ -0,0 +1,41 @@
+NOTE: This steps are for building the flatpak entirely locally, from source. If you want to install the application normally then [get it through flathub](/docs/installation.md#flatpak)
+
+Flatpak build is a little convoluted until someone sets me straight...
+
+# 1. Install Requirements
+
+## Flatpak and flatpak-builder
+
+Install [Flatpak](https://flatpak.org/setup/)
+
+Install [flatpak-builder](https://docs.flatpak.org/en/latest/first-build.html#building-your-first-flatpak)
+
+## [flatpak-node-generator](https://github.com/flatpak/flatpak-builder-tools/tree/master/node)
+
+Requires python 3.7+, [pip](https://pip.pypa.io/en/stable/)/[pipx](https://pypa.github.io/pipx/)
+
+# 2. Update Project source
+
+Set the `branch` `tag` or `commit` to use for MS in the `git` source in [`io.github.foxxmd.multiscrobbler.yml`](/flatpak/io.github.foxxmd.multiscrobbler.yml)
+
+# 3. Use `flatpak-node-generator` to generate sources
+
+First, [make sure `node_modules` is deleted or empty.](https://github.com/flatpak/flatpak-builder-tools/issues/354#issuecomment-1478518442)
+
+Then, from MS project root:
+
+```
+flatpak-node-generator npm package-lock.json
+```
+
+Move `generated-sources.json` into [`/flatpak`](/flatpak)
+
+# 4. Build flatpak
+
+From MS project root:
+
+```console
+cd flatpak
+flatpak-builder --repo=/home/yourUser/multi-scrobbler-repo /home/yourUser/multi-scrobbler-build io.github.foxxmd.multiscrobbler.yml --force-clean
+```
+Add `--install --user` to have the app installed immediately.

docs/service.md

@@ -0,0 +1,5 @@
+{
+  "logging": {
+    "file": false
+  }
+}