Web Client configuration files - Amazon DCV Access Console
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Web Client configuration files

The Web Client configuration has two configuration files (/etc/dcv-access-console-webclient/access-console-webclient.properties and /etc/dcv-access-console-webclient/access-console-webclient-secrets.properties) that include parameters that can be configured to customize the Amazon DCV Access Console functionality connecting to different components.

Note

The property files contains sensitive data. By default, its write access is restricted to root and its read access is restricted to root and to the user running the Web Client. By default, this is the dcvaccessconsole user.

The following tables list the parameters in the Web Client configuration files.

For the /etc/dcv-access-console-webclient/access-console-webclient.properties configuration:

Parameter name Required Default Value Description

server-port

Yes

8080

Specifies the port to which the Handler listens

web-client-url

Yes

Specifies the url of the Web Client. It should be of the format https://webclient-host:webclient-port.

client-to-broker-connector-url

Yes

Specifies the url of the Broker. It should be of the format https://broker-host:client-to-broker-connector-https-port.

web-client-url

Yes

Specifies the url of the Web Client. It should be of the format https://webclient-host:webclient-port.

enable-connection-gateway

No

Enables the use of connection gateway to connect to the Amazon DCV server.

extra-ca-certs

No

Specifies the path to a well known CA certificates in PEM format.

For the /etc/dcv-access-console-webclient/access-console-webclient-secrets.properties configuration:

Parameter name Required Default Value Description

auth-server-client-id

Yes

dcv-access-console-web-client

Specifies the client id for the Web Client. It should be the same in the Authentication Server properties.

auth-server-client-secret

Yes

Specifies the secret for the Web Client. It should be the same in the Authentication Server properties.

cookie-secret

Yes

Specifies a random string used to sign/encrypt cookies and JWT.