Add authentication documentation #950
Conversation
Signed-off-by: DL6ER <[email protected]>
✅ Deploy Preview for pihole-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: DL6ER <[email protected]>
Signed-off-by: DL6ER <[email protected]>
|
This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there: https://discourse.pi-hole.net/t/authenticating-to-v6-api/66010/14 |
docs/api/auth.md
Outdated
|
|
||
| Once you have a valid SID, you can use it to authenticate your requests. You can do this in four different ways: | ||
|
|
||
| 1. In the request URI: `http://pi.hole/admin/api.php?sid=vFA+EP4MQ5JJvJg+3Q2Jnw=` |
There was a problem hiding this comment.
I tried various ways to get the sid using method 1 and was never able to do it. In the end, I used a Chrome plugin to modify the header. If the example could return a result, like top domains, it may be more instructive.
There was a problem hiding this comment.
@NittanySeaLion Thanks for the hint! You are absolutely right, this method was documented to work in a few places but ... well ... it wasn't actually implemented in FTL ... pi-hole/FTL#1728 does that now
|
|
||
| ## Limited number of concurrent sessions | ||
|
|
||
| The Pi-hole API only allows a limited number of concurrent sessions. This means that if you try to login with a new session while the maximum number of sessions is already active, you may be denied access. This is to prevent abuse and resource exhaustion. In case you hit this limit, please make sure to logout from your sessions when you don't need them anymore as this will free up API slots for future requests. Unused sessions will be automatically terminated after a certain amount of time. |
There was a problem hiding this comment.
| The Pi-hole API only allows a limited number of concurrent sessions. This means that if you try to login with a new session while the maximum number of sessions is already active, you may be denied access. This is to prevent abuse and resource exhaustion. In case you hit this limit, please make sure to logout from your sessions when you don't need them anymore as this will free up API slots for future requests. Unused sessions will be automatically terminated after a certain amount of time. | |
| The Pi-hole API only allows a hard-coded limit of 16 concurrent sessions. This means that if you try to login with a new session while the maximum number of sessions is already active, you may be denied access. This is to prevent abuse and resource exhaustion. In case you hit this limit, please make sure to logout from your sessions when you don't need them anymore as this will free up API slots for future requests. Unused sessions will be automatically terminated after a certain amount of time. |
There was a problem hiding this comment.
I did intentionally not specify this here as we may change this in the future or even give users the ability to set the number of maximum concurrent sessions on their own will.
Co-authored-by: yubiuser <[email protected]> Signed-off-by: DL6ER <[email protected]>
Signed-off-by: DL6ER <[email protected]>
Signed-off-by: DL6ER <[email protected]>
|
Why is this page not visible? On this site https://docs.pi-hole.net/ |
|
Because it is still not released. v6 is still in development. Use https://deploy-preview-338--pihole-docs.netlify.app/api/auth/ |
Thanks |
What does this implement/fix?
See title. This is basically an extended version of my comment on Discourse.
Related issue or feature (if applicable): N/A
Pull request in docs with documentation (if applicable): N/A
By submitting this pull request, I confirm the following:
git rebase)Checklist:
developmentalbranch.