Konfiguration¶
In diesem Kapitel geht es um die Konfiguration des Actions Clients. Wie alle unsere Produkte nutzt auch der Actions Client unser Konfigurationssystem. Im Kapitel Konfigurationssystem findest du alle Grundlagen dazu, wie die Konfigurationsdateien strukturiert sein müssen, wo die Anwendung sie sucht und viele weitere wichtige Begriffe und Themen.
Grundlegende Struktur¶
Das folgende Beispiel zeigt dir die grundlegende Struktur der Client-Konfiguration.
1<?xml version="1.0" encoding="UTF-8" ?>
2<Configuration
3 version="1"
4 xmlns="http://educateit.ch/software/BlueStone/Configuration/1">
5
6 <Module name="Application">
7 <!-- Die Hauptkonfiguration des Actions Clients -->
8 </Module>
9
10 <Module name="SSL">
11 <!-- SSL Profile -->
12 </Module>
13
14</Configuration>
Das Konfigurationsschema¶
Module
Application
Must not be empty.
Must match this regular expression:
[-a-z0-9\[\]_.:]+
Must not be empty.
Must not be empty.
Must not be empty.
Der Wert serverAddress¶
Mit dem Wert serverAddress konfigurierst du den Hostnamen oder die IP-Adresse des Action Servers mit dem du dich verbinden möchtest.
Den Hostnamen, welchen du hier konfigurierst kannst du mit der Kommandozeilenoption --connectToServer überschreiben. Siehe dazu Kapitel Kommandozeilen-Optionen.
1<Module name="Application">
2 <Value name="serverAddress">actions-backend.example.com</Value>
3 <Value name="serverPort">12837</Value>
4 <Value name="sslProfile">client</Value>
5 <Value name="apiKey">[API Key]</Value>
6 <Value name="apiSecret">[API Secret]</Value>
7</Module>
Der Wert serverPort¶
Wit dem Wert serverPort konfigurierst du den Port des Servers mit dem sich der Client verbinden soll. Lässt du diesen Wert weg, wird der Standardport 12837 verwendet.
Den Port kannst du zusammen mit dem Hostnamen über die Kommandozeilenoption --connectToServer überschreiben. Siehe dazu Kapitel Kommandozeilen-Optionen.
1<Module name="Application">
2 <Value name="serverAddress">actions-backend.example.com</Value>
3 <Value name="serverPort">12837</Value>
4 <Value name="sslProfile">client</Value>
5 <Value name="apiKey">[API Key]</Value>
6 <Value name="apiSecret">[API Secret]</Value>
7</Module>
Der Wert sslProfile¶
Neu in Version 3.20.
Mit dem Wert sslProfile legst du das SSL-Profil fest, das zur Verbindung mit dem Actions Server verwendet wird. Dieses Profil muss im SSL Modul konfiguriert sein. Du kannst den speziellen Wert legacy verwenden, um die eingebauten älteren Zertifikate zu nutzen. Alle Details über die SSL Profile findest du im Kapitel Eigene SSL Zertifikate verwenden.
1<Module name="Application">
2 <Value name="serverAddress">actions-backend.example.com</Value>
3 <Value name="serverPort">12837</Value>
4 <Value name="sslProfile">client</Value>
5 <Value name="apiKey">[API Key]</Value>
6 <Value name="apiSecret">[API Secret]</Value>
7</Module>
Der Wert apiKey¶
Neu in Version 3.21.
Mit dem Wert apiKey konfigurierst du den Schlüssel für die Verbindung. Das Schlüsselpaar, welches du mit den Werte apiKey und apiSecret konfigurierst, muss im Server registriert sein.
Weitere Informationen dazu findest du im Kapitel Die Liste secrets der Serverkonfiguration.
1<Module name="Application">
2 <Value name="serverAddress">actions-backend.example.com</Value>
3 <Value name="serverPort">12837</Value>
4 <Value name="sslProfile">client</Value>
5 <Value name="apiKey">[API Key]</Value>
6 <Value name="apiSecret">[API Secret]</Value>
7</Module>
Der Wert apiSecret¶
Neu in Version 3.21.
Mit dem Wert apiSecret konfigurierst du das Secret für die Verbindung. Siehe Der Wert apiKey für weitere Details.
1<Module name="Application">
2 <Value name="serverAddress">actions-backend.example.com</Value>
3 <Value name="serverPort">12837</Value>
4 <Value name="sslProfile">client</Value>
5 <Value name="apiKey">[API Key]</Value>
6 <Value name="apiSecret">[API Secret]</Value>
7</Module>
Beispielkonfiguration¶
1<?xml version="1.0" encoding="UTF-8" ?>
2<Configuration
3 version="1"
4 xmlns="http://educateit.ch/software/BlueStone/Configuration/1">
5
6 <Module name="Application">
7 <Value name="serverAddress">actions-backend.example.com</Value>
8 <Value name="serverPort">12837</Value>
9 <Value name="sslProfile">client</Value>
10 <Value name="apiKey">[API Key]</Value>
11 <Value name="apiSecret">[API Secret]</Value>
12 </Module>
13
14 <Module name="SSL">
15 <List name="profiles">
16 <ListEntry>
17 <Value name="identifier">client</Value>
18 <Value name="key">[key path to PEM file]</Value>
19 <Value name="caCertificates">[ca path to PEM file]</Value>
20 <Value name="localCertificateChain">[path to certificate PEM file]</Value>
21 <Value name="peerVerificationEnabled">Yes</Value>
22 </ListEntry>
23 </List>
24 </Module>
25
26</Configuration>
