Installation

Use this guide to install vScope on your chosen platform and verify that you can sign in. For a guided first discovery, follow the Quickstart.

Prerequisites

• Server meets system requirements: the recommended sizing is 4 vCPU, 16 GB for vScope within 24 GB total server RAM, and 120 GB SSD storage.
• Required ports are open internally.
• A vScope trial, or purchased license code.

Note

Manage your licenses in account.vscope.net

Steps

Windows (recommended)

1. Download: Windows installer
2. Run the installer
3. By default, vScope installs the required components in C:\Program Files\vScopeServer. The install folder can be changed during installation, but using the default location is recommended.
4. Finish; the vScope Server Service starts automatically.
5. If needed, manage via Windows Services (vScope Server Service).
6. Ensure firewall allows the UI port (default 80) and discovery ports.

---

Linux

Use a Debian/Ubuntu host compatible with the .deb package.

1. Download the package as vscope-server-amd64.deb, then install it:

   curl -fL -o vscope-server-amd64.deb https://dist.vscope.net/server/release/latest-amd64.deb
   sudo apt install ./vscope-server-amd64.deb

2. Edit /etc/default/vscopeserver. Set the existing JAVA_OPTS line to allocate a 16 GB maximum Java heap, preserving any other custom JVM options:

   JAVA_OPTS="$JAVA_OPTS -Xmx16g"

   This assumes the recommended 24 GB server, leaving headroom for the OS and the JVM memory outside the heap. See System Requirements for sizing details.

3. Restart the service to apply the memory setting:

   sudo service vscopeserver restart

4. Browse to http://<host>/ (default port 80), then complete the license and administrator steps below. Configure HTTPS separately if required.

Storage

Provide 120 GB of available SSD storage for /var/lib/vscopeserver/vscopedata. Keep this directory when upgrading; it contains the installation’s persistent data.

Change the web port

Set org.osgi.service.http.port=<port> in /etc/vscopeserver/config.ini, restart vscopeserver, and allow the selected port through the firewall. Open http://<host>:<port>/.

Docker

1. Create data volume:

docker volume create vscope-data

2. Run:

docker run -d \
  --name vscope-server \
  --pull always \
  --restart unless-stopped \
  --stop-timeout 330 \
  --memory 24g \
  -e JAVA_OPTS="-Xmx16g" \
  -p 8080:80 \
  -v vscope-data:/data \
  europe-docker.pkg.dev/isl-vscope/release/vscope:latest

--memory 24g caps what the container may use; -Xmx16g sets the maximum Java heap within that cap. The remaining headroom covers JVM memory outside the heap. Keep both values in step if you change either. See System Requirements for sizing details.

3. Browse to http://<host>:8080/.

Storage

Ensure the volume’s backing storage has 120 GB available. Mount persistent data at /data and keep the same volume when recreating or upgrading the container.

Change the web port

Change the host side of -p 8080:80 in the run command, then recreate the container with the same volume. For example, -p 8081:80 makes vScope available at http://<host>:8081/.

Check startup

Check that the container is running:

docker ps --filter name=vscope-server

If vScope does not open, see Troubleshoot a container installation.

Connect discovery proxies

If proxies connect from outside the Docker host, add -p 4445:4445 to the server’s docker run command and allow TCP 4445 through the host firewall. Configure each proxy with the Docker host’s reachable hostname or IP and port 4445, then approve it in vScope.

Kubernetes

You need kubectl access to a cluster with a default StorageClass that provisions ReadWriteOnce storage, an installed ingress controller, and a hostname you can configure in DNS. Nodes must be able to pull the image, and pods must be able to reach discovery targets. Linux containers cannot perform WMI discovery; use PowerShell/WinRM for Windows targets.

1. Choose an existing namespace. The examples use default; replace it throughout if needed. Check your storage classes:

   kubectl get storageclass

   A class should be marked (default). To select another class, add storageClassName: <your-storage-class> under the PVC’s spec below.

