From cd14f82753c75f69c3ce1b7ea336efe05e31af27 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Fri, 11 Jul 2025 17:27:22 +0000 Subject: [PATCH] docs: Move updating instructions to own page --- docsite/docs/configuration/_category_.json | 2 +- docsite/docs/development/_category_.json | 2 +- docsite/docs/installation/installation.mdx | 40 +------------------ docsite/docs/updating/_category_.json | 8 ++++ docsite/docs/updating/updating.mdx | 46 ++++++++++++++++++++++ 5 files changed, 58 insertions(+), 40 deletions(-) create mode 100644 docsite/docs/updating/_category_.json create mode 100644 docsite/docs/updating/updating.mdx diff --git a/docsite/docs/configuration/_category_.json b/docsite/docs/configuration/_category_.json index 1ec2cf62..01b0e3a7 100644 --- a/docsite/docs/configuration/_category_.json +++ b/docsite/docs/configuration/_category_.json @@ -1,6 +1,6 @@ { "label": "Configuration", - "position": 3, + "position": 4, "link": { "type": "generated-index", "description": "Configuring Multi-Scrobbler and examples" diff --git a/docsite/docs/development/_category_.json b/docsite/docs/development/_category_.json index 10e299b6..a8346f29 100644 --- a/docsite/docs/development/_category_.json +++ b/docsite/docs/development/_category_.json @@ -1,6 +1,6 @@ { "label": "Development", - "position": 4, + "position": 5, "link": { "type": "generated-index", "description": "Developing for Multi-Scrobbler and tutorials" diff --git a/docsite/docs/installation/installation.mdx b/docsite/docs/installation/installation.mdx index 13c476c2..f6647f84 100644 --- a/docsite/docs/installation/installation.mdx +++ b/docsite/docs/installation/installation.mdx @@ -149,17 +149,11 @@ set the [Base URL](../configuration/configuration.mdx#base-url) as the IP of the * (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 +#### Linux Host ::::info -:::note - -If you are using [rootless containers with Podman](https://developers.redhat.com/blog/2020/09/25/rootless-containers-with-podman-the-basics#why_podman_) or are running docker on MacOS/Windows this **DOES NOT** apply to you. - -::: - -If you are running 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) +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) To get the UID and GID for the current user run these commands from a terminal: @@ -226,26 +220,6 @@ The example scenario: -### Updating - - - - ```shell - docker image pull foxxmd/multi-scrobbler:latest - docker container stop multi-scrobbler - docker container rm multi-scrobbler - docker run --name multi-scrobbler ... - ``` - The last command is the same as the command used to initial run multi-scrobbler. - - - ```shell - docker compose pull - docker compose up -d - ``` - - - ## Local Installation After installation see [service.md](service.md) to configure multi-scrobbler to run automatically in the background. @@ -335,16 +309,6 @@ The web UI and API is served on port `9078`. This can be modified using the `POR ::: -#### Updating - -Assuming the repository was used for initial installation with `git clone`, update by pulling the latest commit: - -``` -git pull -``` - -and restart multi-scrobbler. - ### Flatpak :::warning[Unsupported] diff --git a/docsite/docs/updating/_category_.json b/docsite/docs/updating/_category_.json new file mode 100644 index 00000000..a59bd3f3 --- /dev/null +++ b/docsite/docs/updating/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Updating", + "position": 3, + "link": { + "type": "generated-index", + "description": "Way to update Multi-Scrobbler" + } +} diff --git a/docsite/docs/updating/updating.mdx b/docsite/docs/updating/updating.mdx new file mode 100644 index 00000000..817bfc22 --- /dev/null +++ b/docsite/docs/updating/updating.mdx @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +title: 'Overview' +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +## Updating + +Currently, multi-scrobbler does not have any databases or dependencies that require additional interaction/consideration when updating. + +The majority of major/minor version releases introduce only *new* functionality but occasionally may also include breaking changes in behavior or configuration. These changes, and how to update configs accordingly, are detailed in [Github Release Notes](https://github.com/FoxxMD/multi-scrobbler/releases). It is recommended to check this page before upgrading. + +Alternatively, multi-scrobbler version can be pinned using [git tags](https://github.com/FoxxMD/multi-scrobbler/tags) or docker image tags that match release versions IE `foxxmd/multi-scrobbler:0.9.7` + +### Docker + + + + ```shell + docker image pull foxxmd/multi-scrobbler:latest + docker container stop multi-scrobbler + docker container rm multi-scrobbler + docker run --name multi-scrobbler ... + ``` + The last command is the [same as the command used to initialy run multi-scrobbler.](../installation/installation.mdx?runType=docker#docker-usage-example) + + + ```shell + docker compose pull + docker compose up -d + ``` + + + +### Nodejs + +Assuming the [repository was used for initial installation with `git clone`](../installation/installation.mdx#nodejs), update by pulling the latest commit: + +``` +git pull +``` + +and restart multi-scrobbler. \ No newline at end of file -- 2.51.2