Skip to content

docs: clarify OCAP_AUTH_ADMINSTEAMIDS takes no brackets in env var #460

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.

Sign up for GitHub

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

Merged
fank merged 1 commit into from
May 30, 2026
Merged

docs: clarify OCAP_AUTH_ADMINSTEAMIDS takes no brackets in env var #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Admin access uses Steam OpenID — no passwords. Admins authenticate via their S
| Setting | Env Var | Description | Default |
|---------|---------|-------------|---------|
| `auth.sessionTTL` | `OCAP_AUTH_SESSIONTTL` | How long admin sessions last | `24h` |
| `auth.adminSteamIds` | `OCAP_AUTH_ADMINSTEAMIDS` | Steam64 IDs authorized for admin access (comma-separated in env var) | `[]` |
| `auth.adminSteamIds` | `OCAP_AUTH_ADMINSTEAMIDS` | Steam64 IDs authorized for admin access (comma-separated, no brackets, in env var) | `[]` |
| `auth.steamApiKey` | `OCAP_AUTH_STEAMAPIKEY` | Steam Web API key for fetching display names and avatars ([get one here](https://steamcommunity.com/dev/apikey)) | `""` |

The Steam API key is optional. Without it, the admin badge shows the raw Steam64 ID. With it, the admin's Steam profile picture and display name are shown.
Expand Down
2 changes: 1 addition & 1 deletion egg-ocap2-web-pterodactyl.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
},
{
"name": "Allowed Steam IDs",
"description": "Comma-separated list of Steam64 IDs authorized for admin login via Steam OpenID. Leave empty to disable Steam admin login.",
"description": "Comma-separated list of Steam64 IDs authorized for admin login via Steam OpenID, e.g. 76561198012345678,76561198087654321 (no brackets, no quotes). Leave empty to disable Steam admin login.",
"env_variable": "OCAP_AUTH_ADMINSTEAMIDS",
"default_value": "",
"user_viewable": true,
Expand Down
2 changes: 1 addition & 1 deletion egg-ocap2-web.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
},
{
"name": "Allowed Steam IDs",
"description": "Comma-separated list of Steam64 IDs authorized for admin login via Steam OpenID. Leave empty to disable Steam admin login.",
"description": "Comma-separated list of Steam64 IDs authorized for admin login via Steam OpenID, e.g. 76561198012345678,76561198087654321 (no brackets, no quotes). Leave empty to disable Steam admin login.",
"env_variable": "OCAP_AUTH_ADMINSTEAMIDS",
"default_value": "",
"user_viewable": true,
Expand Down
Loading