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 Workflow
- Ensure Prerequisites are met
- Download the vFunction Windows Controller Installation ZIP
- RDP to the Windows Server as the user who will run the vFunction Viper process
- Move the Installation ZIP to the location on the Windows Server where vFunction should run
- Extract the vFunction Installation Package
### Replace VERSION with the actual value
tar -xvzf vfunction-controller-sudo-less-installation.vVERSION.tgz
- Create the Viper vFunction instance
### Replace the BASE_DIR with the actual value, such as /tmp/
bash BASE_DIR/vfunction/opt/vfunction/controller-installation/create-instance.sh -i viperinst -t java -v
- Add Environment Variables for the vFunction Static Agent
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#controller_name
export VF_CONTROLLER_VIPERINST_CONTROLLER_NAME="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#controller_host
export VF_CONTROLLER_VIPERINST_CONTROLLER_HOST="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#controller_org_id
export VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CIENT_SECRET="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#instance_id
export VF_CONTROLLER_VIPERINST_CONTROLLER_INSTANCE_ID="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#controller_tags
export VF_CONTROLLER_VIPERINST_CONTROLLER_TAGS="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#jvm_memory_params
export VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS="CHANGE_ME"
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux/#viper_archives
export VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES="CHANGE_ME"
- Run the installation script
### Replace the BASE_DIR with the actual value, such as /tmp/
bash BASE_DIR/vfunction/opt/vfunction/controller-installation/install.sh -i viperinst
- Confirm that the Viper comes up as expected in the vFunction Server UI
dir -Path "REPLACE_BASE_DIR" -Recurse | Unblock-File
- In Powershell, run the installation script. Replace the INSTANCE_NAME and REPLACE_BASE_DIR with the actual values.
powershell -NoProfile -ExecutionPolicy unrestricted -Command "REPLACE_BASE_DIR\vfunction\controller-installation\install.ps1 -instance INSTANCE_NAME -runAsServices false -viperMode true"
- Configure the JVM Startup Parameters for the vFunction Agent
- Restart the Application
Optional flags that can be used in the install.ps1 script
| Flag | Purpose |
|---|---|
| -instance | Used to input the Instance Name as a String following the flag |
| -serverUsername | Used to input the server-installation.yaml’s server.admin.email address to create the vFunction App in the Server UI from the Controller |
| -serverPassword | Used to input the server-installation.yaml’s server.admin.password to create the vFunction App in the Server UI from the Controller |
| -agentMode | Used when installing the vFunction Agent but not Viper |
| -viperMode | Used when installing Viper but not the vFunction Agent |
| -scriptMode | Used to run the installation in script mode so that all no user prompts are displayed and console output is minimized |
| -runAsServices | Used to define whether the installation should run in Admin-mode (Services true) or User-mode (Services false) |