Preparing input parameters through system environment variables

As an alternative to using a JSON file, you can use system environment variables to provide input parameters for one-touch Domino setup.

About this task

If you run Domino on Docker, you define the system environment variables for Docker to export in a text file specified by the --env-file parameter. If you do not run Domino on Docker, after you install Domino, you use a shell script or batch file or run individual commands to export the system environment variables needed to set up your server. The syntax for the export command varies but an example using the bash shell on Linux is:
export SERVERSETUP_SERVER_TYPE=additional
The names of the system environment variables are similar to the parameter names specified in a JSON file, with the following exceptions:
  • On platforms where names are case-sensitive, for example UNIX, you must specify system environment variables names in uppercase.
  • Whereas the JSON input is hierarchical in nature, environment variables are in a "flat" or global namespace. Therefore, you form the names by inserting an underscore between names to indicate hierarchy. For example, A JSON input file might provide the following data:
    "serverSetup": {
    		"server": {
    			"type": "additional",
    			"name": "mailserver1",
    			"domainName": "Renovations",
    			"title": "Renovations Mail Server"
    		},
    
    
    The corresponding system environment variables defined in an --env-file specified to Docker would be as follows:
    Note: When using --env-file, do not put the values in quotes.
    SERVERSETUP_SERVER_TYPE=additional
    SERVERSETUP_SERVER_NAME=mailserver1
    SERVERSETUP_SERVER_DOMAINNAME=Renovations
    SERVERSETUP_SERVER_TITLE=Renovations Mail Server
    The corresponding system environment variables defined in a UNIX bash shell script would be as follows. You invoke the shell script within the same shell that invokes one-touch Domino Setup. In this case, only values that contain spaces require quotes; using quotes for other values is optional. The quotes are stripped from the values when the script runs.
    export SERVERSETUP_SERVER_TYPE=additional
    export SERVERSETUP_SERVER_NAME=mailserver1
    export SERVERSETUP_SERVER_DOMAINNAME=Renovations
    export SERVERSETUP_SERVER_TITLE="Renovations Mail Server"
The following two tables describe the supported system environment variables for server setup and for the ID vault.
  • An X in the First server or Additional server column indicates that a parameter pertains to that type of server setup.
  • An asterisk (*) next to an X indicates a required parameter.
  • Value types are string unless otherwise noted.
  • Note the following rules related to putting quotes around string values:
    • When specifying in a file through the Docker --env-file argument, quotes are not allowed.
    • When specifying through a Windows batch file (non-Docker), quotes are not required.
    • When specifying through a UNIX bash shell script (non-Docker), quotes are required around strings that contain spaces. Otherwise, quotes are not required. For example, specify export SERVERSETUP_SERVER_TITLE="ACME Application Server" and not export SERVERSETUP_SERVER_TITLE=ACME Application Server.
  • Boolean values are indicated by true or false without quotes.
  • Numeric values are specified without quotes except when they function as strings, such as notes.ini values.
  • To apply a default value, specify null without quotes or omit the parameter.
Table 1. Server setup system environment variables for one-touch Domino setup
Variable First server Additional server Default Description
SERVERSETUP_SERVER_TYPE X* X* Server type. Must be either:
  • first for first server in a Domino domain.
  • additional for additional servers in the domain.
SERVERSETUP_SERVER_NAME X* X* Server common name, for example, Adminserver.
SERVERSETUP_SERVER_DOMAINNAME X* X* Domino domain name
SERVERSETUP_SERVER_TITLE X X None Server title
SERVERSETUP_SERVER_PASSWORD X None Server ID password
SERVERSETUP_SERVER_MINPASSWORDLENGTH X X 5 Minimum password length for all passwords. (Integer)
SERVERSETUP_SERVER_IDFILEPATH X* Path of server ID file. May be relative to Domino data directory.
SERVERSETUP_NETWORK_HOSTNAME X* X* DNS host name
SERVERSETUP_NETWORK_ENABLEPORTENCRYPTION X X true Value of true enables port encryption. (Boolean)
SERVERSETUP_NETWORK_ENABLEPORTCOMPRESSION X X true Value of true enables port compression. (Boolean)
SERVERSETUP_ORG_COUNTRYCODE X X None Organization country code
SERVERSETUP_ORG_ORGNAME X* X* Organization name
SERVERSETUP_ORG_CERTIFIERPASSWORD X* Organization certifier password
SERVERSETUP_ORG_ORGUNITNAME X X None Organization unit name
SERVERSETUP_ORG_ORGUNITPASSWORD X X None Organization unit password
SERVERSETUP_ADMIN_FIRSTNAME X None Administrator first name
SERVERSETUP_ADMIN_MIDDLENAME X None Administrator middle name or initial
SERVERSETUP_ADMIN_LASTNAME X* Administrator last name
SERVERSETUP_ADMIN_PASSWORD X* Administrator ID password
SERVERSETUP_ADMIN_IDFILEPATH X* Administrator ID file path
SERVERSETUP_ADMIN_CN X* Administrator common name.
SERVERSETUP_NOTESINI_SERVERTASKS X X See description A comma-separated list of server tasks that run on the server. Default value is Replica,Router,Update,AMgr,Adminp,Sched,CalConn,RnRMgr.
SERVERSETUP_NOTESINI_LOG_REPLICATION X X "1" Value of 1 logs replication activity.
SERVERSETUP_NOTESINI_LOG_SESSIONS X X "1" Value of 1 logs the start and end of sessions.
SERVERSETUP_SECURITY_ACL_PROHIBITANONYMOUSACCESS X X true Value of true gives Anonymous users No Access in the ACL of all new databases. (Boolean)
SERVERSETUP_SECURITY_ACL_ADDLOCALDOMAINADMINS X X true Value of true gives the LocalDomainAdmins group entry Manager access in the ACL of all new databases. (Boolean)
SERVERSETUP_AUTOREGISTER_COUNT X 0 Number of servers to register automatically. (Integer) If you don't use autoregister, you register servers manually.
SERVERSETUP_AUTOREGISTER_IDPATH X None Specifies the directory in which to put generated server ID files if you register servers automatically.
SERVERSETUP_AUTOREGISTER_PATTERN X None Specifies a pattern for the names of generated server ID files if you register servers automatically. Pattern must contain a single '#' character which will be replaced with the numbers 0, 1, ... up to count-1.

For example, if count is 3 and pattern is mailserver#, the resulting ID files are named mailserver0.id, mailserver1.id, mailserver2.id.

SERVERSETUP_EXISTINGSERVER_CN X* Server common name of an existing server, for example, Adminserver.
SERVERSETUP_EXISTINGSERVER_HOSTNAMEORIP X None Server DNS host name or IP address of the existing server.
Table 2. ID vault system environment variables for one-touch Domino setup
Variable First server Additional server Default Description
IDVAULT_NAME X Vault name
IDVAULT_DESCRIPTION X Vault description
IDVAULT_IDFILE X Vault ID file
IDVAULT_IDPASSWORD X Vault ID file password
IDVAULT_PATH X Vault database path
IDVAULT_PASSWORDRESET_HELPTEXT X Help text for users who forget their passwords
IDVAULT_SECURITYSETTINGSPOLICY_NAME X Security Settings policy name
IDVAULT_SECURITYSETTINGSPOLICY_DESCRIPTION X Security Settings policy description
IDVAULT_MASTERPOLICY_DESCRIPTION X Master policy description
Note: ID vault setup is optional, but if specified, all variables are required.