navidrome / website

Navidrome's documentation website

Navidrome Website

Running in a container locally

You can run this project inside a Docker container, the container runs with a volume bound to the project's source folder. This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.

1. Build the docker image

   docker-compose build

2. Run the built image

   docker-compose up

   NOTE: You can run both commands at once with docker-compose up --build.

3. Verify that the service is working.

   Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the project's homepage. You can now make changes to the source code and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C.

To remove the produced images run:

docker-compose rm

For more information see the Docker Compose documentation.

Setting up local environment

1. Install dependencies:
   • Go
   • Hugo (0.107.0 or newer)
   • Node.js
2. Clone this repository

   git clone https://github.com/navidrome/website
   cd website

3. If you want to do SCSS edits and want to publish these, you need to install PostCSS

   npm install

NOTE: For Windows users, you need to be sure to install the extended edition of Hugo.
This can be done via choco install hugo-extended

Running the website locally

Building and running the site locally requires a recent extended version of Hugo. You can find out more about how to install Hugo for your environment in our Getting started guide.

Once you've made your working copy of the site repo, from the repo root folder, run:

hugo server

This will start Hugo and serve the site at http://localhost:1313

Credits

Photos from Unsplash by:

• Travis Yewell
• Florencia Viadana

website's Issues

redesign error 404 page

The current design of error 404 page looks dull . I would like to design a better one

Configuration Options - PlaylistPath

Need to add playlist path config option, description and usage.

dark mode

I would like to add dark mode to the website

Needs Go and Node.js for source to be build on macOS

During building from source, after brew install taglib and make setup commands, I encountered a few small errors like:

/bin/sh: line 0: hash: go: not found
ERROR: GO environment not setup properly!
make: *** [check_go_env] Error 1

and

/bin/sh: line 0: hash: go: not found
ERROR: Node environment not setup properly!
make: *** [check_go_env] Error 1

so it needs Go (brew install go) and nodejs (brew install nodejs) to be able to build from source on macOS (Ventura at least), so I think it is worth to mention in documentation.

ND_ENABLE_EXTERNAL_SERVICES is actually ND_ENABLEEXTERNALSERVICES

Hi!

Minor Doc Issue:
ND_ENABLE_EXTERNAL_SERVICES
is actually:
ND_ENABLEEXTERNALSERVICES

since it gets autogenerated in configuration. See Specific Doc location.

Regards.

add nixos to community packages

NixOS packages navidrome and provides a module to enable navidrome as a systemd service.
Link to the documentation is https://search.nixos.org/options?channel=unstable&query=services.navidrome
Navidrome is by default configured to run in a tight systemd sandbox and only listen to localhost, so the user can easily set up a reverse proxy.
See the modules code https://github.com/NixOS/nixpkgs/blob/79a13f1437e149dc7be2d1290c74d378dad60814/nixos/modules/services/audio/navidrome.nix for more details

[Bug] Community Packages k8s link is dead

The link in https://www.navidrome.org/docs/installation/packages/ to https://artifacthub.io/packages/helm/k8s-at-home/navidrome no longer functions

https://artifacthub.io/packages/helm/truecharts/navidrome is the currently only up-to-date chart

Search is a little broken

The search appears to be showing code instead of (images?) that's from what I can read at least.

FAQ : Precision

"For a “Various Artists” compilation, the Part Of Compilation tag (TCMP for id3, COMPILATION for FLAC) must be set, for all tracks."

I suggest you add that the "Album artist" also has to be empty.

Reuse in other communities - SSO login

It would be interesting to implement SSO so that you can join this project on existing platforms with users already registered, so that the user does not need to make a new registration to use this platform.

Documentation on how to use mobile GUI

When I play a song via the web page on a smartphone I only see a floating icon that I can move around. There's no way to switch this into a regular player screen. The only thing I can do is close the icon which stops playback.

In trying to solve the problem I searched for a documentation regarding usage of the Navidrome web page and realized such documentation doesn't seem to exist.

Search bar disappears in mobile version.

This same issue happens with docsy.

Installation for Mac.

I want to check out Navidrome, but I'm not a developer or coder at all, and the instructions kinda assume you know a few things. I can't make heads or tails of what it wants me to do or how to use it.

No troubleshooting instructions + possibly incomplete setup instructions for osx

