register-as-spotfire-community-client

register-as-spotfire-community-client
[-c value | --configuration=value]
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
{-Cvalue}
[-p value | --public-address=value]

Overview

Use this command to register the Spotfire Server as a Spotfire Community (OAuth2) API client. This will make it possible to access add-ons and demos available on the Spotfire community.

Options


Option	Optional or Required	Default Value	Description
`-c value --configuration=value`	Optional	configuration.xml	The path to the server configuration file.
`-b value --bootstrap-config=value`	Optional	none	The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
`-t value --tool-password=value`	Optional	none	The configuration tool password used to decrypt the database password in the bootstrap.xml file. If the tool password is omitted, the command might prompt the end user for it on the console. See Bootstrap.xml file for more information. This argument will be ignored if `--public-address` has been specified.
`-Cvalue`	Optional	none	The email address of a contact person, to be included in the registration request. This argument can be specified multiple times with different values.
`-p value --public-address=value`	Optional	The configured public address.	The public address of the Spotfire Server. See the set-public-address command for more information.

Examples

Register using the currently configured public address (retrieved from the database):

register-as-spotfire-community-client --tool-password=secret -Cadministrator@example.com

Register using a provided public address:

register-as-spotfire-community-client -Cadministrator@example.com --public-address=https://spotfire.example.com/