Init-config utility

The init-config utility initializes the system for use by Messaging Server and generates an initial product configuration.

Syntax
init-config &#x5b;switches&#x5d;

Restrictions
Must have superuser privileges in order to use this utility. This is implemented as a Perl script, so a reasonably modern version of Perl must be installed on the system to run this. It is more convenient to use this tool if an LDAP server has been installed previously and the  tool has been used to initialize the LDAP server.

Parameters
None.

Description
The  tool prepares a system for use by Messaging Server and generates an initial configuration for the product. It can be run in an interactive mode or in a silent mode (when a state file is provided). By default, the initial configuration generated is designed for product evaluation purposes and enables the primary product services (MTA & Message Store) including a number of common channels and mappings. Alternatively, the tool can be used to generate a limited configuration appropriate as a starting point for a deployment by using the  (or  ) switch with a list of initial config recipes (this is new in Messaging Server 8.1). Note that in initial config recipe mode, statefile variables are limited to 1024 characters in length.

The following list summarizes the functions performed by init-config:



 Creates the Unix user and group for Messaging Server, if needed. 

 If in evaluation or  mode, it creates LDAP server entries (or LDIF) for the default domain, administrative user and postmaster, along with access control lists. 

 If in evaluation or  mode, it creates Directory Server entries (or LDIF) for an administrative group and user for the host where configure is run; this administrative group and user have limited write access to the directory. If in  mode, this account must already exist and be provided by prompt or state file. 

 Creates DataRoot and ConfigRoot directories with correct permissions. 

 Creates subdirectories of the DataRoot and ConfigRoot directories with correct permissions. 

 Generates a random secret for authentication to local-only services, such as the job_controller and watcher. 

 Prompts you with the minimum number of questions about your environment to create an initial Messaging Server configuration with correct permissions. 

 Attempts to disable mail servers that come with the operating system, for example, Postfix and Sendmail. </li>

 Prior to MS 8.0.2: runs the imsimta chbuild command to compile character set conversion tables. Starting with MS 8.0.2 a compiled table is bundled in the install package and used unless the customer overrides. </li>

 Creates convenience symlinks from the install directory to the DataRoot, ConfigRoot, and log directories. Prior to MS 8.0.2, these symlinks were required for correct product functionality. </li>

</ol>

The following table describes the state file variables used by init-config. State file variables starting with an "ic" prefix are ignored if unrecognized; other state file variables will generate a warning if unrecognized.

Configure use of the Cassandra Message Store rather than classic Message Store.

Specifies an alternate location for the data root directory where read/write product configuration and operational data will be stored. The default location for the data root directory is   where   is the installation directory. Use of a non-default   is not recommended.

Requests additional debugging information while generating initial configuration; this primarily impacts LDAP operations.

Display command usage summary.

Ignore the presence of Sendmail or Postfix on the system. By default, the initial configuration tool attempts to avoid port conflicts by disabling Sendmail or Postfix if those tools are enabled.

Use a non-default LDAP port to communicate with the LDAP server.

Treat the LDAP directory as read-only and generate an LDIF file in a DataRoot/install/configure.ldif file for any desired changes to the directory. The administrator must apply the LDIF file to the directory after initial configuration but before starting the Messaging Server product. This is helpful if the person doing the Messaging Server installation does not have directory administrative rights.

Displays the available initial configuration recipes and exits.

Create a full evaluation installation without an LDAP server present. This is used in combination with the statefile and   switches to configure Messaging Server when the LDAP server is not available at the time initial configuration is generated. Normally the answers provided to  questions are read from the LDAP server by this tool; but when this switch is used, those values should be provided in the state file. Note that it&#x27;s possible to both configure and use a routing-only MTA without LDAP; use of the  switch (new in Messaging Server 8.1) is the recommended way of doing that.

Skip most validation of user input and state file variables. This may result in a non-functional configuration. This is provided primarily as a mechanism to work around possible bugs in the init-config tool&#x27;s validation logic.

Generate an initial legacy configuration rather than an initial Unified Configuration (XML based). This option is not supported starting with Messaging Server 8.0.2, and no longer works starting with Messaging Server 8.1.

When initializing the LDAP server for use by Messaging Server, this prevents certain critical attributes from being overwritten with different values, even if new values are provided. See the installation guide for a more in-depth discussion of critical LDAP attributes.

,
Suppress most non-error console output (a logfile is still created containing necessary information to diagnose issues).

,
Generate a minimal configuration for a particular deployment function as determined by a list of initial configuration recipes. LDAP will not be involved unless   or   is included  in the recipe list.

Specifies the location to save a state file. The default location is DataRoot.

Require SSL when communicating with the LDAP server. Any necessary SSL certificates and configuration must be manually set up prior to using this option.

Use a silent installation file and do not prompt the administrator for information.

,
Displays the product version and exits.

Force use of Unified Configuration, even if the statefile specifies use of legacy configuration. Starting with Messaging Server 8.1, this is the default behavior so this switch has no effect.

Examples
To configure an evaluation installation of Messaging Server when an LDAP server is present (interactive). To initialize LDAP server and configure the first classic Message Store in a multi-system deployment (interactive). To configure an additional classic Message Store in a multi-system deployment (interactive). To add an MTA with submission service to a Messaging Server multi-system deployment (interactive). To add an MMP and/or mshttpd service to a Messaging Server multi-system deployment (interactive). To configurate a routing-only MTA without LDAP (interactive). To configurate using a state file (non-interactive). To list available initial configuration recipes. Available Initial Configuration Recipes: ldapinit       Initialize LDAP directory for use by Messaging Server lmtpserver     LMTP server (used by initial configuration) mta            Configure an MTA (used by initial configuration) none           Minimal configuration with external services disabled proxy          Proxy configuration (MMP, Convergence mshttpd) store          Configure a message store (used by initial configuration) submit         Add submission service to an MTA (initial configuration) useldap        Enable support for LDAP users (doesn&#x27;t initialize LDAP)
 * 1) init-config
 * 1) init-config -r ldapinit,store,lmtpserver
 * 1) init-config -r useldap,store,lmtpserver
 * 1) init-config -r useldap,mta,submit
 * 1) init-config -r useldap,proxy
 * 1) init-config -r mta
 * 1) init-config --state=/path/to/statefile
 * 1) init-config --list-recipes

See also:
 * Messaging Server command line utilities
 * configure_utility
 * msconfig utility
 * start-msg utility