Accounts and access
Complete first-run setup to create the initial administrator. Administrators create additional password accounts from Users; there is no public password registration.
Roles and server membership
Built-in platform roles are Admin, Server creator, and User.
Administrators can define custom platform roles and server access roles on Roles.
Custom platform roles can grant servers.create; they cannot grant platform
administration. Server access roles grant permissions on assigned servers only.
Creating servers and granting access
Administrators grant Spark provisioning access to individual users or platform roles in the Spark’s settings. This lets those users create servers on that Spark, including users with the User platform role; they do not need to be assigned Server creator first. Conversely, the Server creator role does not allow creation on every Spark: non-administrators still need a grant for the chosen Spark. Provisioning access does not grant Spark administration.
Server ownership and server memberships control access to individual servers. Owners receive all server grants through the built-in Owner role, including server deletion. Members receive the grants of their assigned server access role, such as the built-in Operator role or a custom role. Only the actual owner and panel administrators can change server access grants; a role or preset with broad server permissions does not confer ownership.
Give someone access to a server
- Sign in as the server’s owner or a panel administrator. The person receiving access must already have a Campfire account.
- Open the server and choose More server actions → Edit server, then open the Access step.
- Under Access grants, select User, choose the account, and select its Server access role. Choose Add access.
- Continue to the review step and choose Save changes.
To share with everyone assigned to a platform role, select Platform role instead of User. This grants the selected server access role on this server; it does not change anyone’s platform role. Remove a grant from the same Access step and save to revoke it. Other grants or ownership can still provide access.
Server access roles
Server access roles separate power controls, console access, files, backups, schedules,
configuration, installation, and deletion. The role editor shows these grants in
a dependency tree and offers presets. Selecting a grant also selects its
prerequisites; removing a prerequisite immediately removes its dependent grants
without an additional confirmation. server.view is always selected for a
server access role. Parent permissions do not automatically select their children.
Permission hierarchy
Each child requires its parent and all of that parent’s ancestors. The role editor uses this same tree:
server.view└── server.console.read └── server.operate ├── server.console.write ├── server.configure ├── server.reinstall ├── server.files.read │ └── server.files.write │ └── server.files.delete ├── server.backups.read │ ├── server.backups.create │ ├── server.backups.restore │ ├── server.backups.download │ └── server.backups.delete ├── server.schedules.read │ ├── server.schedules.manage │ └── server.schedules.run └── server.delete| Grant | Access and prerequisites |
|---|---|
server.view |
Overview, status, resource metrics/history, game events/media, and permission-filtered Activity |
server.console.read |
Read logs; requires server viewing |
server.operate |
Initial installation, power controls, saved-configuration sync, and log-alert dismissal; includes console reading |
server.console.write |
Send console commands; requires operation |
server.files.read |
Browse, read, and download files, including SFTP; requires operation |
server.files.write |
Create directories, upload, edit, move, rename, archive, extract, and chmod; includes file reading |
server.files.delete |
Delete files; includes file writing |
server.backups.read |
List backups; requires operation |
server.backups.create |
Create, import, rename, and pin/unpin backups; requires backup listing |
server.backups.restore |
Restore backups; requires backup listing and inherits operation |
server.backups.download |
Download backup archives; requires backup listing |
server.backups.delete |
Delete backups; requires backup listing |
server.configure |
Server settings, backup policy, and per-server Discord integrations; requires operation |
server.reinstall |
Game update and reinstallation, including clean installation; requires operation |
server.delete |
Delete the server; requires operation |
server.schedules.read |
View schedules and execution history; requires operation |
server.schedules.manage |
Create, edit, enable, and delete schedules; requires schedule reading and the scheduled action’s grant when used |
server.schedules.run |
Run schedules and retry executions; requires schedule reading and the scheduled action’s grant when used |
Reinstallation and backup restoration do not require file-browser grants. Clean
reinstallation uses server.reinstall, not file deletion. File, backup, and
server deletion are separate grants, highlighted in red in the role editor.
Permission presets
Applying a preset replaces the current checkbox selection. Each preset selects the following grants and their ancestors; you can then adjust individual boxes.
| Preset | Selected grants |
|---|---|
| Log viewer | server.console.read: logs and live console output |
| Basic operator | server.operate: initial installation and basic power controls, with console reading |
| Backup maintainer | server.backups.create, server.backups.restore, and server.backups.download, with backup viewing and operation; excludes backup deletion |
| Server administrator | Every server grant except server.delete; includes file and backup deletion |
Server administrator applies only to assigned servers. It does not grant platform administration, ownership, or permission to change server access grants. The built-in platform Admin role retains exclusive platform administration, including Sparks, users, roles, Embers, global Discord connections, server ownership reassignment, and transfers between Sparks. There is no separate sharing grant.
Basic operator grants only overview access, console reading, and basic operation. The built-in Operator role has broader grants: console commands, file management including deletion, backup viewing, creation, restoration and downloading, and schedule viewing.
Permissions for related features
- Activity:
server.viewpermits opening Activity and reading game events and media. Manual operation history additionally requiresserver.operate; scheduled operation history requiresserver.schedules.read. Job details and notification actions are filtered by their corresponding permissions, so overview access does not expose every entry or action. - Ember updates:
server.configurepermits editing saved server settings, but applying an updated Ember definition requires the platformservers.manage_allpermission. See server configuration. - Discord: per-server integration settings require
server.configure. Setting up global Discord connections requires Admin access; an API token must also have full-access scope. See Discord integration. - Copies: creating a copy requires
servers.create, sourceserver.configure, and provisioning access on the destination Spark. Including game files also requires sourceserver.files.read. - Transfers: moving an existing server to another Spark requires both
sparks.manageandservers.manage_all; ownership or server operation grants alone are insufficient. See copies and transfers for job permissions and recovery.
View as another user
The built-in platform Admin role can open View as… from the account menu and choose another enabled user. The panel then uses that user’s current account role, server memberships, ownership, and Spark provisioning grants for its normal permission checks. Navigation, visible servers, files, backups, schedules, and controls reflect the selected user’s access.
This is an inspect-only preview. Changes are rejected by the API, including server operations, file writes, schedule changes, and account changes. File reads, downloads, and live console output remain available when the selected user’s permissions allow them. Personal API tokens are unavailable during preview. The banner identifies the selected user and provides Return to Admin.
Only authenticated Admin browser sessions can start a preview; server owners, custom roles, and API tokens cannot. Preview does not create credentials or a session for the selected user. Its cookie is bound to the Admin’s current session, persists across reloads, and applies to other tabs using that session. Open tabs refresh when the preview starts or stops. Start, stop, and rejected changes are audited under the real administrator’s account.
Permissions are rechecked on subsequent requests, including live console reauthorization. Disabling or deleting the selected account blocks further preview requests; refreshing the session ends the preview and explicitly returns to the administrator’s account. Signing out ends the administrator’s session.
OpenID Connect
Configure the provider using the panel environment example
and register PUBLIC_URL/api/v1/auth/oidc/callback as the callback URL.
Complete local administrator setup first. Before setting
CAMPFIRE_DISABLE_LOCAL_LOGIN=true, link an administrator to the provider and
verify that OIDC signs in to that account. Newly provisioned OIDC users receive
ordinary user access rather than administrator privileges.
New accounts use the provider’s preferred username, normalized to Campfire’s username format. A unique suffix is added only when that username is already in use. Existing OIDC accounts keep their usernames on subsequent sign-ins.
CAMPFIRE_OIDC_ISSUER=https://identity.example.comCAMPFIRE_OIDC_CLIENT_ID=campfireCAMPFIRE_OIDC_CLIENT_SECRET=replace-with-provider-secretRestart or recreate the panel after changing its environment. Keep local login enabled until you have verified administrator access through your provider.
Automatic account linking
By default, an unknown OIDC identity creates a new user, even when its email
matches an existing account. Set CAMPFIRE_OIDC_AUTO_LINK_EMAIL=true (or
--oidc-auto-link-email) to link it to an existing local password account instead.
Matching ignores email casing and surrounding spaces and requires the provider’s
email_verified claim to be true for that email.
The linked account keeps its username, password, role, server ownership, and access grants, including administrator privileges where applicable. Enable this only when you trust the provider’s email verification and the email addresses assigned to existing accounts.
If an email matches multiple accounts, a disabled account, an account without a password, or an account that already has an OIDC identity, automatic linking rejects the login. A matching email without verification also rejects the login. When no account matches, normal user provisioning continues. Existing OIDC links remain bound to their original accounts; this setting does not merge duplicates that were already created. Authenticated users can still link accounts explicitly without requiring a verified email claim.
Personal API tokens
Open API tokens from your account menu. Create a named token, choose its
expiry and scopes, and copy the secret when shown; it cannot be retrieved later.
Send it as Authorization: Bearer TOKEN when calling the API.
A token can only use its account’s current permissions. Scopes narrow that access; they do not grant additional rights. Revoke tokens from the same dialog when they are no longer needed. Both local and OIDC users can create tokens. Server scopes use the same prerequisites as roles. Effective access is the intersection of the account’s current grants and the token’s scopes; missing prerequisites remove dependent grants from that intersection. SFTP checks file grants on each operation. Scheduled executions retain the scopes of the token that authorized them and recheck current account access before dispatch. Changing server access grants requires an owner or administrator session, or their full-access token.
Platform token scopes
Platform token scopes are separate from the grants available to custom platform
roles. Selecting an administrative scope does not make an ordinary account an
administrator. Admin tokens can be narrowed to specific platform actions; custom
platform roles can grant only servers.create.
| Scope | Limits token access to |
|---|---|
* |
All access the account already has; required for ownership-based access management and global Discord connection management |
servers.create |
Server creation and provisioning options, subject to Spark access |
servers.manage_all |
Platform server management, including ownership reassignment and applying Ember definitions |
sparks.manage |
Spark administration; transfers also require servers.manage_all |
embers.manage |
Ember definition management |
users.manage |
User administration |
roles.manage |
Role administration |
audit.view |
Platform audit history |
notifications.read |
Reading the account’s notifications |
notifications.write |
Marking the account’s notifications as read |
notifications.manage |
Notification delivery status, testing, and retries |
Server-specific endpoints still require their corresponding server scopes. Platform scopes do not replace the server permission hierarchy or bypass token scope checks.
For a forgotten administrator password or an unavailable identity provider, see password recovery.