C Instant Messaging Server Configuration Script

This appendix provides information about the Oracle Communications Instant Messaging Server configuration script.

configure Script

The configure script enables you to perform an initial configuration of your Instant Messaging Server deployment. Table C-1 describes the configure options. The statefile can be a simple text file with plaintext passwords, a text file with encrypted passwords, or a zip file, which contains the text of the state file and the decryption keys.

Table C-1 configure Options

Option Description

--nodisplay

Required if the --silent option is not used. Optional if the --silent option is used. Use this option to configure Instant Messaging Server in command-line mode.

--help

Optional. Displays the help content for this command.

--verbose

Optional. Prints information messages to the standard output.

--savestate statefile

Optional. Should be used with the --nodisplay option. If you use this option, the inputs that you provide during configuration are saved in the state file. Specify the name and location of the state file along with this option. Your responses are stored as a list of parameters in the state file. Each parameter represents a single entry or field value.

--silent statefile

Required if the --nodisplay option is not used. Use this option to run the configure script in the silent mode. Specify the name and path of the state file with this option. If you are configuring Instant Messaging Server by using a state file, you are not prompted to specify the configuration information. Instead, the values from the state file are used to configure the server.

--state statefile

Optional. During configuration, the configure script provides default values for configuration. You can either use the default values or specify your own value. If you use this option, the configure script uses all the default values for configuration.

--no

Optional. Use this option to perform a dry run of the configuration.

--novalidate

Optional. If you use this option, the configure script does not validate the inputs that you provide during configuration.

--debug

Optional. Use this option to view the debug messages on your terminal.

--key

Optional. Use this option only when in a text-based state file, you have changed passwords byusing the imconfutil generate-password command. In that case, the command to be is configure --silent /tmp/saved-state-file --key /tmp/mykey.txt --nodisplay.


Note:

The configure script ignores any incorrect or invalid command-line options and proceeds with the configuration process by using the valid options.

Using the --key Option to Perform a Silent Configuration

To perform a silent configuration by using the --key option:

  1. Generate the key using imconfutil generate-key command, and direct the output to a key file:

    imconfutil generate-key > /tmp/mykey.txt
    
  2. Generate the encrypted passwords by using the generate-password command, giving the mandatory location of the generated key file:

    imconfutil generate-password -k /tmp/mykey.txt your-plaintext-password
    
  3. Change the password in the state file, either manually or though a script.

  4. Run the configure command, specifying the location of the key file:

    configure --silent /tmp/saved-state-file --key /tmp/mykey.txt --nodisplay --verbose --debug
    

    Use the generate-password command to encrypt plaintext passwords in the state file. If password encryption is not required, use the state file with plaintext keys, without specifying the --key option:

    configure --silent /tmp/delete/config/saved-state-file-plaintext --nodisplay --verbose --debug
    

    For more information on the generate-password command, see the imconfutil command reference in the Instant Messaging Server System Administrator's Guide.