I went through the installation instructions for osx, and the launchctl service is listed but won't run, and I'm not sure why. It would be great to have a list of things you would expect to see for a valid setup (e.g. permissions of all the various files, log output, launchctl output, etc.) and some indication of what might be wrong if our local state doesn't match up with what's expected.

I wouldn't expect you to go crazy rewriting launchctl's docs, but it seems like there could be some middle ground to point users in the right direction for things to check.

Thanks for considering this change.

How to transform a Raspberry Pi into a Jukebox using Navidrome in a Docker container?

I'm running deluan/navidrome:latest in a docker container under a Raspberry Pi host.
I enabled jukebox by following the explanation from the page https://www.navidrome.org/docs/usage/jukebox , however it still plays on the client device instead of playing on Rapsberry PI.

In the log I can see:

time="2023-11-30T22:56:32Z" level=info msg="Starting playback server"
time="2023-11-30T22:56:32Z" level=info msg="2 audio devices found"
time="2023-11-30T22:56:32Z" level=info msg="Using audio device: alsa/default:CARD=PianoDACPlus"

Mpv is installed in the docker container and returns correctly the list of audio devices.
mpv --audio-device=help:

List of detected audio devices:
  'auto' (Autoselect device)
  'alsa' (Default (alsa))
  'alsa/default:CARD=ALSA' (bcm2835 ALSA, bcm2835 ALSA/Default Audio Device)
  'alsa/sysdefault:CARD=ALSA' (bcm2835 ALSA, bcm2835 ALSA/Default Audio Device)
  'alsa/default:CARD=PianoDACPlus' (PianoDACPlus, PianoDACPlus multicodec-0/Default Audio Device)
  'alsa/sysdefault:CARD=PianoDACPlus' (PianoDACPlus, PianoDACPlus multicodec-0/Default Audio Device)
  'jack' (Default (jack))
  'sndio' (Default (sndio))

The following are also present in the docker-componse configuration:

group_add:
  - "29" # audio group ID (gid)
devices:
  - "/dev/snd:/dev/snd"

What could be the cause? How can I further debug it?

Linux instructions are wrong.

The instruction : wget https://github.com/navidrome/navidrome/releases/download/v0.XX.0/navidrome_0.XX.0_Linux_x86_64.tar.gz -O Navidrome.tar.gz
Is incorrect and not up to date.

"https://github.com/navidrome/navidrome/releases/download" doesn't exist or is not able to be reached.

Add hamburger menu for mobile view of the website

Menu items create the scroll effect
A better idea would be to have a hamburger menu option.

windows installation - Where to put the ffmpeg files?

search the site up and down, read about that I need ffmpeg - but no word about where to put in.
Navidrome shows up "level=warning msg="unable to find ffmpeg. Transcoding will fail if used" error="exec: "ffmpeg": executeable file not found in &PATH"

so first, which is the "PATH" ?
what to write down in Navidrome.toml ?

i create an folder inside the folder Navidrome with ffmpeg inside of it, but how to tell Navidrome to look inside that folder? (btw. folder called ffmpeg)
second try was to copy ffmpeg.exe directly inside the navidrome folder - no luck at all

So please update your Site with an example where to put ffmpeg and what to type in the config file

thank you :-)

Docker installation document typo

https://www.navidrome.org/docs/installation/docker/#using-docker-command-line-tool
There's an extra space in the end of line7.

xxx

make it less complicated to install this. i bet if i spent 3 hours following these instructions to the letter, it still wouldn't work

Proposing new landing page

New Website

As I was going through the landing page, I noticed some UI bugs such as:
About page contents overflow in mobile view.
Search feature not working correctly.
And also, the website seems old. So I was thinking of developing a new landing page for navidrome.org. The new website will contain all the information that is currently available. If you may allow me to start the development, I will be more than happy to help.

documentation : no import or add song instructions or links

Just did a fresh install of Navidrome : looks great
But there are no buttons or links to import or add songs.
The links visible in the demo system flash on screen and then disappear with a "no content" message.
The documentation does not say how to add a sing/album

Add "Disable User" functionality request.

Hi I hope this is the right forum for this request. If that is not the case, I do apologize.
It will be nice to have a disable user functionality for the admin users. Currently the only option I see is to delete the user.

Deleting a user is fine when you know you want to remove it for good but, sometimes you just want to disable the user for some time and keep the historical info like playlists etc. in case the user is enabled again so that data will still be there.

Is that something that you guys have plans to implement?

