navidrome / website

Navidrome's documentation website
https://www.navidrome.org
Apache License 2.0
18 stars 92 forks source link

No troubleshooting instructions + possibly incomplete setup instructions for osx #66

Open brentshermana opened 2 years ago

brentshermana commented 2 years ago

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.

prakhar3062 commented 2 years ago

okay i will check

Rithvik-Upadhya commented 1 year ago

Hey, you must have a lot on your plate @prakhar3062 so suggesting some specific changes and corrections that can be made to the macOS install guide.

  1. launchctl load ~/Library/LaunchAgents/navidrome.plist`
    • Command has an extra back-tick at the end.
  2. A configuration file for Navidrome has been created and is named navidrome.toml in that folder.
    • Add here: Be sure to set the DataFolder option as well.
  3. Add line at end of doc: Use an application like LauchControl to debug any issues with running the above commands.

What do you think?

deluan commented 1 year ago

Hey @Rithvik-Upadhya, thanks for chiming in. I'm not sure if @prakhar3062 is working on this. Please feel free to submit a PR to the documentation site. You can even do all that from the browser:

Screen Shot 2022-11-02 at 5 01 25 PM