docs: clarify OCAP_AUTH_ADMINSTEAMIDS takes no brackets in env var#460
Merged
Conversation
Setting the admin Steam IDs env var with JSON-array brackets (e.g. [id1,id2]) silently fails: viper splits the value on commas only and the brackets become part of the IDs, so the admin check never matches. Note the bracket-less comma-separated format in the README table and in both Pelican/Pterodactyl egg field descriptions.
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in README.md and the configuration descriptions in egg-ocap2-web-pterodactyl.json and egg-ocap2-web.json to clarify that the OCAP_AUTH_ADMINSTEAMIDS environment variable expects a comma-separated list of Steam64 IDs without brackets or quotes. There are no review comments, and I have no feedback to provide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
A user set
OCAP_AUTH_ADMINSTEAMIDS=[id1,id2](JSON-array brackets) and was silently never recognized as admin. Since the viper #761 BindEnv workaround was removed, viper resolves the env var into the[]stringfield by splitting on commas only — it does not strip brackets. So[id1,id2]parses as["[id1", "id2]"]andslices.Containsnever matches the real Steam ID. Removing the brackets (id1,id2) works.What
Documentation-only clarification (no behavior change):
76561198012345678,76561198087654321 (no brackets, no quotes), since the Pelican/Pterodactyl config UI is where the reporting user was.The bracketed
["..."]form remains correct forsetting.json(JSON array).