Quickstart

Let’s start discovering and exploring assets.

Prerequisites

• Server that meets system requirements. Recommended: 4 vCPU, 16 GB for vScope within 24 GB total server RAM, and 120 GB SSD storage.
• Firewall allows required ports for your selected data sources.
• Credential(s) for your first source(s) (eg. AD, Azure, VMware) with sufficient permissions.

Install vScope

Detailed Installation Need more install detail or troubleshooting? See the full guide.

Windows (recommended)

1. Download & Run: Windows installer
2. Browse to the host URL (default port 80) to start the setup flow.

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

1. Follow the Kubernetes tab in the installation guide to create persistent storage, a Deployment, a Service, and an Ingress. You need an installed ingress controller and a hostname you can configure in DNS. The example uses a 16 GB Java heap, 24 GiB pod memory, 4 CPU cores, and a 120 GiB volume.
2. Open vScope at your configured Ingress hostname.
3. Return here and continue with Setup vScope.

Setup vScope

License required

You will need either a trial license key or a paid license key to use vScope. Request Trial

1. Register the installation using your License activation code. Offline? Upload a license file following: Manually registering an offline installation.
2. Create a first administrator. You will use this account to later configure SSO and your organization’s IDP.

Add a data source

Here is how you add some of the most popular data sources.

Active Directory

1. Go to Discovery → Credentials → Add → Active Directory.
2. Enter a domain read account, add a DC hostname/IP as target.
3. Click Test → expect OK.

Azure

1. Use an app registration with Graph app perms (+ Reader on scope if needed).
2. Discovery → Credentials → Add → Azure; paste tenant/app/secret.
3. Click Test → expect OK.

VMware vCenter

1. Discovery → Credentials → Add → VMware.
2. Enter vCenter URL + read account; set the vCenter as target.
3. Click Test → expect OK.

Explore more data sources Choose what to discover in your environment.

Proxies for closed networks

Deploy a vScope Discovery Proxy and connect it to the main vScope to scan remote/segmented networks. Learn more

Run discovery

1. Go to Discovery → Summary.
2. Click Start Discovery.
3. You should see assets being added to your asset repository, automatically categorized with correct asset type.

Empty results?

Check credential status (must be OK) in Discovery results.

Verify assets in a table

1. Go to Tables → Create Table → pick your asset type (e.g., All Machines, File Systems, Applications, VMs, Users).
2. Add 3–5 columns: Hostname, OS, Last found date, CPU, Email etc..

---

Done! You have successfully installed vScope’s asset discovery! In the next step, let’s look what’s left for a complete setup.