Thanks for this great piece of software.

Add songs or albums within the interface

So first of all, thanks for creating this amazing application!

Since Navidrome uses music that you already have, I was expecting that (admin) users could upload new songs when logged into the Navidrome panel. That would make it usable for me as me and my friends would share an instance and create a useful substantial music library fast.
I could not find information on this were I was expecting it in the demo. Also not though: https://www.navidrome.org/docs/getting-started/

Is this a feature that is in Navidrome? Would be well worth considering I think 😄

Update ARM version resource?

Background:

In my recent experience, the ARM table that is linked to on the Installation page was not accurate. I have a raspberry pi 3, which according to that site should use ARMv8. So I installed the v8 build (which doesn't actually say "v8" on it, which was a little confusing), and the service failed to start. After looking at journalctl I saw:

pi@raspberrypi:~ $ journalctl
-- Logs begin at Thu 2016-11-03 10:16:44 PDT, end at Thu 2021-07-01 15:10:02 PDT. --
Nov 03 10:16:44 raspberrypi kernel: Booting Linux on physical CPU 0x0
Nov 03 10:16:44 raspberrypi kernel: Linux version 4.19.66-v7+ (dom@buildbot) (gcc version 4.9.3 (crosstool-NG cro
Nov 03 10:16:44 raspberrypi kernel: CPU: ARMv7 Processor [410fd034] revision 4 (ARMv7), cr=10c5383d

Showing that I have ARMv7 on my raspberry 3. After looking into it, it looks like both Raspberry 3s and 4s can use ARMv7 in some cases.

Suggestion:

So this issue is to see whether you think the website should offer a different method of checking the ARM version. Instead of a website, users should actually look at their system. One method is to run cat /proc/cpuinfo. Anyone know of another good method?

The line in question: https://github.com/navidrome/website/blame/master/content/en/docs/Installation/_index.md#L22

爱的回忆

Can you help

Hello, what is the easiest way to install on a Windows 11 computer?
I do not know anything about programming.
Thanks

Please include a section that explains how to use the Subsonic API

The docs of similar software like Funkwhale make it quite easy. Your docs claim it should be available, yet there's no indication as to how or where to find the data for that. Edit: it seems to work with user-login data. Quite different from funkwhale, so maybe that's why I was confused.
https://docs.funkwhale.audio/users/apps.html

Please add FAQ/documentation on how to run as https website

or add as "Navidrome Article" on the website documentation
https://www.reddit.com/r/navidrome/comments/irh51d/guide_navidrome_nginx/
also, running Navidrome on Openmediavault server (same thread)
https://www.reddit.com/r/navidrome/comments/irh51d/comment/ih5rv0q/?utm_source=reddit&utm_medium=web2x&context=3

No ability to set user in Docker

Container does not have a documented way to set the user ID/group ID via environmental variable or it's not documented

Surveys

I can't find the surveys for my class and the class is called Pop music through the ages and I was trying to ask my teacher and he did not help me but I want you help me right now and the sign in is not working and I was trying to sign in and It was not working at all and can you please help me right now?

Add note to set user and group in systemd unit

The step-by-step instructions for creating a systemd unit for Navidrome are perfect in my opinion. Except for one thing: Create a Systemd Unit should mention once again, that the User and Group configuration values need to be replaced. I see it's mentioned in the introduction, but a) the systemd configuration is so long, that User and Group can be overlooked easily and b) everything is clear without even reading the introduction and c) the introduction speaks of commands, not configuration.

Note that you have to set User and Group here as well.

Updating Doc's for Running navidrome on WINDOWS in Devlopement Enviroment

There is no information present on how to run Navidrome on windows in Development env, I would like to add it.
I will add documentation on how to run Navidrome on windows using Windows Subsystem for Linux (WSL) + VsCode.
can I go ahead @deluan ??

Change expiration date sharing in mass ?

Hello!
I want to change all my expiration date sharing.
Is it possible to change fast in mass ?

Best regards

Rootless docker install

I'm trying to install navidrome using rootless docker on Ubuntu 22.04, docker v25.0.3
If I just follows the docker install instruction it fails with 'permission error'
I think the way of setting 'uid:gid' via enviromental variable fails in rootless docker.
Since the rootful docker work with root user without user variable, rootless docker should work with current user in the same situation.
So I deleted user variable and it works fine.
I think the instruction for rootless docker should be added.