Skip to content

Available as beta

LocalProxy

This is a service which acts as a proxy between NerdVision clients and NerdVision servers. It also allows for the proxied data to be stored locally or in the users cloud.

The LocalProxy is currently in Beta, to get an API-Key for the LocalProxy service, contact us at support@nerd.vision.

Security

The LocalProxy service is intended to be used behind a secure network. This version has no UI or client validation meaning that if used on the open internet, there is potential for anybody to send/receive data from the proxy.

For the LocalProxy to work correctly, both the clients and the NerdVision UI need to be accessed from the same network as the proxy.

We are actively working on adding client and UI auth. The current version is safe to be used behind a secure network.

To use the LocalProxy you will need to set up TLS by providing cert files to the LocalProxy service or running the LocalProxy behind a reverse proxy.

Getting started

For storage specific information, refer to the following pages:

To get started you need to run the LocalProxy service and configure the NerdVision client to send requests through the LocalProxy service.

The LocalProxy is available on DockerHub. You can run the LocalProxy service by executing:

docker run -p 8080:8080 -e LOCAL_PROXY_STORAGE_PROVIDER=<provider> -e AWS_REGION=<aws_region> -e AWS_ACCESS_KEY_ID=<access_key_id> -e AWS_SECRET_ACCESS_KEY=<secret_access_key> -e LOCAL_PROXY_TOKEN=<token> -e LOCAL_PROXY_CALLBACK_URL=<callkback_url> nerdvision/localproxy

drawing Node.js

The Node.js client can be configured to send snapshots to the LocalProxy as shown here:

nerdvision.start({
    api_key: '<YOUR_API_KEY>',
    event_snapshot_url: '<YOUR_LOCAL_PROXY_URL>', # E.g. https://api.example.com:8080
    event_snapshot_api: '/localproxy/v1/context/eventsnapshot'
}, false);

drawing Python

The Python client can be configured to send snapshots to the LocalProxy as shown here:

nerdvision.start(api_key="<YOUR_API_KEY>",
                 agent_settings={
                     'event_snapshot_url': "<YOUR_LOCAL_PROXY_URL>", # E.g. https://api.example.com:8080
                     'event_snapshot_api': "localproxy/v1/context/"
                 })

drawing Java

The Java client can be configured to send snapshots to the LocalProxy as shown here:

-javaagent:/full/path/to/nerdvision.jar=api.key=<YOUR_API_KEY>,event.snapshot.url=<YOUR_LOCAL_PROXY_URL>,event.snapshot.api=/localproxy/v1/context
E.g.
-javaagent:nerdvision.jar=api.key=nv-abc,event.snapshot.url=https://api.example.com:8080,event.snapshot.api=/localproxy/v1/context

drawing .NET

The .Net client can be configured to send snapshots to the LocalProxy by setting the following environment variables:

Name Value Description
NV_EVENT_SNAPSHOT_URL <YOUR_LOCAL_PROXY_URL> (e.g https://api.example.com:8080) The URL to the LocalProxy.
NV_EVENT_SNAPSHOT_API /localproxy/v1/context/eventsnapshot The path to use when uploading snapshots.