WS281x LEDs - Running as Root

[specie77]

Feature request

What problem does this feature solve?

The updateHyperionUser.sh script was difficult to locate, I found it by digging through the github issues/comments. I understand from previous issues and threads that Hyperion should not run as root unless WS281x LEDs are used.

What does the proposed API look like?

N/A

How should this be implemented in your opinion?

To facilitate a more seamless end user experience, is it possible to trigger a webUI pop-up/warning (when selecting WS218x) to say "To use these LEDs, Hyperion will need to run as root, are you sure?" and if yes, execute updateHyperionUser.sh (pending the outcome of #1620)

Are you willing to work on this yourself?

Don't have the relevant expertise, otherwise I would.

[Lord-Grey]

Thanks for highlighting that the user experience can improved!

The updateHyperionUser.sh script was difficult to locate

You can invoke updateHyperionUser (without .sh) from everywhere in the system (as it is in the PATH), if Hyperion was installed via its package. This is the case for HyperBian.
I apprechiare that it would be helpful to have this outlined in the official documentation.
As the project currently lack contributors, we are happy to get further support in completing the documentation.
Everybody including you :) is invited to improve things.

To facilitate a more seamless end user experience, is it possible to trigger a webUI pop-up/warning (when selecting WS218x)

The envisioned UI behaviour was implemented before, but due some bug it unfortunately does not resolve correctly.
I will address this bug.

Actually the screen should look like this, if hyperion does not run under root for this device:

[Lord-Grey]

I fixed the issue via #1623 .

May I ask you testing the fix?
You should be able to do this in a quite simple way due to a new script....

1. As you are already a GitHub user ,create a fine grained personal access token for your user.
   Go to https://github.com/settings/tokens?type=beta and do a "Generate new token":
   a) Give the token a name
   b) Select "All Repositories"
   c) Under Permissions/Repository permissions
   Define Read-Only Access to "Actions"
   d) Generate token

2. Copy the new generated token

3. ssh into the HyperBian rpi

4. Execute the install_pr script replacing the token with your token copied in 2.
   wget -qO- https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/bin/scripts/install_pr.sh | bash -s -- -t token 1623

5. run the execution script to start Hyperion without root access
   ~/hyperion_pr1623/1623.sh

6. Check that the UI reports missing admin access and does not allow configuring ws281x

7. run the execution script with sudo to start Hyperion with root access
   sudo ~/hyperion_pr1623/1623.sh

8. Check that the UI reports allows to configure ws281x

9. Remove installed version for the given PR

Note:
The script will stop the current hyperion service before execution.
After doing your tests, you should start the service again or just reboot to start the service automatically.
systemctl start hyperion@root.service

Note 2:
In case you would like to test with a current configuration, provide the configuration location via the "-c" option.
The configuration will be copied to avoid any side effects on your current configuration,
i.e. any updates to the configuration when testing the PR will also not be reflected in the current setup.

Sample

Current user
wget -qO- https://raw.githubusercontent.com/Lord-Grey/hyperion.ng/Update_platforms/bin/scripts/install_pr.sh | bash -s -- -t token -c ~/.hyperion 1623

root user
sudo wget -qO- https://raw.githubusercontent.com/Lord-Grey/hyperion.ng/Update_platforms/bin/scripts/install_pr.sh | bash -s -- -t token -c /root/.hyperion 1623

[specie77]

Step 4 didn’t seem to do anything, and step 5 said no file found.Not sure what I missed. I successfully created a token and replaced the word token with my actual token.Happy to help and test, please let me know what I’m missing.

[Lord-Grey]

I am really sorry, but the path of different activities just crossed unfortunately.
Exactly yesterday, I merged the development branch (where the link in 4. pointed to) and it got deleted.
The script is now available in the official repository.

I updated the command in step 4. and it should work now.
Sorry for the inconvenience.

[Lord-Grey]

@specie77 It would be great, if you could have another try with the updated link.

[specie77]

Updated link?

[Lord-Grey]

I updated the initial instructions with the correct link. But the artifacts are gone now.
I will merge the PR and you then can test the Nightly build, an own build or a build of an upcoming PR

[InaudibleSound]

Any update on this? I stuck on this step too, it shows me this: Information
Hyperion must run with 'root' privileges for this controller type!
I've followed your steps, but it says Error : Unauthorized

[Lord-Grey]

As the error message says, the token you provided is not valid. It looks too short.

[InaudibleSound]

well, that's the token, but when i paste the token it won't download anything.
What am I missing?
wget -qO- https://raw.githubusercontent.com/Lord-Grey/hyperion.ng/Update_platforms/bin/scripts/install_pr.sh | bash -s -- -t token -c ~/.hyperion 1623

Is the token that: https://raw.githubusercontent.com/Lord-Grey/hyperion.ng/Update_platforms/bin/scripts/install_pr.sh
If that's right, then i should change it to my one right? Sorry for the spam, just don't get it to work and stuck here.

[Lord-Grey]

Never post your tokens here. Those are your keys to GitHub activities.

You need to replace the „token“ text with your full token text.

And your command should be in one line