DSN

DSNs are similar to URLs, and are used to describe where AWTS modules are hosted and can be connected to, they have two, three or four parts, of the form [key@]host[:port[:tls]].

Using the Configurator to generate an environment configuration will provide you with the correct DSNs to use to access your installation, as well as correctly configuring all your selected AWTS modules to be able to communicate with each other.

Parts

  • key - an optional authentication key/token
  • host - hostname or IP address to connect to
  • port - port to connect to
  • tls - whether TLS should be enabled to encrypt the connection

TLS

The TLS portion can be tls, tlsi or none, which means:

  • tls - make an encrypted connection using TLS, and verify the server certificate. This is the default if the port is 443
  • tlsi - make an encrypted connection using TLS, but do not verify the certificate. Use this if TLS is enabled on your installation but you are using self-signed certs.
  • none - make a plaintext connection

For plaintext connections, H2C is supported by all AWTS modules for HTTP/2 and gRPC support.

Examples

  • localhost:35000 - connect to port 35000 on localhost with a plaintext connection
  • awtsserver:443 - connect to the server with hostname awtsserver on port 443, with TLS enabled
  • XXXX@awtsserver:1234:tlsi - connect to the server with hostname awtsserver on port 1234, with TLS enabled (but no certificate validation; self-signed certs are ok), and use API key XXXX