Environment Settings

Environment Settings

Environment variables

This page lists some of the configuration settings available through environment variables. 

How to set?

Docker

Environment variables can be set in the shell where you start the Crosser node, in the docker-compose.yml file or in a separate file referenced from docker-compose.yml, e.g edgenode.env.

Windows

On Windows you need to set the environment variables from PowerShell, before starting the Crosser service:

$env:some_variable = some_value

Available environment variables

Security

See Node Installation for information on when to set each setting.

Variable

Value

Description

SecurityConfiguration__Registration__Key

Key from cloud.crosser.io

The global registration key created at cloud.crosser.io.

SecurityConfiguration__Registration__Name

Unique Node name

A unique name to use when registering the Node. Not needed if auto-generated names are configured in Crosser Cloud.

SecurityConfiguration__Credentials__NodeId

ID from cloud.crosser.io

ID to use when registering a single Node. (set by the installer on Windows)

SecurityConfiguration__Credentials__AccessKey

Key from cloud.crosser.io

Key to use when registering a single Node. (set by the installer on Windows)

EdgeNodeConfiguration__RestApi__AllowKillHostFromApi

false or (true)

If true the host can be terminated through the node API or web UI.

EdgeNodeConfiguration__RestApi__AllowKillProcessFromApi

false or (true)

If true flows can be terminated through the node API or web UI.

EdgeNodeConfiguration__RestApi__AllowKillRemoteSessionProcessFromApi

false or (true)

If true remote sessions can be terminated through the node API or web UI.

General

Variable

Default

Description

EdgeNodeConfiguration__LogLevel

Information

The level to use when logging to the local log file (Verbose, Debug, Information, Warning, Error, Fatal).

EdgeNodeConfiguration__ReportStatusIntervalInSeconds

10

The interval in seconds to report Node status to cloud.crosser.io.

EndpointsConfiguration__RemoteSessionTransport

Automatic

When setting up a remote session the node will try with a websocket connection. If that fails it will try a regular HTTP (long polling) connection. Set to HTTP to disable websocket attempts.

Proxy settings: Nodes version 2.6+

Variable

Value

Description

http_proxy

user:pw@IPorHost:port

Connectivity details for HTTP proxy. User and password only needed if required by the proxy server.

https_proxy

user:pw@IPorHost:port

Connectivity details for HTTPS proxy. User and password only needed if required by the proxy server.

Example edgenode.env with proxy settings:

# Proxy Section

https_proxy=user:pw@192.168.102.10:1234

Proxy settings: Nodes version < 2.6

Variable

Value

Description

https_proxy

IPorHost:port

IP/host and port to the HTTPS proxy.

https_user

user

User to connect with (if required by the proxy server).

https_password

password

Password to connect with (if required by the proxy server).

https_proxy_certificate

certificate.cer

Name of certificate to use (located in data/certificates on the node).

http_proxy

IPorHost:port

IP/host and port to the HTTP proxy.

http_user

user

User to connect with (if required by the proxy server).

http_password

password

Password to connect with (if required by the proxy server).

Example edgenode.env with proxy settings:

# Proxy Section

https_proxy=192.168.102.10:1234

https_user=user

https_password=password

https_proxy_certificate=certificate.cer


    • Related Articles

    • Crosser Node as Azure Container App

      Introduction Beside running the Crosser Node on a stand-alone Docker setup, or using a container orchestration system like Kubernetes/OpenShift, you can also run the Node as an Azure Container App in your Azure infrastructure. This gives you the ...
    • Node Installation

      The first step when installing a local edge Node is to register the Node in Crosser Cloud to get the credentials. This is covered in the In Crosser Cloud section below. There are two options for installing a Crosser Node on a local server: using a ...
    • Integration to Azure Event Grid

      Introduction Microsoft announced integration to Azure Event Grid via native MQTT v3.1.1 and v5 as a preview. With this option, you will be able to communicate with your Azure Event Grid directly without the need to go through the Azure IoT Hub. In ...
    • Module Updates

      This document contains a history of module updates in Crosser Control Center. 2024–04-30 Updates Modbus Reader [7.1.1] - In 7.1.0 a bug was introduced that caused the module to not reconnect when the connection was lost. This has now been fixed. S7 ...
    • Crosser Node 2.6.0

      Release Note Release date: 2023-06-29 Note: A critical bug was found in 2.6.0 and is now deprecated, use 2.6.1 instead. New features Retry on all modules Each module now has settings for Retry (Common Settings). When the Max Number Of Retries setting ...