Install - Static Java Agent on Windows with no Admin Access

Installation Wizard

To help with the installation process, vFunction offers an Installation Wizard. This Wizard provides additional information about the Prerequisites as well as the Required and Optional Settings for installing the vFunction Server and Agents. This Wizard also walks you through each step in the Installation process.

Please contact support@vfunction.com or your vFunction Contact(s) for the password to start using this Wizard.

Installation Steps

Take the following steps to install the vFunction Java Static Agent (Viper) on a Windows Server with no Admin access:

  1. Ensure Prerequisites are met
  2. Download the vFunction Controller Windows Installation ZIP from the vFunction Portal
  3. Move the Controller ZIP package to the Windows Server
  4. Extract the ZIP to the desired directory, such as C:\vfunction\
  5. Retrieve the vFunction UI’s Application UUIDs:
  1. Log into the vFunction Server’s UI in a browser
  2. In the top-left corner, click the dropdown and select the relevant Application
  3. In the top-center menu bar, click the “Learning” tab
  4. On the left-side, click the “Select Controllers” link
  5. On the left-side, click the “Install Controller” link
  6. In the dialog box, find the YAML-formatted text box that contains the following details. You’ll need these details at a later stage below:
controller:
  name: {display name for this controller}
  host: $your_VF_Server_address
  org_id: 93af7f38-0000-0000-0000-bd9516798497
  app_id: 9fb228fc-0000-0000-0000-db8e83427e14
  client_id: caeadcd1-0000-0000-0000-9c9b37a9e119
  client_secret: 68cb85eb-0000-0000-0000-fb9e7f1d9240
  1. In Powershell, create the Static Java Agent instance:
# Replace REPLACE_BASE_DIR with the actual installation path
# Replace CHANGE_ME with the appropriate values using descriptions ...
# in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/windows as a guide

dir -Path "REPLACE_BASE_DIR" -Recurse | Unblock-File;
powershell -NoProfile -ExecutionPolicy unrestricted -Command "REPLACE_BASE_DIR\vfunction\controller-installation\create-instance.ps1 -instance viperinst -type java -viperMode true;
  1. Optional: In PowerShell, add Environment Variables for the vFunction Static Agent
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/windows
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_NAME','viper')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_HOST','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_SECRET','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES','CHANGE_ME')
[System.Environment]::SetEnvironmentVariable('VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS','-Xms300m -Xmx4g -Xss50m')
  1. Optional: Alternatively to Step #7, open the BASE_DIR\vfunction\config\installation\instances\viperinst\installation.yaml to set the same values instead of using Environment Variables
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/windows
controller:
  name: qa-windows1
  host: http://10.0.0.1
  org_id: 1111-11-11-1111
  app_id: 1111-11-11-1111
  client_id: 1111-11-11-1111
  client_secret: 1111-11-11-1111
  instace_id: qa-win1
  type: java
  tags:
#    - tag1

server_application:
#  name:
#  include_classes: com.
#  allowed_users:
#  new_user_default_password:

viper:
  jvm_memory_params: '-Xms300m -Xmx4g -Xss50m'
  archives:
    - C:\path\to\*.jar
    - C:\path\to\*.war
#    - C:\opt\<my-application>\**\*.jar
#    - C:\opt\<my-application>\**\*
  ### Supported only for Oracle databases!
  stored_procedure:
#    db_url:
#    db_user:
#    db_password:
  spring:
    custom_context_roots:
#      - path/to/custom-conf.xml
#      - another-custom-conf.xml
    root_bean_classes:
#      - a.b.c.Foo
#      - a.b.c.Bar
  1. In Powershell, run the installation script
# Replace REPLACE_BASE_DIR with the actual installation path

powershell -NoProfile -ExecutionPolicy unrestricted -Command "REPLACE_BASE_DIR\vfunction\controller-installation\install.ps1 -instance viperinst -runAsServices false"
  1. Confirm that the Static Java Agent comes up as expected in the vFunction Server UI
  2. If any issues arise:

Updated on 13 Aug 2026