Skip to content
vScope Support Page

Configure HTTPS

Use this guide to configure HTTPS for vScope.

Choose setup method

Section titled “Choose setup method”
  • Method A (recommended): terminate HTTPS in a reverse proxy or load balancer.
  • Method B: enable HTTPS directly in vScope using a certificate keystore.

Method A: Set up HTTPS via reverse proxy

Section titled “Method A: Set up HTTPS via reverse proxy”

Use your existing reverse proxy or load balancer to handle HTTPS connections and proxy traffic to the vScope server over HTTP.

Configure the reverse proxy

Section titled “Configure the reverse proxy”

You can use any third-party reverse proxy. Refer to your proxy’s documentation for production hardening. The examples below are starting points.

Basic example configuration to help you get started with NGINX. Be sure to read NGINX Reverse Proxy for proper guidance and additional information.

server {
   listen 443 ssl;
   server_name vscope.example.tld;


   ssl_certificate /path/to/fullchain.pem;
   ssl_certificate_key /path/to/key.pem;


   location / {
      proxy_set_header Host $host;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header X-Forwarded-Proto $scheme;


      proxy_pass http://vscope:80/;
   }
}

Other common reverse proxies

Section titled “Other common reverse proxies”

Update Base URL in vScope

Section titled “Update Base URL in vScope”

Open vScope in your browser and navigate to Settings > Network.

Update Base URL to the address end users will use to access vScope. Include https:// (for example https://vscope.example.tld).

Method B: Set up HTTPS directly in vScope

Section titled “Method B: Set up HTTPS directly in vScope”

If you do not use a reverse proxy, configure HTTPS directly in vScope by uploading a certificate keystore.

Generate a self-signed certificate with OpenSSL

Section titled “Generate a self-signed certificate with OpenSSL”

If you already have a certificate you can skip ahead to Configure vScope.

While it is recommended to use a publicly trusted certificate, vScope can be used with a self-signed certificate.

Generate self-signed certificate
openssl req -x509 -newkey rsa:4096 -sha256 -days 3650 -nodes -keyout key.pem -out cert.pem -subj '/CN=vscope.example.tld' -addext 'subjectAltName=DNS:vscope.example.tld'
openssl pkcs12 -export -inkey key.pem -in cert.pem -name vscope -out keystore.p12

The first command will generate a key and certificate valid for 10 years (3650 days) and for the domain vscope.example.tld. If you use these commands, replace the domain with your actual domain.

The second command will ask you to set a password and package both the key and certificate as a PKCS#12 file keystore.p12. This is the file you will upload to vScope.

Due to how OpenSSL works, both the key and the keystore will be password protected with the password you entered.

Configure vScope

Section titled “Configure vScope”

  1. Enable HTTPS
    In vScope, navigate to Settings > Network and enable HTTPS.

  2. Upload the certificate

    Upload the certificate on the right-hand side by clicking Upload and selecting it from your file system.

  3. Configure the HTTPS port
    Enter the port vScope will use to accept HTTPS connections. The default port is 443 and we recommend you leave it unchanged unless necessary.

  4. Configure passwords
    Both the keystore and the key inside can be password protected. Enter the password(s) into the respective text field.

    It is not unusual for both to be password protected with the same password. If you generated a self-signed certificate with the instructions above, this will be the case.

  5. Configure alias
    If your keystore only contains one certificate then you can leave this empty and vScope will find and use it.

    If you have multiple certificates in the keystore then enter the alias of the certificate that vScope should use into the text field.

  6. Save the configuration
    Click Save to apply your configuration.

  7. Restart Wait for the web service to restart, 30-60s. Then login again.

  8. Update Base URL In Settings > Network, confirm Base URL uses https:// and the expected URL for vScope (eg. https://vscope.company.com). If necessary, update and save the Base URL, and restart the vScope web service to apply the changes.

Final verification (both methods)

Section titled “Final verification (both methods)”
  • Open the vScope web UI using https://.
  • Confirm the certificate is accepted by your browser.

If HTTPS configuration fails or the server becomes inaccessible after enabling HTTPS, see Troubleshoot HTTPS configuration in vScope.