2. Save the following as vscope-server.yaml:

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: vscope-data
     namespace: default
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 120Gi
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: vscope-server
     namespace: default
   spec:
     replicas: 1
     strategy:
       type: Recreate
     selector:
       matchLabels:
         app: vscope-server
     template:
       metadata:
         labels:
           app: vscope-server
       spec:
         terminationGracePeriodSeconds: 330
         containers:
           - name: vscope-server
             image: europe-docker.pkg.dev/isl-vscope/release/vscope:latest
             imagePullPolicy: Always
             env:
               - name: JAVA_OPTS
                 value: "-Xmx16g"
             ports:
               - name: http
                 containerPort: 80
                 protocol: TCP
               - name: proxy
                 containerPort: 4445
                 protocol: TCP
             resources:
               requests:
                 cpu: "4"
                 memory: 24Gi
               limits:
                 memory: 24Gi
             volumeMounts:
               - name: data
                 mountPath: /data
         volumes:
           - name: data
             persistentVolumeClaim:
               claimName: vscope-data
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: vscope-server
     namespace: default
   spec:
     type: ClusterIP
     selector:
       app: vscope-server
     ports:
       - name: http
         port: 80
         targetPort: http
         protocol: TCP
       - name: proxy
         port: 4445
         targetPort: proxy
         protocol: TCP

   Keep one replica and Recreate. Reuse the PVC when upgrading. For sizing, see System Requirements.

3. Apply the manifest and wait for startup:

   kubectl apply -f vscope-server.yaml
   kubectl -n default rollout status deployment/vscope-server --timeout=600s
   kubectl -n default get pvc vscope-data

   Expect a running pod and a PVC with status Bound.

4. Configure the Ingress. Save the following as vscope-ingress.yaml. Replace YOUR-INGRESS-CLASS with your ingress class and vscope.example.com with your hostname. Configure DNS to resolve that hostname to the ingress controller’s address.

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: vscope-server
     namespace: default
   spec:
     ingressClassName: YOUR-INGRESS-CLASS
     rules:
       - host: vscope.example.com
         http:
           paths:
             - path: /
               pathType: Prefix
               backend:
                 service:
                   name: vscope-server
                   port:
                     number: 80

   kubectl apply -f vscope-ingress.yaml
   kubectl -n default get ingress vscope-server

5. Open http://vscope.example.com/ using your chosen hostname, then complete the license and administrator steps below. The example configures HTTP; configure TLS with your ingress controller and certificate provider to serve HTTPS.

Change the web address or port

Update the hostname in the Ingress manifest and DNS, then reapply the manifest. External listener ports are configured on your ingress controller.

Connect discovery proxies

The Service exposes TCP 4445 for proxies inside the cluster. In the same namespace, set the proxy’s master hostname to vscope-server and port to 4445. From another namespace, use vscope-server.<server-namespace> (for example, vscope-server.default). Follow Install the proxy, then approve it in vScope.

Proxies outside the cluster

For proxies outside the cluster, expose TCP 4445 through your cluster’s TCP networking configuration and use that reachable address. The HTTP Ingress above routes only web traffic.

Check startup

If startup fails or vScope does not open, see Troubleshoot a container installation for log and event commands.

Register license

• Provide your license code (from account manager or account portal).
• Offline? Upload a license file: see Register License.

Create setup admin account

• Create the first administrator (for setup/recovery). Use SSO/AD later for regular users.

Sign in

• Open the vScope URL from your installation tab, using your chosen port or Ingress hostname.
• Sign in with the setup admin to complete installation.

Validate installation

• Sign in is successful.
• Go to Discovery; the page should load with empty credentials/targets.
• Open Settings → About and verify license/edition is shown.

Troubleshooting

• Internet Connectivity Issues? Recheck Ports used by vScope.
• Could not start the service? Check that the configured ports are available and review the startup checks in your installation tab.

Next steps

• Secure access/transport: set up SSO/IDP, Directory integration, HTTPS, and Email server.
  • Single Sign-On
  • Directory integration
  • HTTPS
  • Email server
• Then start collecting data: Add your first data source.