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

Enhancement: allow api auth with moonraker service #2934

Merged
merged 3 commits into from
Feb 18, 2024
Merged

Enhancement: allow api auth with moonraker service #2934

merged 3 commits into from
Feb 18, 2024

Conversation

stevendejongnl
Copy link
Contributor

@stevendejongnl stevendejongnl commented Feb 18, 2024

Proposed change

Changed the genericProxyHandler to use the credentialedProxyHandler for moonraker instances that uses authorization by API keys.
With the genericProxyHandler you get a 401 unauthorized error on those instances.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

@shamoon
Copy link
Collaborator

shamoon commented Feb 18, 2024

Please provide an explanation and or / link to a discussion, even if the change seems obvious. It doesn’t seem any other moonraker users have asked about auth

@stevendejongnl
Copy link
Contributor Author

Please provide an explanation and or / link to a discussion, even if the change seems obvious. It doesn’t seem any other moonraker users have asked about auth

Sorry, I submitted to quickly.
Updated the description

@shamoon
Copy link
Collaborator

shamoon commented Feb 18, 2024

Thanks. So moonraker api uses

headers["X-API-Key"] = `${widget.key}`;

?

@shamoon shamoon changed the title Use credentialedProxyHandler within moonraker service Enhancement: allow api auth with moonraker service Feb 18, 2024
@shamoon
Copy link
Collaborator

shamoon commented Feb 18, 2024

Also, thing to check here is that it won’t break non-auth instances…

(also assuming it never allows basic auth, which this would also break)

@stevendejongnl
Copy link
Contributor Author

stevendejongnl commented Feb 18, 2024

Thanks. So moonraker api uses

headers["X-API-Key"] = `${widget.key}`;

?

Thats correct:
https://moonraker.readthedocs.io/en/latest/web_api/#authorization

Also, thing to check here is that it won’t break non-auth instances…

(also assuming it never allows basic auth, which this would also break)

Good point, I will spin up another instance without authentication to check this.

@shamoon
Copy link
Collaborator

shamoon commented Feb 18, 2024

Great thanks. Yea as you can guess I don’t have an instance to test.

Thanks for the docs link, yea in this case please update the homepage docs to note the optional key parameter

@stevendejongnl
Copy link
Contributor Author

stevendejongnl commented Feb 18, 2024

Great thanks. Yea as you can guess I don’t have an instance to test.

Thanks for the docs link, yea in this case please update the homepage docs to note the optional key parameter

I can confirm that an instance without authentication and no key set in the configuration does work:
image
image

@shamoon shamoon enabled auto-merge (squash) February 18, 2024 22:09
@shamoon shamoon enabled auto-merge (squash) February 18, 2024 22:12
Copy link
Collaborator

@shamoon shamoon left a comment

Choose a reason for hiding this comment

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

Thanks for confirming that.

I don't really think this is a bug but since it literally adds 0 code thats cool. Do try to mind the PR requirements (checkboxes you removed) in the future (here and in general).

@shamoon shamoon merged commit b0dd810 into gethomepage:main Feb 18, 2024
5 checks passed
Plancke pushed a commit to Plancke/homepage that referenced this pull request Feb 23, 2024
Plancke pushed a commit to Plancke/homepage that referenced this pull request Feb 23, 2024
truecharts-admin added a commit to truecharts/charts that referenced this pull request Mar 11, 2024
…0.8.9@869c800 by renovate (#19065)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[ghcr.io/gethomepage/homepage](https://togithub.com/gethomepage/homepage)
| patch | `v0.8.8` -> `v0.8.9` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>gethomepage/homepage (ghcr.io/gethomepage/homepage)</summary>

###
[`v0.8.9`](https://togithub.com/gethomepage/homepage/releases/tag/v0.8.9)

[Compare
Source](https://togithub.com/gethomepage/homepage/compare/v0.8.8...v0.8.9)

#### What's Changed

- Feature: Add list view for custom api by
[@&#8203;sgrtye](https://togithub.com/sgrtye) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#2891
- Change: use Script component instead of async script for custom.js by
[@&#8203;Cyberbeni](https://togithub.com/Cyberbeni) in
[gethomepage/homepage#2901
- Change: move custom.css linking to head to avoid FOUC by
[@&#8203;Cyberbeni](https://togithub.com/Cyberbeni) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#2916
- Enhancement: Add enablePools option to TrueNAS service widget by
[@&#8203;dstotz](https://togithub.com/dstotz) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#2908
- Enhancement: Add requestBody as option for customapi widget by
[@&#8203;dstotz](https://togithub.com/dstotz) in
[gethomepage/homepage#2921
- Enhancement: allow api auth with moonraker service by
[@&#8203;stevendejongnl](https://togithub.com/stevendejongnl) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#2934
- Add Plant-it widget by
[@&#8203;MDeLuise](https://togithub.com/MDeLuise) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#2941
- Chore(deps): Bump systeminformation from 5.21.24 to 5.22.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gethomepage/homepage#2999
- Chore(deps-dev): Bump eslint from 8.56.0 to 8.57.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gethomepage/homepage#3000
- Chore(deps-dev): Bump postcss from 8.4.33 to 8.4.35 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gethomepage/homepage#3001
- Chore(deps): Bump recharts from 2.11.0 to 2.12.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gethomepage/homepage#3002
- Fix: support cyrillic characters in quicklaunch by
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#3020
- Fix: docker status labels colors by
[@&#8203;RoboMagus](https://togithub.com/RoboMagus) and
[@&#8203;shamoon](https://togithub.com/shamoon) in
[gethomepage/homepage#3028
- Enhancement: Add formatting options to weather widgets by
[@&#8203;benphelps](https://togithub.com/benphelps) in
[gethomepage/homepage#3093
- Feature: Add Homebox widget by
[@&#8203;cadeluca](https://togithub.com/cadeluca) in
[gethomepage/homepage#3095

#### New Contributors

- [@&#8203;Cyberbeni](https://togithub.com/Cyberbeni) made their first
contribution in
[gethomepage/homepage#2901
- [@&#8203;dstotz](https://togithub.com/dstotz) made their first
contribution in
[gethomepage/homepage#2908
- [@&#8203;stevendejongnl](https://togithub.com/stevendejongnl) made
their first contribution in
[gethomepage/homepage#2934
- [@&#8203;MDeLuise](https://togithub.com/MDeLuise) made their first
contribution in
[gethomepage/homepage#2941
- [@&#8203;cadeluca](https://togithub.com/cadeluca) made their first
contribution in
[gethomepage/homepage#3095

**Full Changelog**:
gethomepage/homepage@v0.8.8...v0.8.9

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 10pm on monday" in timezone
Europe/Amsterdam, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMzUuMSIsInVwZGF0ZWRJblZlciI6IjM3LjIzNS4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
denispapec pushed a commit to denispapec/homepage that referenced this pull request Mar 17, 2024
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants