Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Raspberry install docs. #1243

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Conversation

Drexel2k
Copy link

@Drexel2k Drexel2k commented Dec 8, 2023

Hello,

I really appreciate the work you put is in this project. I am currently building an Internetradio on Raspberry basis, for which I also wanted spotify integration. Therefore I need a little control over the Spotify service on the Raspberry itself, e.g. stopping the Spotify playback when I chose a radio station and the radio starts playing. I found spotifyd as a possible solution for this use case, but I had a hard time setting it up for my needs.

I want to share my experience and enriched the documentation with topics, where I had trouble. As I am not so deep in the techincal topics like Rust and Linux, I try at leas to contribute at the docs...

I still see 2 problems which I couldn't solve, but for which I have workarounds, but I will open issues for these.

Best regards
Matthias

Copy link
Member

@eladyn eladyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much! The docs are very much in need of such contributions and I think, this can be very valuable to first time users as you say.

I added many small comments. You don't need to tackle them all at once. If you prefer, we can also fix the basic formatting things, merge and improve gradually from there.

docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-32.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-64.md Outdated Show resolved Hide resolved
docs/src/installation/Raspberry-Pi-64.md Outdated Show resolved Hide resolved
Drexel2k and others added 5 commits December 15, 2023 10:43
Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
@Drexel2k
Copy link
Author

Thank you very much! The docs are very much in need of such contributions and I think, this can be very valuable to first time users as you say.

I added many small comments. You don't need to tackle them all at once. If you prefer, we can also fix the basic formatting things, merge and improve gradually from there.

I am glad you say this, I wasn't sure if this kind of detailed documentation was really wanted. :)

I would merge now, maybe you can do before what I proposed in the comments and then the work can continue from the merge. I was also thinking of adding instrcutions how to build from the latest release source and not from the latest commit, but I would do that afterwords. Thank you for your frinedly response!

Co-authored-by: eladyn <59307989+eladyn@users.noreply.github.com>
@Drexel2k Drexel2k requested a review from eladyn December 20, 2023 13:12
Copy link
Member

@eladyn eladyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, that's fine by me.

Comment on lines 116 to 123
## Known issues / Logging
Logging in files is currently not possible for the daemon setup, the daemon crashes without the --no-daemon argument (redirects the output to stdout).
Without the parameter it tries to output at syslog, but even with syslog installed it crashed.
To get at least the latest output run

```bash
sudo systemctl status spotifyd.service
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could remove this part before we merge, since this is probably not accurate.

Copy link
Author

@Drexel2k Drexel2k Dec 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I took this and the whole discussion as an opportunity to overwork the docs again. Most of the topics were general Linux topics, so I separated the system/sistribution specific topics and the general Linux topics. General topics are now in 'Build-on-Linux.md' and 'Run-on-Linux.md', the specific files like Raspberry files are now just a small entry point with few specific topics and links to the general files. At least the run file can also be linked in the Fedora file and maybe also in the FreeBSD file I think.

From the known issues I removed the logging issue, but added the DnsSdError and new issue: I switch to the PulseAudio backend because I have short overlaps of Spotify and radio playback on my app, which caused it to crash, because my HifiBerry amp isn't capable of mixing 2 audio streams in hardware. But as a system wide service, I get a connection refused error when accessing the PulseAudio backend, first I thought I cannot access a service run as user (which PulseAudio is) from a process run as root, but I configured the system service to run with my normal user and the problem persists. I found here: #685 that it may be an issue with RuntimeDirectory of system services, but I didn't had the time yet to investigate it further. If you know this and have a solution, you can remove the issue and maybe tell me the solution. ;) Otherwise I try to find a solution next year.

And I also tried to unified some wordings like the use of compile/build and daemon/service.

So far, have a nice christmas and holiday season!

Copy link
Author

@Drexel2k Drexel2k Dec 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I can also help updating instructions on the homepage, just let me know how.
Or if I shall build ARM64 binaries for the download page I can also do it.

@Drexel2k Drexel2k requested a review from eladyn December 24, 2023 12:28
@Drexel2k
Copy link
Author

Drexel2k commented Apr 4, 2024

Hello, I just saw that this is still open, do you need any action or information from me? Or was it just not on your schedule yet?

@eladyn
Copy link
Member

eladyn commented Apr 8, 2024

I'm sorry for not following up with anything. Initially I planned to have another look at your PR and then merge it, but as time passed I got more and more convinced that something had to be done to the entire docs. As this is a larger project, I only started working on it and never finished it since then.
So I guess, the best way forward would be to just merge your changes and then we can someday resolve all the remaining issues with the docs.

The biggest thing that I noticed that should be done before we can merge is to change SUMMARY.md to include the new files and reflect the changes. This way, the generated docs follow your changes.

@Drexel2k
Copy link
Author

I see what you mean, also some conent seems a little bit redundant in the readme and other files...
But I've also updated the SUMMARY.md file.

@Drexel2k Drexel2k closed this by deleting the head repository Jun 7, 2024
@Drexel2k
Copy link
Author

I cleand up my repositories and also deleted the spotifyd fork, I wasn't aware that I still had an open pull request. :D
I restored the fork, it would be a pitty, if the content was lost.

@Drexel2k Drexel2k reopened this Jul 11, 2024
@eladyn
Copy link
Member

eladyn commented Jul 11, 2024

Oh thank you! I was already wondering what happened. I hope to finally get around to doing documentation things in a few weeks, but maybe I can just see if merging this is possible since it would have been helpful in multiple occasions already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants