<!--
#============================================================================
# /var/install/help/certs_letsencrypt - helptexts for package certs_letsencrypt
#
# Copyright (c) 2016-2016 The Eisfair Team, team(at)eisfair(dot)org
#
# Creation: 2016-09-12 jed
# Last Update: $Id$
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#============================================================================
-->
<help name="LETSENCRYPT_DO_DEBUG">
Um den Debug-Modus zu aktivieren muss diese Variable lediglich auf
den Wert `yes' gestellt werden, die Einstellung `no' deaktiviert
den Debug-Modus.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_DO_DEBUG='no'<br/>
</help>
<help name="START_LETSENCRYPT">
Fuer die Aktivierung des Certs_letsencrypt-Paketes muss dieser
Parameter lediglich auf den Wert 'yes' gestellt werden. Die
Einstellung 'no' deaktiviert das Paket.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: START_LETSENCRYPT='no'<br/>
</help>
<help name="LETSENCRYPT_MODE">
Ueber diesen Parameter kann der Betriebsmodus des letsencrypt.sh-
Programms eingestellt werden, d.h. es kann bestimmt werden ob sich
dieses mit dem Let's Encrypt Staging- (test) oder Produktivserver
(live) verbinden soll.<br/>
<br/>
Gueltige Werte: live, test<br/>
<br/>
Standardeinstellung: LETSENCRYPT_MODE='test'<br/>
</help>
<help name="LETSENCRYPT_EMAIL">
Ueber diesen Parameter wird die E-Mail-Adresse festgelegt, die
bei der Zertifikatserstellung als Kontaktadresse im TLS-Zertifikat
verwendet werden soll.<br/>
<br/>
Gueltige Werte: gueltige E-Mail-Adresse<br/>
<br/>
Standardeinstellung: LETSENCRYPT_EMAIL='root@domain.com'<br/>
</help>
<help name="LETSENCRYPT_PRIVATE_KEY_RENEW">
Ueber diesen Parameter wird festgelegt, ob bei der Anforderung
eines TLS-Zertifikats auch immer ein neuer privater Schluessel
zum Signieren erstellt werden soll oder nicht.<br/>
Falls der Wert`nein' gewaehlt wird, muss ueber den Parameter<br/>
LETSENCRYPT_PRIVATE_KEY_FILE der vollstaendige
Pfad zu einer privaten Schluesseldatei angegeben werden. Die
gleiche Schluesseldatei zu verwenden kann von Vorteil sein,
wenn man z.B. haeufiger ein Zertifikat widerrufen muss.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_PRIVATE_KEY_RENEW='yes'<br/>
</help>
<help name="LETSENCRYPT_PRIVATE_KEY_FILE">
Ueber diesen Parameter kann der vollstaendige Pfad zu einer
private Schluesseldatei angegeben werden, welche bei der
Anforderung eines TLS-Zertifikates zum Signieren verwendet
werden soll. Diese Parameter wird nur dann ausgewertet, wenn<br/>
LETSENCRYPT_PRIVATE_KEY_RENEW='no' gesetzt
wirde.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_PRIVATE_KEY_FILE='/full/path/to/key-file.key'<br/>
</help>
<help name="LETSENCRYPT_PRIVATE_KEY_BITS">
Ueber diesen Parameter kann auf Wunsch eine vom Standard
abweichende RSA-Schluesselstaerke eingestellt werden.<br/>
<br/>
Gueltige Werte: 1024, 2048, 4096, 8192<br/>
<br/>
Standardeinstellung: LETSENCRYPT_PRIVATE_KEY_BITS='2048'<br/>
</help>
<help name="LETSENCRYPT_DOCUMENT_ROOT">
Ueber diesen Parameter kann ein vom Standard abweichendes
Dokumentenstammverzeichnis festgelegt werden. Wird dieser
Parameter nicht gesetzt, so wird der folgende Verzeichnispfad
verwendet: /var/www/htdocs/certs_letsencrypt.<br/>
<br/>
Gueltige Werte: absolute Pfadangabe<br/>
<br/>
Standardeinstellung: LETSENCRYPT_DOCUMENT_ROOT='/var/www/htdocs/certs_letsencrypt'<br/>
</help>
<help name="LETSENCRYPT_DATA_DIR">
Ueber diesen Parameter kann ein vom Standard abweichendes
Datenverzeichnis festgelegt werden in welchem die
Zertifikats- und Konfigurationsdateien ablegt werden sollen.<br/>
Wird dieser Parameter nicht gesetzt, so wird der folgende
Verzeichnispfad verwendet: /var/certs/letsencrypt
<br/>
Gueltige Werte: absolute Pfadangabe<br/>
<br/>
Standardeinstellung: LETSENCRYPT_DATA_DIR='/var/certs/letsencrypt'<br/>
</help>
<help name="LETSENCRYPT_DOMAIN_N">
Ueber diesen Parameter wird die Anzahl der Domains festgelegt fuer
die separate Let's Encrypt TLS-Zertifikate angefordert werden sollen.<br/>
<br/>
Gueltige Werte: Zahl<br/>
<br/>
Standardeinstellung: LETSENCRYPT_DOMAIN_N='1'<br/>
</help>
<help name="LETSENCRYPT_DOMAIN_%_ACTIVE">
Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der
zugehoerige Datensatz aktiviert, `no' deaktiviert ihn.<br/>
<br/>
Gueltige Werte: yes oder no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_DOMAIN_1_ACTIVE='yes'<br/>
</help>
<help name="LETSENCRYPT_DOMAIN_%_NAME">
Ueber diesen Parameter koennen eine oder mehrere FQDN-Namen
(Fully Qualified Domain Name), getrennt durch einen Doppelpunkt,
angegeben werden welche in ein TLS-Zertifikat einfliessen sollen.<br/>
Die erste Domain ist die Hauptdomain eines Zertifikates, alle
folgenden, optionalen Eintraege stellen alternative Domainnamen
dar. Die Verwendung von IP-Adressen wird generell von Let's
Encrypt nicht unterstuetzt.<br/>
<br/>
Hinweis: Es ist zu beachten, dass Let's Encrypt in Zertifikaten
weder die Verwendung von IP-Adressen noch von inoffiziellen,
selbst erstellten Domains wie .lan oder .local, etc. zulaesst.<br/>
<br/>
Gueltige Werte: FQDN<br/>
<br/>
Beispiel: LETSENCRYPT_DOMAIN_1_NAME='meine.domain.com'<br/>
</help>
<help name="LETSENCRYPT_DOMAIN_%_USAGE">
Ueber diesen Parameter koennen einer oder mehrerer, durch einen
Doppelpunkt voneinander getrennte eisfair-Paketnamen angegeben
werden fuer welche dieses Zertifikat verwendet werden soll.<br/>
So diese Pakete reservierte Zertifikatsnamen verwenden, werden
automatisch die erforderlichen symbolischen Links auf das
konfigurierte Let's Encrypt-Zertifikat erstellt.<br/>
<br/>
Gueltige Werte: all oder apache2, ldapserver, mail, mini_httpd, partimg, pure-ftpd, ssmtp<br/>
<br/>
Beispiel: LETSENCRYPT_DOMAIN_1_USAGE='apache2:mail'<br/>
</help>
<help name="LETSENCRYPT_HOOK_CMD_N">
Ueber diesen Parameter wird die Anzahl der auszufuehrenden Befehle
festgelegt, welche bei Auftreten von Ereignissen ausgefuehrt werden
sollen.<br/>
<br/>
Gueltige Werte: Zahl<br/>
<br/>
Standardeinstellung: LETSENCRYPT_HOOK_CMD_N='1'<br/>
</help>
<help name="LETSENCRYPT_HOOK_CMD_%_ACTIVE">
Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der
zugehoerige Datensatz aktiviert, `no' deaktiviert ihn.<br/>
<br/>
Gueltige Werte: yes oder no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_HOOK_CMD_1_ACTIVE='yes'<br/>
</help>
<help name="LETSENCRYPT_HOOK_CMD_%_TYPE">
Ueber diesen Parameter wird das Ereignis ausgewaehlt bei welchem
der Befehl ausgefuehrt werden soll.<br/>
<br/>
Gueltige Werte: clean_challenge, deploy_cert, deploy_challenge, unchanged_cert<br/>
<br/>
Standardeinstellung: LETSENCRYPT_HOOK_CMD_1_TYPE='deploy_cert'<br/>
</help>
<help name="LETSENCRYPT_HOOK_CMD_%_EXEC">
Ueber diesen Parameter wird der Befehl festgelegt, welcher beim
Auftreten eines Ereignisses ausgefuehrt werden soll.<br/>
<br/>
Gueltige Werte: absoluter Pfad zu einem ausfuehrbaren Befehl<br/>
<br/>
Standardeinstellung: LETSENCRYPT_HOOK_CMD_1_EXEC='/var/install/config.d/certs_letsencrypt.sh'<br/>
</help>
<help name="LETSENCRYPT_HOOK_CMD_%_OPTIONS">
Ueber diesen Parameter werden die Optionen festgelegt, welche an
den definierten Befehl uebergeben werden sollen.<br/>
<br/>
Gueltige Werte: gueltige Programmoption<br/>
<br/>
Standardeinstellung: LETSENCRYPT_HOOK_CMD_1_OPTIONS='--create-cert'<br/>
</help>
<help name="LETSENCRYPT_CHECK_ON_START">
Ueber diesen Parameter wird festgelegt, ob nach einem Neustart
des eisfair-Servers eine Zertifikatspruefung durchgefuehrt
werden soll. Dies kann z.B. fuer Rechner interessant sein, die
nicht dauerhaft betrieben werden.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_CHECK_ON_START='no'<br/>
</help>
<help name="LETSENCRYPT_CHECK_CRON">
Wird dieser Parameter auf 'yes' gestellt, so wird regelmaessig
geprueft, ob Let's Encrypt TLS-Zertifikate fuer die konfigurierten
Domains aktualisiert werden muessen, die Einstellung 'no'
deaktiviert diese Funktion.<br/>
Ueber den Parameter LETSENCRYPT_CHECK_CRON_SCHEDULE
wird dabei der Zeitintervall vorgegeben, in welchem eine Pruefung
durchgefuehrt wird.<br/>
<br/>
Gueltige Werte: yes, no<br/>
<br/>
Standardeinstellung: LETSENCRYPT_CHECK_CRON='yes'<br/>
</help>
<help name="LETSENCRYPT_CHECK_CRON_SCHEDULE">
Ueber diesen Parameter wird festgelegt zu welchem Zeitpunkt bzw.<br/>
in welchem Intervall eine automatisierte Pruefung der konfigurierten
Let's Encrypt TLS-Zertifikate erfolgen soll. Die fuenf Teilparameter
haben dabei folgende Bedeutung:<br/>
<br/>
1 - Minuten, 2 - Stunden, 3 - Tag des Monats, 4 - Monat, 5 - Wochentag.<br/>
<br/>
D.h. bei Verwendung der Standardeinstellung wird sonntaeglich um 00:13h
eine Aktualisierung durchgefuehrt. Wer Naeheres ueber die verwendete
Befehlssyntax erfahren moechte, sollte ueber eine Internet-Suchmaschine
nach 'man' und 'crontab' suchen.<br/>
<br/>
Gueltige Werte: Crontab-spezifischer Parametereintrag<br/>
<br/>
Standardeinstellung: LETSENCRYPT_CRL_CRON_SCHEDULE='13 0 * * 0'<br/>
</help>
<help name="LETSENCRYPT_LOG_COUNT">
Ueber diesen Parameter wird eingestellt, wie viele Logdateien
vorgehalten werden sollen. Wird dieser Wert ueberschritten, so
wird die aelteste Logdatei geloescht.<br/>
<br/>
Gueltige Werte: Zahl<br/>
<br/>
Standardeinstellung: LETSENCRYPT_LOG_COUNT='6'<br/>
</help>
<help name="LETSENCRYPT_LOG_INTERVAL">
Dieser Parameter bestimmt in welchen Intervallen die Logdateien
archiviert werden sollen. Zur Auswahl stehen die Schluesselwoerter
`daily' - taeglich, `weekly' - woechentlich und `monthly - monatlich.<br/>
<br/>
Gueltige Werte: daily, weekly, monthly<br/>
<br/>
Standardeinstellung: LETSENCRYPT_LOG_INTERVAL='weekly'<br/>
<br/>
</help>
<!-- The End -->