Préparation des paramètres d'entrée via des variables d'environnement système

Comme alternative à l'utilisation d'un fichier JSON, vous pouvez utiliser des variables d'environnement système pour fournir des paramètres d'entrée pour la configuration de Domino en une seule touche.

Si vous exécutez Domino sur Docker, vous définissez les variables d'environnement système que Docker doit exporter dans un fichier texte spécifié par le paramètre --env-file. Si vous exécutez Domino sous Windows ou UNIX, après avoir installé Domino, utilisez un fichier de traitement par lots ou un script shell, ou exécutez des commandes individuelles pour exporter les variables d'environnement système nécessaires à la configuration de votre serveur. La syntaxe de la commande d'exportation varie, mais un exemple d'utilisation du shell bash sur Linux est :
export SERVERSETUP_SERVER_TYPE=additional
Les noms des variables d'environnement système sont similaires aux noms de paramètres spécifiés dans un fichier JSON, à l'exception des cas suivants :
  • Sur les plateformes dont les noms sont sensibles à la casse, par exemple, UNIX, vous devez spécifier les noms des variables d'environnement système en majuscules.
  • Alors que l'entrée JSON est de nature hiérarchique, les variables d'environnement se trouve dans un espace de nom "plat" ou global. Par conséquent, vous formez les noms en insérant un trait de soulignement entre les noms pour indiquer une hiérarchie. Par exemple, un fichier d'entrée JSON peut fournir les données suivantes :
    "serverSetup": {
    		"server": {
    			"type": "additional",
    			"name": "mailserver1",
    			"domainName": "Renovations",
    			"title": "Renovations Mail Server"
    		},
    
    
    Les variables d'environnement système correspondantes définies dans un --env-file spécifié pour Docker seraient les suivantes :
    Remarque : Lorsque vous utilisez --env-file, ne placez pas les valeurs entre guillemets.
    SERVERSETUP_SERVER_TYPE=additional
    SERVERSETUP_SERVER_NAME=mailserver1
    SERVERSETUP_SERVER_DOMAINNAME=Renovations
    SERVERSETUP_SERVER_TITLE=Renovations Mail Server
    Les variables d'environnement système correspondantes définies dans un script de shell bash UNIX seraient les suivantes. Vous invoquez le script de shell dans le même shell que celui qui appelle la configuration de Domino en une seule touche. Dans ce cas, seules les valeurs contenant des espaces requièrent des guillemets ; l'utilisation de guillemets pour d'autres valeurs est facultative. Les guillemets sont retirés des valeurs lorsque le script s'exécute.
    export SERVERSETUP_SERVER_TYPE=additional
    export SERVERSETUP_SERVER_NAME=mailserver1
    export SERVERSETUP_SERVER_DOMAINNAME=Renovations
    export SERVERSETUP_SERVER_TITLE="Renovations Mail Server"
Les tableaux suivants décrivent les variables d'environnement système prise en charge pour la configuration du serveur, du coffre d'ID et des préférences de configuration en une seule touche.
  • Un X dans la colonne Premier serveur ou Serveur supplémentaire indique qu'un paramètre se rapporte à ce type de configuration de serveur.
  • Un astérisque (*) en face d'un X indique un paramètre obligatoire.
  • Les types de valeur sont des chaînes, sauf spécification contraire.
  • Notez les règles suivantes relatives à l'insertion de guillemets autour des valeurs de chaîne :
    • Lorsque vous spécifiez dans un fichier via l'argument --env-file Docker, les guillemets ne sont pas autorisés.
    • Lors de la spécification via un fichier de traitement par lots Windows, les guillemets ne sont pas requis.
    • Lorsque vous spécifiez via un script de shell bash UNIX, des guillemets sont requis autour des chaînes contenant des espaces. Sinon, les guillemets ne sont pas requis. Par exemple, spécifiez export SERVERSETUP_SERVER_TITLE="ACME Application Server" et non export SERVERSETUP_SERVER_TITLE=ACME Application Server.
  • Les valeurs booléennes sont indiquées par true ou false sans guillemets.
  • Les valeurs numériques sont spécifiées sans guillemets, sauf lorsqu'elles fonctionnent comme des chaînes, telles que les valeurs notes.ini.
  • Pour appliquer une valeur par défaut, spécifiez null sans guillemets ou omettez le paramètre.

Variables d'environnement système pour la configuration du serveur

Tableau 1. Variables d'environnement système pour la configuration du serveur
Variable Premier serveur Serveur supplémentaire Par défaut Description
SERVERSETUP_SERVER_TYPE X* X* Type de serveur. Doit être :
  • first pour le premier serveur d'un domaine Domino.
  • additional pour les serveurs supplémentaires du domaine.
SERVERSETUP_SERVER_NAME X* X* Nom commun du serveur, par exemple, Adminserver
SERVERSETUP_SERVER_DOMAINNAME X* X* Nom de domaine Domino
SERVERSETUP_SERVER_TITLE X X Aucun Titre de serveur
SERVERSETUP_SERVER_PASSWORD X Aucun Mot de passe de l'ID serveur
SERVERSETUP_SERVER_MINPASSWORDLENGTH X X 5 Longueur minimale du mot de passe pour tous les mots de passe. (Integer)
SERVERSETUP_SERVER_USEEXISTINGSERVERID X false La valeur true utilise l'ID serveur existant spécifié par IDFilePath. La valeur par défaut consiste à créer un ID serveur qui est par défaut server.id dans l'annuaire de travail Domino.
SERVERSETUP_SERVER_IDFILEPATH X X* Chemin d'accès du fichier ID serveur. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_SERVER_SERVERTASKS X X "Replica,Router,Update,AMgr,Adminp,Sched,CalConn,RnRMgr" Liste séparée par des virgules des tâches du serveur qui s'exécutent sur le serveur.
SERVERSETUP_SERVER_ADDITIONALSERVERTASKS X X Liste séparée par des virgules des tâches supplémentaires qui s'exécutent sur le serveur. Utilisez cette option pour ajouter à la liste par défaut des tâches serveur.
SERVERSETUP_NETWORK_HOSTNAME X* X* Nom d'hôte DNS
SERVERSETUP_NETWORK_ENABLEPORTENCRYPTION X X true La valeur true active le chiffrement du port. (Booléen)
SERVERSETUP_NETWORK_ENABLEPORTCOMPRESSION X X true La valeur true active la compression du port. (Booléen)
SERVERSETUP_ORG_COUNTRYCODE X X Aucun Code du pays de l'organisation
SERVERSETUP_ORG_ORGNAME X* X* Nom de l'organisation
SERVERSETUP_ORG_CERTIFIERPASSWORD X* Mot de passe du certificateur de l'organisation
SERVERSETUP_ORG_ORGUNITNAME X X Aucun Nom d'unité organisationnelle
SERVERSETUP_ORG_ORGUNITPASSWORD X X Aucun Mot de passe de l'unité organisationnelle
SERVERSETUP_ORG_USEEXISTINGCERTIFIERID X false La valeur true utilise l'ID certificateur existant spécifié par certifierIDFilePath. La valeur par défaut consiste à créer un ID certificateur qui est par défaut cert.id dans l'annuaire de travail Domino. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_ORG_CERTIFIERIDFILEPATH X Aucun Chemin d'accès de l'ID certificateur utilisé lorsque useExistingCertifierID a la valeur true. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_ORG_USEEXISTINGORGUNITID X false La valeur true utilise l'ID certificateur d'unité organisationnelle spécifié par orgUnitIDFilePath. La valeur par défaut lorsqu'un nom orgUnitName est spécifié consiste à créer un ID certificateur d'unité organisation qui est par défaut oucert.id par défaut dans l'annuaire de travail Domino. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_ORG_ORGUNITIDFILEPATH X aucun Chemin d'accès de l'ID certificateur d'unité organisationnelle utilisé lorsque useExistingOrgUnitID a la valeur true. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_ADMIN_FIRSTNAME X Aucun Prénom de l'administrateur
SERVERSETUP_ADMIN_MIDDLENAME X Aucun Second prénom ou initiale de l'administrateur
SERVERSETUP_ADMIN_LASTNAME X* Nom de l'administrateur
SERVERSETUP_ADMIN_PASSWORD X* ID et mot de passe de l'administrateur
SERVERSETUP_ADMIN_IDFILEPATH X* Chemin d'accès au fichier ID de l'administrateur. Sur Docker, l'ID doit être relatif au conteneur.
SERVERSETUP_ADMIN_CN X* Nom usuel de l'administrateur.
SERVERSETUP_SECURITY_ACL_PROHIBITANONYMOUSACCESS X X true La valeur true interdit l'accès à la LCA de toutes les nouvelles bases de données aux utilisateurs anonymes. (Booléen)
SERVERSETUP_SECURITY_ACL_ADDLOCALDOMAINADMINS X X true La valeur true donne à l'entrée de groupe LocalDomainAdmins un accès Gestionnaire dans la LCA de toutes les nouvelles bases de données. (Booléen)
SERVERSETUP_SECURITY_TLSSETUP_METHOD X* Méthode de création de la base de données d'artefacts TLS dans certstore.nsf. Doit être l'une des valeurs suivantes :
  • "dominoMicroCA" pour créer une autorité de certification de micro-certificat Domino et l'utiliser pour créer un certificat TLS. Les paramètres valides sont CADisplayName, CAOrgName, CAKeyType, CAExpirationDays, orgName, TLSKeyType, certExpirationDays.
  • "import" pour importer des données de certificat à partir d'un fichier.pem, .p12, .pfx ou .kyr. Les paramètres valides sont importFilePath, importFilePassword, retainImportFile, exportPassword.
SERVERSETUP_SECURITY_TLSSETUP_CADISPLAYNAME X DominoMicroCA Nom d'affichage de l'autorité de certification.
SERVERSETUP_SECURITY_TLSSETUP_CAORGNAME X Nom de l'organisation de l'autorité de certification. La valeur par défaut de la variable de l'environnement système SERVERSETUP_ORG_ORGNAME.
SERVERSETUP_SECURITY_TLSSETUP_CAKEYTYPE X RSA Type de clé de l'autorité de certification. Doit être l'une des valeurs suivantes :
  • "RSA" - RSA avec taille de clé par défaut
  • "ECDSA" - ECDSA avec taille de clé par défaut
  • "RSA2048" - RSA avec clé 2 048 bits
  • "RSA4096" - RSA avec clé 4 096 bits
  • "ES256" - ECDSA avec clé 256 bits "ES384" - ECDSA avec clé 384 bits.
SERVERSETUP_SECURITY_TLSSETUP_ CAEXPIRATIONDAYS X Nombre de jours avant l'expiration du certificat de l'autorité de certification. S'il n'est pas spécifié, Domino choisit une valeur par défaut appropriée.
SERVERSETUP_SECURITY_TLSSETUP_ ORGNAME X Nom de l'organisation du certificat TLS. La valeur par défaut est CAORIGNEME.
SERVERSETUP_SECURITY_TLSSETUP_TLSKKEYTYPE X RSA Reportez-vous à CAKEYTYPE pour obtenir des valeurs valides.
SERVERSETUP_SECURITY_TLSSETUP_CERTEXPIRATIONDAYS X Nombre de jours avant l'expiration du certificat TLS, une valeur entière entre 1 et 398, inclusivement. S'il n'est pas spécifié, Domino choisira une valeur par défaut appropriée.
SERVERSETUP_SECURITY_TLSSETUP_IMPORTFILEPATH X Requis pour "method" : "import". Chemin du fichier .pem, .p12, .pfx ou .kyr à importer.
SERVERSETUP_SECURITY_TLSSETUP_IMPORTFILEPASSWORD X Mot de passe pour déchiffrer le contenu du fichier d'importation. Obligatoire si le fichier d'importation est protégé par un mot de passe. Peut utiliser n'importe quel mécanisme de mot de passe indirect comme décrit dans Spécification indirecte de mots de passe.
SERVERSETUP_SECURITY_TLSSETUP_RETAINIMPORTFILE X false Par défaut, le fichier d'importation est supprimé après une importation réussie. Spécifiez true pour conserver le fichier.
SERVERSETUP_SECURITY_TLSSETUP_EXPORTPASSWORD X Mot de passe pour le stockage des données importées chiffrées, si vous souhaitez que les données soient exportables.
SERVERSETUP_DIRECTORYASSISTANCE_DATABASEPATH X X da.nsf Chemin de la base de données Directory Assistance Crée une base de données Directory Assistance.
SERVERSETUP_DIRECTORYASSISTANCE_DOMAINNAME X X Nom du domaine Directory Assistance d'un répertoire LDAP. La valeur par défaut de SERVERSETUP_SERVER_DOMAINNAME.
SERVERSETUP_DIRECTORYASSISTANCE_COMPANYNAME X X Nom de la société Directory Assistance. La valeur par défaut de SERVERSETUP_ORG_ORGNAME.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_HOSTNAME X* X* Nom d'hôte DNS du serveur LDAP.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_VENDOR X X dominoLDAP Fournisseur LDAP Directory Assistance Doit être l'une des valeurs suivantes : "activeDirectory", "openLDAP", "dominoLDAP".
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_USERDN X X Nom distinctif de l'utilisateur LDAP Directory Assistance.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_PASSWORD X X Mot de passe de l'utilisateur LDAP Directory Assistance.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_BASESEARCHDN X X Nom distinctif de la recherche de base LDAP Directory Assistance.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION X X TLS Chiffrement du canal LDAP Directory Assistance. Doit être "TLS" ou "none".
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_PORT X X Port LDAP Directory Assistance. La valeur par défaut est 636 pour SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION=TLS et 389 pour SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION=none.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_ACCEPTEXPIREDCERTIFICATES X X false LDAP Assistance Directory - Accepter les certificats arrivés à expiration.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_VERIFYREMOTESERVERCERTIFICATES X X true LDAP Assistance Directory - Vérifier les certificats des serveurs distants.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_TIMEOUT X X 0 Délai d'attente LDAP Assistance Directory, valeur d'un entier non négatif. Une valeur de 0 implique l'absence de délai d'attente.
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_MAXIMUMENTRIESRETURNED X X 0 Nombre maximum d'entrées LDAP Assistance Directory retournées, valeur d'un entier non négatif. Une valeur de 0 n'implique aucune limite.
SERVERSETUP_AUTOREGISTER_COUNT X 0 Nombre de serveurs à enregistrer automatiquement. (Entier) Si vous n'utilisez pas l'enregistrement automatique, vous enregistrez les serveurs manuellement.
SERVERSETUP_AUTOREGISTER_IDPATH X Aucun Indique l'annuaire dans lequel placer les fichiers d'ID serveur générés si vous enregistrez automatiquement les serveurs. Le répertoire doit exister. Sur Docker, les ID doivent être relatifs au conteneur.
SERVERSETUP_AUTOREGISTER_PATTERN X Aucun Spécifie un modèle pour les noms des fichiers d'ID générés si vous enregistrez automatiquement les serveurs. Le modèle doit contenir un caractère "#" unique qui sera remplacé par les chiffres 0, 1, ... jusqu'à count-1.

Par exemple, si le nombre est 3 et que le modèle est mailserver#, les fichiers d'ID résultants sont nommés mailserver0.id, mailserver1.id, mailserver2.id.

SERVERSETUP_EXISTINGSERVER_CN X* Nom usuel du serveur existant à partir duquel répliquer l'annuaire Domino et d'autres bases de données, par exemple, Adminserver.
SERVERSETUP_EXISTINGSERVER_HOSTNAMEORIP X Aucun Nom d'hôte DNS du serveur ou adresse IP du serveur existant.

Variables d'environnement système pour coffre d'ID

Remarque : La configuration du coffre d'ID est facultative, mais si elle est spécifiée, toutes les variables sont requises.
Tableau 2. Variables d'environnement système pour coffre d'ID
Variable Premier serveur Serveur supplémentaire Par défaut Description
IDVAULT_NAME X Nom du coffre. Indiquez "O=<vaultname>" par exemple, "O=DemoVault". Vous devez inclure le préfixe "O=". Si vous l'omettez, vous pouvez obtenir une erreur 'Entrée non trouvée dans l'index' lors de la tentative de création du coffre.
IDVAULT_DESCRIPTION X Description du coffre
IDVAULT_IDFILE X Fichier d'ID du coffre
IDVAULT_IDPASSWORD X Mot de passe du fichier d'ID du coffre
IDVAULT_PATH Chemin de la base de données du coffre. Il s'agit d'un paramètre facultatif et nous vous recommandons de ne pas le spécifier, car il peut être dérivé du paramètre de nom. Si vous le spécifiez, la partie répertoire du chemin doit être IBM_ID_VAULT et la partie du nom de chemin du chemin doit correspondre au paramètre name, sans le préfixe O=, par exemple, "IBM_ID_VAULT/DemoVault.nsf"
IDVAULT_PASSWORDRESET_HELPTEXT X Texte d'aide pour les utilisateurs ayant oublié leurs mots de passe.
IDVAULT_SECURITYSETTINGSPOLICY_NAME X Nom de la stratégie de paramètres de sécurité
IDVAULT_SECURITYSETTINGSPOLICY_DESCRIPTION X Description de la stratégie de paramètres de sécurité
IDVAULT_MASTERPOLICY_DESCRIPTION X Description de la stratégie principale

Variables d'environnement système pour les préférences de configuration en une seule touche

Tableau 3. Variables d'environnement système pour les préférences de configuration en une seule touche
Variable Premier serveur Serveur supplémentaire Par défaut Description
AUTOCONFIGPREFERENCES_STARTSERVERAFTERCONFIGURATION X X true Si la valeur a la valeur true, Domino démarre après une configuration réussie. Si la configuration a la valeur false, la configuration se ferme et ne démarre pas Domino.
AUTOCONFIGPREFERENCES_CONSOLELOGOUTPUT_SHOW X X "errors" Indique la sortie de la configuration en une seule touche à écrire dans le journal de la console. Les valeurs possibles sont "none", "errors" ou "all".
AUTOCONFIGPREFERENCES_CONSOLELOGOUTPUT_PAUSEONERRORSECONDS X X 15 Temps de pause (en secondes) avant de sortir lorsque la configuration en une seule touche se termine avec une erreur. Notez que pour certaines erreurs qui se produisent tôt dans le processus de configuration, il n'y a pas de pause. Vous pouvez toujours consulter IBM_TECHNICAL_SUPPORT/autoconfigure.log pour la sortie.