FiveManage API key setup

FiveManage is required only when Config.ControlPanel.settingsShare.thumbnails is enabled. DynamicHUD uses it to store player-approved Settings Share screenshots. Presets continue to work with generated fallback previews when thumbnails are disabled.

Create the API key

1. Create a FiveManage account or sign in to an existing account.
2. Create or select the team that should own the uploaded HUD thumbnails.
3. Open the FiveManage dashboard and navigate to Tokens.
4. Select Create token and give it a recognizable name such as Orbit Dynamic HUD 2.0 thumbnails.
5. Choose the Images scope for least privilege. A Media token also works, but grants image, video, and audio access that this integration does not need.
6. Copy the generated token and store it as a protected server secret.

FiveManage documents the same account, team, and token flow in its upload API first steps. API keys are managed from the dashboard Tokens page.

Configure DynamicHUD

Put the token in server.cfg before orbit-dynamichud-v2 starts:

set orbit_fivemanage_api_key "YOUR_FIVEMANAGE_API_KEY"

Keep the server configuration pointed at that convar:

Config.SettingsShareServer.thumbnail = {
    captureProvider = 'screencapture', -- or 'screenshot-basic'
    apiKey = GetConvar('orbit_fivemanage_api_key', ''),
    presignedUrlEndpoint = 'https://api.fivemanage.com/api/v3/file/presigned-url',
    fileEndpoint = 'https://api.fivemanage.com/api/v3/file',
    deleteUnusedThumbnails = true
}

Enable thumbnails in the shared feature configuration:

Config.ControlPanel.settingsShare.thumbnails = true

Start exactly the capture provider selected in captureProvider, and start it before DynamicHUD:

# Choose one provider, matching server/config.lua.
ensure screencapture
# ensure screenshot-basic

ensure orbit-dynamichud-v2

You do not need to install the FiveManage SDK resource for this integration. DynamicHUD requests FiveManage v3 presigned upload URLs through its own server module.

How the key stays private

1. The server validates the player, feature state, preset limits, cooldown, and upload request.
2. The server authenticates with FiveManage and requests a short-lived presigned URL.
3. The client captures the composed game and HUD frame and uploads only to that temporary URL.
4. The server validates the returned HTTPS host, storage marker, file path, and image bytes before saving the thumbnail.
5. When configured, the server deletes the managed file after its preset is deleted or receives a replacement thumbnail.

This follows FiveManage's recommended presigned URL flow: the permanent token stays on the server while the client receives temporary upload permission.

Verify the setup

1. Temporarily set Config.Debug = true.
2. Restart orbit-dynamichud-v2 rather than refreshing only the NUI.
3. Check the server console startup line for the selected provider, a started provider resource, and apiKey=present.
4. Open Settings Share, begin an upload, and capture a thumbnail.
5. Save privately or submit the preset. The staged image is uploaded only when that preset action is confirmed.
6. Confirm the thumbnail appears in the preset and in the FiveManage storage dashboard.
7. Return Config.Debug to its production value after verification.

Troubleshooting

Rotate the token immediately if it is exposed. Update the convar, restart DynamicHUD, and revoke the old token in the FiveManage dashboard.