Getting help
Where to ask questions, how to report a problem so it gets solved quickly, and how to report a security issue.
When the docs do not answer your question, you have three routes: the community forum, your VeloPhex support contact, and, for vulnerabilities only, the security team. This page explains which to use and what to send so that someone can help you on the first reply.
Choose the right channel#
| You want to | Use |
|---|---|
| Ask how to do something, share an approach, or see whether others hit the same problem | The community forum at forum.velophex.com |
| Report a production problem, an outage or a suspected defect under your agreement | Your VeloPhex support contact, as named in your agreement or onboarding material |
| Report a security vulnerability | Email security@velophex.com. Do not post it on the forum |
The community forum#
The forum at https://forum.velophex.com is the place for how-to questions, workflow design, Python SDK usage, activity questions and deployment advice. Search before you post; many questions already have an answer.
When you post:
- Use a title that states the problem, for example "Queue trigger starts no jobs after upgrade", not "Help".
- Say which components and versions you run: Orchestrator image tag, Robot version and installation profile, Studio version, Python SDK version where relevant.
- Describe what you expected, what happened, and the exact error text.
- Include short, relevant log excerpts, not whole files.
- When the problem is solved, post what fixed it so the next person finds it.
Keep secrets out of public posts
Never post personal access tokens, enrollment keys, the key-encryption key, passwords, webhook secrets, customer data or internal host names. Tokens start with vpx_pat_, vpx_ek_, vpx_rt_ or vpx_scim_; search your text for these prefixes before you post. If you post a token by mistake, revoke it immediately.
New members' first posts may wait for moderator approval before they appear.
Reporting a problem to support#
A good report lets support start on the cause instead of asking questions. Include:
What happened#
- A one-line summary and when it started.
- What changed recently: an upgrade, a new Robot, a certificate, a proxy or firewall change, a new package version.
- Whether it affects every Robot, workspace or tenant, or only some.
- The impact: how many jobs, which processes, whether work is lost or only delayed.
Identifiers#
- Tenant and workspace names (or ids).
- Job ids, queue item ids and machine or Robot names involved.
- The
correlationIdfrom the error response or theX-Correlation-IDheader, with the time of the request. - Error catalog codes such as
VEL-AUTH-403-001if you saw one.
Diagnostics#
From the Orchestrator host:
BashCopyalias dc='docker compose -f docker-compose.core.yml'
dc ps > ps.txt
dc logs --since 1h api > api.log
curl -s http://127.0.0.1:8080/health/ready > ready.txt
From an affected Robot machine, in an elevated prompt, either create a support bundle (or use Collect diagnostics on the machine's Health panel in the Orchestrator):
PowerShellCopy& "$env:ProgramFiles\VeloPhex\Robot\VeloPhex.Robot.Service.exe" support-bundle --out robot-support.zip
or collect the files one by one:
PowerShellCopy$robot = "$env:ProgramFiles\VeloPhex\Robot\VeloPhex.Robot.Service.exe"
& $robot status > status.txt
Copy-Item "$env:ProgramData\VeloPhex\Robot\logs\robot-*.log" .
wevtutil qe Application /q:"*[System[Provider[@Name='VeloPhex Robot']]]" /f:text /c:200 /rd:true > eventlog.txt
Add the attempt journal entry for a failing job from %ProgramData%\VeloPhex\Robot\state\attempts\ and, if results never reached the Orchestrator, the contents of state\outbox\.
From Studio: the diagnostic log from %LOCALAPPDATA%\Velophex\Studio\Logs and, after a crash, the newest file in %LOCALAPPDATA%\Velophex\Studio\Dumps.
These files do not contain the Robot's credentials or enrollment keys. The protected store under %ProgramData%\VeloPhex\Robot\state\secrets\ does, and support never needs it. Do not send it.
For full locations, see Log locations.
Reporting a security vulnerability#
If you believe you have found a vulnerability in any VeloPhex component, email security@velophex.com. Include the affected component and version, the steps to reproduce, and the impact you observed. Do not include it in forum posts or regular support tickets, and give the team time to investigate and fix it before you disclose it publicly. See Responsible disclosure for the full policy.
Before you contact anyone#
A few checks solve many problems:
- Run
statuson the Robot and read theconnectivityand runtime lines. - Check
/health/readyon the Orchestrator. - Search the api log for the correlation id of the failing request.
- Read Common issues and the FAQ.
Next steps#
Choose the right channel
The community forum
Reporting a problem to support
What happened
Identifiers
Diagnostics
Reporting a security vulnerability
Before you contact anyone
Next steps