Content
Dateianzeige für carddav2fb (1.1.1)
usr/share/doc/carddav2fb/carddav2fb.txt
Das CardDAV2FB-Paket
Dieses Paket erlaubt es Adressbücher eines CardDAV-Servers, z.B. von
ownCloud^TM in eine AVM FRITZ!Box^TM zu übertragen.
Die Einleitung
In diesem Paket wurden verschiedenste PHP-Komponenten zusammengestellt,
die zusammen ein komplettes Paket ergeben.
Die Funktionen
Das CardDAV2FB-Paket besteht aus folgenden Komponenten:
* CardDAV2FB Das Hauptskript für den Datentransfer von einem
CardDAV-Server zur FRITZ!Box^TM .
Lizenz: Public Domain, some parts under GNU AGPL (GNU Affero
General Public License) or MIT (Massachusetts Institute of
Technolog) license.
([1]https://github.com/andig/carddav2fb)
Die Lizenzen
Die verwendeten Dateien unterliegen den im Absatz 'Die Funktionen'
genannten Lizenzen.
Die Voraussetzungen
Dieses Paket benötigt ein installiertes php5_ccpp-Paket um
funktionieren zu können.
Die Installation
Das CardDAV2FB-Paket wird über das Setup-Menü installiert. Wird eine
ältere Paketversion vorgefunden, so wird diese deinstalliert bevor die
neuen Programmdateien installiert werden. Nach dem Installieren der
Programmdateien wird direkt der Konfigurations-Editor gestartet um die
Konfiguration anzupassen. Nach Beendigung dieses Schrittes werden die
Konfigurationsdateien generiert und alle benötigten Programme
gestartet.
Das Menü im Setup-Programm
Das Menü im Setup-Programm ist wie folgt aufgebaut:
* CardDAV2FB administration
+ View documentation: Anzeigen der Dokumentation
+ Edit configuration: Bearbeiten der Konfiguration
+ Advanced configuration file handling: Konfigurationen
verwalten
+ Force manual FRITZ!Box^TM update: Manuelle Aktualisierung
anstoßen
+ View log file: Logdatei der letzten Aktualisierung ansehen
+ Exit: Untermenü verlassen
Die Menüpunkte dürften selbsterklärend sein, da sie keinerlei weitere
Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht
weiter eingegangen.
Die Änderung der Konfiguration
Die Konfiguration kann über den Menüpunkt `Edit configuration' geändert
werden. Standardmäßig wird der Editor aufgerufen, der in der
Environment-Konfiguration über die Variable 'EDITOR' festgelegt wurde.
Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration
aktiviert werden soll. Wird dies bestätigt, werden über ein Skript die
Anpassungen umgehend wirksam gemacht.
Die Konfigurationsdatei
In der Konfigurationsdatei, die über das Menü zugänglich ist, sind
folgende Parameter vorhanden; wer sie von Hand editieren will findet
sie in der Datei /etc/config.d/carddav2fb.
Die Parameter
START_CARDDAV2FB
Für die Aktivierung des CardDAV2FB-Programms muss dieser
Parameter lediglich auf den Wert `yes' gestellt werden. Die
Einstellung `no' deaktiviert das CardDAV2FB-Programm.
Gültige Werte: yes, no
Standardeinstellung: START_CARDDAV2FB='no'
CARDDAV2FB_FB_HOST
Über diesen Parameter wird der DNS-Name der FRITZ!Box^TM oder
deren IP-Adresse festgelegt, welcher für den Zugriff verwendet
werden soll.
Gültige Werte: Domainname oder IP-Adresse
Standardeinstellung: CARDDAV2FB_FB_HOST='fritz.box'
CARDDAV2FB_FB_USER / CARDDAV2FB_FB_PASS
Über diese Parameter werden der für den Zugriff auf die
FRITZ!Box^TM benötigte Login und das zugehörige Kennwort
angegeben.
ACHTUNG
Unbedingt Klein- / Großschreibung beachten!
Gültige Werte: Username bzw. Kennwort
Beispiel:
CARDDAV2FB_FB_USER='frank'
CARDDAV2FB_FB_PASS='geheim'
CARDDAV2FB_FB_PBOOK_NBR
Über diesen Parameter wird die Indexnummer des FRITZ!Box^TM -
Adressbuchs angegeben, in welches die aus dem CardDAV-Adressbuch
übernommenen Adressen geschrieben werden sollen. Die Zählung
beginnt üblicherweise bei `0' für das standardmäßig genutzte
`Telefonbuch'. Falls ein weiteres Adressbuch in der FRITZ!Box^TM
angelegt wurde, muss in diesem Fall die Indexnummer `1'
angegeben werden.
ACHTUNG
Bevor auf ein neues Adressbuch zugegriffen werden kann muss
dieses über das FRITZ!Box^TM -Menü angelegt werden.
Gültige Werte: Zahl
Standardeinstellung: CARDDAV2FB_FB_PBOOK_NBR='0'
CARDDAV2FB_FB_PBOOK_NAME
Über diesen Parameter wird der Name des FRITZ!Box^TM -Adressbuchs
angegeben, in welches die aus dem CardDAV-Adressbuch
übernommenen Adressen geschrieben werden sollen.
ACHTUNG
Bevor auf ein neues Adressbuch zugegriffen werden kann muss
dieses über das FRITZ!Box^TM -Menü angelegt werden.
Gültige Werte: Adressbuchname
Standardeinstellung: CARDDAV2FB_FB_PBOOK_NAME='Telefonbuch'
CARDDAV2FB_FB_PBOOK_GROUPS (Optionaler Parameter)
Über diesen Parameter können auf Wunsch individuelle
Adressbuchgruppen angegeben werden, um die Menge der Daten die
in die FRITZ!Box^TM importiert werden sollen, zu beschränken.
Die einzelnen Einträge sind jeweils durch einen Doppelpunkt
voneinander zu trennen.
Gültige Werte: Vorhandene Adressbuchgruppen
Beispiel:
CARDDAV2FB_FB_PBOOK_GROUPS='Familie:Freunde:Geschäftlich'
CARDDAV2FB_FB_PBOOK_VIPGROUP (Optionaler Parameter)
Über diesen Parameter kann der Name der VIP-Gruppe (Very
Important People) festgelegt werden.
Gültige Werte: Gruppenname
Standardeinstellung: CARDDAV2FB_FB_PBOOK_VIPGROUP='VIP'
CARDDAV2FB_FB_STORAGE_NAME (Optionaler Parameter)
Über diesen Parameter kann der Name des Dateisystems angegeben
werden auf welchem die Bilddateien der Adressbucheinträge auf
der FRITZ!Box^TM abgelegt werden sollen. Standardmäßig wird der
interne Speicher verwendet, soll jedoch beispielsweise ein
USB-Stick genutzt werden, so muss der Name eventuell
`Generic-FlashDisk-01' lauten.
Gültige Werte: Dateisystemname
Standardeinstellung: CARDDAV2FB_FB_STORAGE_NAME=”
CARDDAV2FB_FB_CHECK_CERT (Optionaler Parameter)
Über diesen Parameter kann die Prüfung des TLS-Zertifikates der
FRITZ!Box^TM deaktiviert werden. Dies kann eventuell
erforderlich werden, wenn ein selbst signiertes Zertifikat zur
Absicherung der Verbindung genutzt wird.
Gültige Werte: yes, no
Standardeinstellung: CARDDAV2FB_FB_CHECK_CERT='yes'
CARDDAV2FB_SOURCE_PBOOK_N
Über diesen Parameter wird die Anzahl der in das
FRITZ!Box^TM -Adressbuch zu importierenden CardDAV- Adressbücher
angegeben, welche über die folgenden Parameter definiert werden.
Gültige Werte: Zahl
Standardeinstellung: CARDDAV2FB_SOURCE_PBOOK_N='1'
CARDDAV2FB_SOURCE_PBOOK_x_ACTIVE
Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der
zugehörige Datensatz aktiviert, `no' deaktiviert ihn.
Gültige Werte: yes oder no
Beispiel: CARDDAV2FB_SOURCE_PBOOK_1_ACTIVE='no'
CARDDAV2FB_SOURCE_PBOOK_x_COMMENT
Über diesen Parameter kann ein Kommentar eingegeben werden,
welcher einzig der Beschreibung dieses Datensatzes dient.
Gültige Werte: beliebiger Text
Beispiel: CARDDAV2FB_SOURCE_PBOOK_1_COMMENT='Adressbuch von
Frank'
CARDDAV2FB_SOURCE_PBOOK_x_URL
Über diesen Parameter wird die URL für den Zugriff auf das
gewünschte CardDAV-Adressbuch angegeben.
Gültige Werte: URL
Standardeinstellung: CARDDAV2FB_SOURCE_PBOOK_x_URL=
'https://server.local.lan/owncloud/remote.php/carddav/addressboo
ks
/user/kontakte'
CARDDAV2FB_SOURCE_PBOOK_x_USER / CARDDAV2FB_SOURCE_PBOOK_x_PASS
Über diese Parameter werden der für den Zugriff auf das
CardDAV-Adressbuch benötigte Login und das zugehörige Kennwort
angegeben.
ACHTUNG
Unbedingt Klein- / Großschreibung beachten!
Gültige Werte: Username bzw. Kennwort
Beispiel:
CARDDAV2FB_SOURCE_PBOOK_1_USER='frank'
CARDDAV2FB_SOURCE_PBOOK_1_PASS='geheim'
CARDDAV2FB_CRON_SCHEDULE
Über diesen Parameter wird festgelegt zu welchem Zeitpunkt bzw.
in welchem Intervall automatisch ein Adressbuchabgleich
durchgeführt werden sollen. Die fünf Teilparameter haben dabei
folgende Bedeutung:
1 - Minuten, 2 - Stunden, 3 - Tag des Monats, 4 - Monat, 5 -
Wochentag.
D.h. bei Verwendung der Standardeinstellung wird jeden Sonntag
um 00:15h das FRITZ!Box^TM -Adressbuch durch den Inhalt des
CardDAV- Adressbuchs überschrieben. Wer Näheres über die
verwendete Befehlssyntax erfahren möchte, sollte über eine
Internet-Suchmaschine nach `man' und `crontab' suchen.
Gültige Werte: Crontab-spezifischer Parametereintrag
Standardeinstellung: CARDDAV2FB_CRON_SCHEDULE='15 0 * * 0'
__________________________________________________________________
References
1. https://github.com/andig/carddav2fb