Skip to main content

Install in OpenVSCode Server

OpenVSCode Server is Gitpod's browser-based VS Code distribution. VSIX installation is required.

Prerequisites​

  • OpenVSCode Server running and accessible
  • Access to upload files to the server

Download the Extension​

Download the VSIX file:

Download SF Veritas VSIX from Open VSX

Transfer to your server:

scp sf-veritas-extension-x.x.x.vsix user@server:/home/user/

Installation Steps​

Method 1: Browser UI​

  1. Open OpenVSCode Server in your browser
  2. Open the Extensions view (Ctrl+Shift+X)
  3. Click the ... (More Actions) menu
  4. Select "Install from VSIX..."
  5. Navigate to and select the uploaded VSIX file
  6. Reload when prompted

Method 2: Command Line​

If you have terminal access:

openvscode-server --install-extension /path/to/sf-veritas-extension-x.x.x.vsix

Verify Installation​

  1. Refresh the browser
  2. Look for the SF Veritas icon in the Activity Bar
  3. Open the Command Palette (Ctrl+Shift+P)
  4. Verify "SF Veritas" commands are available

Configuration​

Remote Server Considerations​

Since OpenVSCode Server runs remotely:

  1. The local telemetry server runs on the remote machine
  2. Instrumented applications should send telemetry to the remote server's address
  3. Default port 6776 must be accessible on the remote machine

Settings​

Configure via Settings (Ctrl+,):

{
  "sfVeritas.localMode": true,
  "sfVeritas.autoStartServer": true,
  "sfVeritas.localServerPort": 6776
}

Troubleshooting​

Extension fails to load​

  1. Check browser console for JavaScript errors
  2. Verify the VSIX file uploaded completely
  3. Try clearing browser cache and reloading

Cannot connect instrumented applications​

When your application runs on a different machine:

  1. Configure the application to send telemetry to the OpenVSCode Server host
  2. Ensure firewall allows connections on port 6776

Next Steps​