Sedex Client

https://docs.sedex.admin.ch/
Admin
The sedex Client is a software component that facilitates secure messaging and data exchange within...
Tokens:68,149
Snippets:278
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start sedex-Client Command-Line Installer (Java)

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-command-line/installation-with-command-line

Initiates the interactive command-line installer for the sedex-Client. This command requires Java to be installed on the system. Replace 'x' with the specific version number. This method is ideal for headless servers or automated deployments.

```shell
java -jar sedex-client-7.0.x.jar -console
```

--------------------------------

### Run sedex-Client JAR Installer from Command Line

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/run-installer-program

This command allows you to execute the sedex-Client installer program using Java from a command-line interface. Ensure you have Java Runtime Environment installed and the JAR file is in the current directory or provide its full path. Replace '[file name].JAR' with the actual name of your JAR installer file.

```shell
java -jar [file name].JAR
```

--------------------------------

### Start Silent Installation with sedex-Client Installer

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-configuration-file/installation

This command initiates a silent installation or migration of the sedex-Client using a specified XML configuration file. Ensure the Java Runtime Environment is installed and the sedex-client installer JAR file is accessible in the current directory or its path is provided.

```shell
java -jar [sedex-client-installer] [installation-script]
```

```shell
java -jar sedex-client-7.0.x.jar install_create_certificate_v7.xml
```

--------------------------------

### Example Installation Check Output

Source: https://docs.sedex.admin.ch/installation-and-operation/operating-a-sedex-client/self-diagnosis

Sample output from a successful sedex-Client installation check, indicating that all tested aspects passed.

```text
Checking sedex-client installation in /opt/sedex-client on 01.04.2024 16:00:00

Checking sedex-client-configuration.properties ........................... OK
Checking sedex-certificate-configuration.xml ............................. OK
Checking connection to sedex without a client certificate ................ OK
Checking connection to sedex using the newest client certificate ......... OK
Checking installed certificates .......................................... OK
Checking newest certificate .............................................. OK
Checking sedex-incoming-message-interface-rules.conf ..................... OK
Checking sedex-wsproxy-user-configuration.properties ..................... OK
Checking File Access ..................................................... OK

*****************************************************************************
* Success: sedex Client installation check completed with no errors         *
*****************************************************************************
```

--------------------------------

### Install Linux Daemon (System V)

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Installs the sedex-Client as a Linux daemon using the System V init system. This ensures the client starts automatically after reboot. It requires administrative privileges and stops any running standalone client first.

```bash
<sedex_home>/bin/sedex-client-installDaemon.sh
```

--------------------------------

### Install Linux Daemon (systemd)

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Installs the sedex-Client as a Linux daemon using the systemd init system. This ensures the client starts automatically after reboot. It requires administrative privileges and stops any running standalone client first.

```bash
<sedex_home>/bin/sedex-client-installDaemonD.sh
```

--------------------------------

### Pull and Run sedex-Client Docker Container (Example 1)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/create-and-run

This snippet demonstrates how to pull a specific version of the sedex-Client Docker image and then run it with common configurations for a single client. It includes volume mounts for interface and data, port mappings, a stop timeout, restart policy, read-only filesystem, and detached mode.

```bash
$ docker pull sedexch/sedex-client:container-1.1

$ docker run \
  --name sedex-client \
  --mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
  --mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
  --publish YOUR_MONITORING_PORT:8000 \
  --publish YOUR_WS_PROXY_HTTP_PORT:8080 \
  --publish YOUR_WS_PROXY_HTTPS_PORT:8443 \
  --stop-timeout 65 \
  --restart unless-stopped \
  --read-only \
  -d \
  sedexch/sedex-client:container-1.1

```

--------------------------------

### Reinstall sedex-Client using XML Script

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/run-installer-program

This command demonstrates how to perform an automatic reinstallation of the sedex-Client using a previously generated XML configuration file. Ensure the installer JAR and the XML file are accessible.

```bash
java -jar [InstallerFileName].JAR [GeneratedXmlFile].XML
```

--------------------------------

### Start Sedex-Client Standalone Script (Batch)

Source: https://docs.sedex.admin.ch/support/faq/general/operational-questions

This batch script starts the sedex-Client as a standalone application. Administrator rights are not required for this operation.

```batch
@echo off
call sedexClientHome/bin/sedex-client-start.bat
```

--------------------------------

### Install Sedex-Client Windows Service Script (Batch)

Source: https://docs.sedex.admin.ch/support/faq/general/operational-questions

This batch script installs the sedex-Client as a Windows service. It requires administrator privileges to run.

```batch
@echo off
call sedexClientHome/bin/sedex-client-installWindowsService.bat
```

--------------------------------

### Install Windows Service

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Installs the sedex-Client as a Windows service, allowing it to start automatically after reboots. This command must be run as an Administrator and stops any running standalone sedex-Client first.

```batch
<sedex_home>/bin/sedex-client-installWindowsService.bat
```

--------------------------------

### Analyze sedex-Client Startup Errors

Source: https://docs.sedex.admin.ch/support/troubleshooting/client

This example shows a typical error message found in the `controller-technical.log` file when the sedex-Client fails to start. It highlights invalid configuration properties and provides a specific action to resolve the issue by updating the configuration file.

```text
****************************
SEDEX CLIENT FAILED TO START
****************************
Description:
Invalid property in sedex configuration:
    Property: outgoing-web-proxy.host
    Value: http://proxy.example.com
    Reason: Enter only hostname, do not use http:// or https://
Action:
Update your sedex-Client configuration in <sedex.home>/conf/sedex-
client-configuration.properties

```

--------------------------------

### Pull and Run sedex-Client Docker Container (Example 2 - Multiple Clients)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/create-and-run

This snippet shows how to pull the sedex-Client Docker image and run it with configurations suitable for multiple clients, indicated by a differentiated container name and distinct host paths for data. It includes essential options like volume mounts, port mappings, stop timeout, restart policy, read-only filesystem, and detached mode.

```bash
$ docker pull sedexch/sedex-client:container-1.1

$ docker run \
  --name sedex-client-1-1234-1 \
  --mount type=bind,source=/home/data/sedex-interface-1-1234-1,destination=/sedex-interface/ \
  --mount type=bind,source=/home/data/sedex-data-1-1234-1,destination=/sedex-data/ \
  --publish 12010:8000 \
  --publish 12020:8080 \
  --publish 12021:8443 \
  --stop-timeout 65 \
  --restart unless-stopped \
  --read-only \
  -d \
  sedexch/sedex-client:container-1.1

```

--------------------------------

### Start sedex-Client - Windows Batch

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/manual-start-stop

Starts the sedex-Client on Windows using a batch script. Assumes the script is located in the `<sedex_home>\bin` folder. No specific inputs or outputs are detailed, but it initiates the client process.

```batch
<sedex_home>\bin\sedex-client-start.bat
```

--------------------------------

### Docker Run Scripted Initial Configuration Example

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/scripted-initial-configuration-with-crid-otp

A concrete example of the Docker command used for scripted initial configuration of the sedex-Client container. This command demonstrates how to use specific host paths for data persistence and provides actual values for SEDEX_ID, SEDEX_CRID, and SEDEX_OTP. This example is useful for understanding the required parameters and their format.

```bash
docker run \
   --rm \
   --mount type=bind,source=/home/data/sedex-interface-1-1234-1,destination=/sedex-interface/ \
   --mount type=bind,source=/home/data/sedex-data-1-1234-1,destination=/sedex-data/ \
   --env SEDEX_ID=1-1234-1 \
   --env SEDEX_CRID=2d-9b-31-18-68 \
   --env SEDEX_OTP=BSAH-YAKO-JGHL-KIDE \
   sedexch/sedex-client:container-1.1 init-script-new-cert.sh
```

--------------------------------

### Start sedex-Client - Unix Shell

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/manual-start-stop

Initiates the sedex-Client on Unix-like systems via a shell script. The script resides in the `<sedex_home>/bin` directory and starts the necessary client processes.

```shell
<sedex_home>/bin/sedex-client-start.sh
```

--------------------------------

### Start sedex-Client Docker Container

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/start-stop

This command starts a previously stopped sedex-Client Docker container. Make sure to replace 'sedex-client' with the actual name of your container if it differs.

```bash
docker start sedex-client
```

--------------------------------

### Check Windows Service Configuration

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Verifies the Windows service configuration by running the sedex-Client in the console with service settings. Press Ctrl+C to exit this check.

```batch
<sedex_home>/bin/sedex-client-runInConsole-withWindowsServiceConfig.bat
```

--------------------------------

### Check Linux Daemon Configuration

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Verifies the Linux daemon configuration by running the sedex-Client in the console with daemon settings. Press Ctrl+C to exit this check.

```bash
<sedex_home>/bin/sedex-client-runInConsole-withDaemonConfig.sh
```

--------------------------------

### Start sedex-Client - Windows PowerShell

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/manual-start-stop

Starts the sedex-Client on Windows using a PowerShell script. The script should be in the `<sedex_home>\bin` directory. This command initiates the client's operational processes.

```powershell
<sedex_home>\bin\sedex-client-start.ps1
```

--------------------------------

### Verify sedex-Client Connection Logs

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/installation-check

This snippet shows expected log entries for a successful connection test when the sedex-Client starts. It indicates that the adapter can connect to the sedex server and pass its connection checks.

```log
[...] Connection test for <https://sedex-service.admin.ch/sedex-clientServices-ws/clientServices?WSDL> :passed
[...] Connection test for <https://sedex-service.admin.ch/osci-manager-entry/externalentry> : passed
[...] Connection test finished successfully
```

--------------------------------

### Docker Run Command for Sedex Client Container

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/create-and-run

This command starts a new Docker container named 'sedex-client-1-1234-1' using the 'sedexch/sedex-client:container-1.1' image. It configures various aspects including volume mounts for data and interfaces, port mappings for external access, stop timeout, restart policy, read-only filesystem, and detached mode. The output is the container ID.

```bash
user@ubuntu:~$ docker run \
>       --name sedex-client-1-1234-1 \
>       --mount type=bind,source=/home/data/sedex-interface-1-1234-1,destination=/sedex-interface/ \
>       --mount type=bind,source=/home/data/sedex-data-1-1234-1,destination=/sedex-data/ \
>       --publish 12010:8000 \
>       --publish 12020:8080 \
>       --publish 12021:8443 \
>       --stop-timeout 65 \
>       --restart unless-stopped \
>       --read-only \
>       -d \
>       sedexch/sedex-client:container-1.1
fde6465bc597e48bc07e7e5c41a8d49c4c4171071a58f78091f89f0ee4b3ab97


```

--------------------------------

### Retrieve Docker Container Logs

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/create-and-run

This command allows you to fetch the log output from a running sedex-Client Docker container. It is useful for diagnosing issues, especially if the client fails to start or encounters errors during its operation. The container name is required to specify which logs to retrieve.

```bash
$ docker logs sedex-client

```

--------------------------------

### Verify sedex-Client Version Submission Log

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/installation-check

This snippet displays the log entry confirming that the sedex-Client adapter successfully reported its software version to the sedex server. Its presence indicates a correct installation and configuration.

```log
[...] c.a.b.s.c.ConfigurationService: Submitting Adapter - Version was successful
```

--------------------------------

### sedex-Client Monitoring Page Content Example

Source: https://docs.sedex.admin.ch/installation-and-operation/operating-a-sedex-client/monitoring

This is an example of the raw text output from the sedex-Client's monitoring page. It displays various status indicators for different components like adapter, wsproxy, and controller. This format is used when accessing the page via the file system.

```text
#####################################
### sedex client monitoring       ###
### Status at 2023-08-11T08:42:31 ###
#####################################
adapter-uptime=00:01:01
adapter-version=Adapter 7.0.x
adapter-sedexId=1-123-1
adapter-profile=small
adapter-organisationCertificateExpirationDate=2025-04-20T14:09:05
adapter-interfaceFoldersPresent=OK
adapter-moveToWorkingFolder=OK
adapter-connectionToSedexServer=OK
adapter-lastConnectionCheck=2023-08-11T08:41:31
adapter-writeAccessToDatabase=OK
adapter-incoming-message-interface-default=file-system
adapter-incoming-message-interface-number-of-rules-via-file-system=0
adapter-incoming-message-interface-number-of-rules-via-rest-api=0
adapter-incoming-message-interface-number-of-rules-with-errors=0
adapter-messaging-rest-api-number-of-messages-in-virtual-inboxes-in-total=0
adapter-messaging-rest-api-interface-enabled=true
adapter-messaging-encryption-in-client-filesystem-enabled=true
wsproxy-https-port=8443
wsproxy-https-tls-certificate-subject=CN=sedex-wsproxy, O=sedex (www.sedex.ch)
wsproxy-https-tls-certificate-issuer=CN=sedex-wsproxy, O=sedex (www.sedex.ch)
wsproxy-https-tls-certificate-create-date=2023-08-11T08:41:33
wsproxy-https-tls-certificate-expiry-date=2028-08-09T08:41:33
wsproxy-https-tls-certificate-alternative-names=ip6-localhost,localhost,ubuntu
wsproxy-https-tls-certificate-is-valid=true
wsproxy-http-disabled=false
wsproxy-http-port=8080
wsproxy-uptime=00:00:56
wsproxy-users-allow-anonymous=true
wsproxy-user-configuration-number-error=0
wsproxy-user-configuration-number-ok=0
wsproxy-user-configuration-processed-at=2023-08-11T08:41:35
wsproxy-version=WsProxy 7.0.x
wsproxy-webservice-definitions-updated-at=2023-08-11T08:41:35
wsproxy-webservice-definitions-expires-at=2023-08-18T08:41:35
wsproxy-webservice-definitions-update-status=OK
wsproxy-webservice-definitions-update-info=Updated successfully
wsproxy-webservice-definitions-valid=true
wsproxy-webservice-last-call=
controller-uptime=00:01:00
controller-version=Controller 7.0.x
controller-updateCertificateExpirationDate=2024-06-04T14:45:29
client-version=Sedex-Client 7.0.x
monitor-lastCheckUp=2023-08-11T08:42:31
#####################################
### WSProxy
###
### Webservice configuration
###
#####################################
wsproxy-webservice-CheckSedexWebService-address-http=
http://localhost:8080/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-address-https=
https://localhost:8443/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-users=anonymous, authenticated
wsproxy-webservice-CheckSedexWebService-target=
https://sedex-service.admin.ch:443/sedex-clientServices-ws/CheckSedexWebService
[..]
```

--------------------------------

### Concrete Example of Sedex Initial Certificate Request Configuration

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/client-configuration/certificates

A concrete example of the sedex certificate configuration, demonstrating the use of the `initialCertificateRequest` element with specific request ID and one-time password values. This is used when setting up a new participant certificate.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<certificateConfiguration
    xmlns="http://www.sedex.ch/xmlns/certificateConfiguration/1/0">
    <initialCertificateRequest>
        <requestId>05-35-f4-85-ed</requestId>
        <oneTimePassword>LGCA-AIXL-QCOL-YVZH</oneTimePassword>
    </initialCertificateRequest>
    <transportCertificate>
        <location>
            ${sedex.home}/conf/certificates/sedex-transport-encryption.cer
        </location>
    </transportCertificate>
    <webserviceTruststore>
        <location>
            ${sedex.home}/conf/certificates/sedex-server-truststore.jks
        </location>
        <password>trustme</password>
        <truststoretype>JKS</truststoretype>
    </webserviceTruststore>
</certificateConfiguration>
```

--------------------------------

### Run Installation Check (Windows/Linux)

Source: https://docs.sedex.admin.ch/installation-and-operation/operating-a-sedex-client/self-diagnosis

Shell scripts to execute the sedex-Client installation check on Windows and Linux systems.

```batch
.\bin\check-installation.bat
```

```bash
./bin/check-installation.sh
```

--------------------------------

### Example sedex Webservice Proxy User Configuration

Source: https://docs.sedex.admin.ch/web-service-proxy/user-administration

This snippet demonstrates the format of entries in the sedex Webservice Proxy user configuration file. It shows how usernames, plain text passwords, and sedex IDs are defined, as well as an example of an encrypted password.

```properties
# File: sedex-wsproxy-user-configuration.properties
[…]
example-app-1=myNewAndSecurePassword,3-CH-55438
example-app-2={bcrypt}$2a$10$f/du7KAWE0xVu.a9DrRKN.fBxg[…]1wldBVam,1-CH-2874423
[…]
```

--------------------------------

### Run Installation Check (Docker)

Source: https://docs.sedex.admin.ch/installation-and-operation/operating-a-sedex-client/self-diagnosis

Docker command to run the sedex-Client installation check within a container. It mounts local directories for interface and data and executes the check-installation.sh script.

```bash
$ docker run \
--rm \
--mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
--mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
sedexch/sedex-client:container-1.1 check-installation.sh
```

--------------------------------

### Verify JAR File Signature with Jarsigner

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/download-installer

This command verifies the digital signature of the sedex-client JAR file using the Java jarsigner tool. It requires the Java Development Kit (JDK) to be installed. The output confirms the signer's certificate details and if the JAR has been tampered with.

```bash
jarsigner -verify -strict -verbose -certs sedex-client-7.0.13.jar
```

```text
- Signed by "CN=Bundesamt für Informatik und Telekommunikation, O=Bundesamt für Informatik und Telekommunikation, L=Zollikofen, C=CH"
    Digest algorithm: SHA-256
    Signature algorithm: SHA256withRSA, 3072-bit key
  Timestamped by "CN=DigiCert Timestamp 2023, O=\"DigiCert, Inc.\", C=US" on Fri Oct 13 11:35:54 UTC 2023
    Timestamp digest algorithm: SHA-256
    Timestamp signature algorithm: SHA256withRSA, 4096-bit key

jar verified.

The signer certificate will expire on 2024-09-04.
The timestamp will expire on 2031-11-10.
```

--------------------------------

### Unsupported WSDL URL Examples for sedex Web Service Proxy

Source: https://docs.sedex.admin.ch/web-service-proxy/providing-new-web-services

Highlights common mistakes in constructing WSDL/XSD URLs that are not supported by the sedex Web Service Proxy due to path or host discrepancies. Adhering to these examples prevents integration issues.

```url
https://ws.myservice.ch:443/myservice/ws/wsdl/myservice.xsd
https://wsdl.myservice.ch:443/myservice/ws/service/myservice.xsd
```

--------------------------------

### Calculate SHA-256 Hash on Linux

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/download-installer

This command calculates the SHA-256 hash of the sedex-client JAR file on Linux systems. It is used to ensure the downloaded file has not been corrupted.

```bash
sha256sum ./sedex-client-7.0.13.jar
```

--------------------------------

### Calculate SHA-256 Hash on Windows

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/download-installer

This command calculates the SHA-256 hash of the sedex-client executable file on Windows systems using PowerShell. It's used to verify file integrity after download.

```powershell
Get-FileHash sedex-client-7.0.13.exe
```

--------------------------------

### Navigate to sedex-Client Directory (Shell)

Source: https://docs.sedex.admin.ch/installation-and-operation/operating-a-sedex-client/self-diagnosis

Command to change the current directory to the sedex-Client installation path. Replace '<sedex-home>' with the actual directory.

```shell
cd <sedex-home>
```

--------------------------------

### Stop sedex-Client - Unix Shell

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/manual-start-stop

Terminates the sedex-Client on Unix-like systems using a shell script. Executed from the `<sedex_home>/bin` folder, this command ensures the client is properly stopped.

```shell
<sedex_home>/bin/sedex-client-stop.sh
```

--------------------------------

### Configure init.conf Parameters (INI)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/manual-initial-configuration-with-certificate

This snippet outlines the key-value pairs that need to be added to the 'init.conf' file. These parameters specify the SEDEX ID, the filename of the keystore, and its password. Both template placeholders and concrete example values are shown.

```ini
SEDEX_ID=YOUR-SEDEX-ID
SEDEX_KEYSTORE_FILENAME=YOUR-KEYSTORE-FILE.p12
SEDEX_KEYSTORE_PASSWORD=YOUR-PASSWORD
```

```ini
SEDEX_ID=1-1234-1
SEDEX_KEYSTORE_FILENAME=1-1234-1.p12
SEDEX_KEYSTORE_PASSWORD=ALFJZIPNXG
```

--------------------------------

### Copy Keystore File (Bash)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/manual-initial-configuration-with-certificate

This command copies the existing sedex keystore file (PKCS12/P12 format) into the 'sedex-data' directory. This file contains the private key and certificate required for secure communication. Both template and concrete examples are provided.

```bash
$ cp /path/to/credentials/YOUR-KEYSTORE-FILE.p12 /path/to/sedex-data/
```

```bash
$ cp /home/data/credentials/1-1234-1.p12 /home/data/sedex-data-1-1234-1/
```

--------------------------------

### Create init.conf File (Bash)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/manual-initial-configuration-with-certificate

This command shows how to create the 'init.conf' file using a text editor like 'nano'. This file is essential for providing initial configuration parameters to the sedex-Client, including SEDEX ID, keystore filename, and password. Template and concrete examples are included.

```bash
$ nano /path/to/sedex-data/init.conf
```

```bash
$ nano /home/data/sedex-data-1-1234-1/init.conf
```

--------------------------------

### Create and Configure init.conf File (Bash)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/manual-initial-configuration-with-crid-otp

This section shows how to create the 'init.conf' file within the 'sedex-data' directory using a text editor like 'nano'. It also provides an example of the configuration parameters that need to be added to this file.

```bash
$ nano /path/to/sedex-data/init.conf
```

```bash
$ nano /home/data/sedex-data-1-1234-1/init.conf
```

```bash
SEDEX_ID=YOUR-SEDEX-ID
SEDEX_CRID=YOUR-CERTIFICATE-REQUEST-ID
SEDEX_OTP=YOUR-ONE-TIME-PASSWORD
```

```bash
SEDEX_ID=1-1234-1
SEDEX_CRID=2d-9b-31-18-68
SEDEX_OTP=BSAH-YAKO-JGHL-KIDE
```

--------------------------------

### Uninstall Linux Daemon (systemd)

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Uninstalls the sedex-Client daemon installed via the systemd init system. This stops the automatic startup after reboot for systemd environments.

```bash
<sedex_home>/bin/sedex-client-uninstallDaemonD.sh
```

--------------------------------

### Uninstall Linux Daemon (System V)

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/starting-stopping-client/automatic-start

Uninstalls the sedex-Client daemon installed via the System V init system. This stops the automatic startup after reboot for System V environments.

```bash
<sedex_home>/bin/sedex-client-uninstallDaemon.sh
```

--------------------------------

### Add Certificate Password to XML for sedex-Client Reinstallation

Source: https://docs.sedex.admin.ch/installation-and-operation/os-installation/installation-with-graphical-installer/run-installer-program

When using an XML file for reinstallation, the private certificate password is not included for security. This snippet shows how to manually add the 'certPwd' entry with your password into the XML file before using it.

```xml
<entry key="certPwd" value="[YOUR-PASSWORD]"/>
```

--------------------------------

### Create Directories for Persistent Storage (Bash)

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/manual-initial-configuration-with-crid-otp

This snippet demonstrates how to create two essential directories for the sedex-Client's persistent storage on the host machine. These directories, 'sedex-interface' and 'sedex-data', will be mounted into the Docker container.

```bash
mkdir /path/to/sedex-interface
mkdir /path/to/sedex-data
```

```bash
mkdir /home/data/sedex-interface-1-1234-1
mkdir /home/data/sedex-data-1-1234-1
```

--------------------------------

### Encode P12 Keystore to Base64 in Linux

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/scripted-initial-configuration-with-certificate

This command reads a P12 keystore file and outputs its content as a base64-encoded string. This is required for passing the keystore securely as an environment variable to the sedex-Client initialization script. Ensure the file path is correct and the file is accessible.

```shell
$ cat YOUR-CERTIFICATE-FILE.p12 | base64 -w 0
```

```shell
$ cat /home/data/credentials/1-1234-1.p12 | base64 -w 0
```

--------------------------------

### Enable sedex Web Service Proxy Configuration

Source: https://docs.sedex.admin.ch/web-service-proxy/install-and-enable

This configuration snippet shows how to enable the sedex Web Service Proxy by setting the 'wsproxy.start' property to 'true'. A restart is required for changes to take effect. This configuration is part of the sedex-Client's properties file.

```properties
[...]
wsproxy.start=true
[...]
```

--------------------------------

### Run sedex-Client Initialization Script with Existing Certificate

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/scripted-initial-configuration-with-certificate

This command executes the sedex-Client Docker container for initial configuration using an existing P12 certificate. It mounts host directories for persistent data, sets essential environment variables for the sedex ID, keystore content, and password, and then runs the initialization script. Ensure all paths and credentials are correct.

```shell
  $ docker run \
   --rm \
   --mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
   --mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
   --env SEDEX_ID=YOUR-SEDEX-ID \
   --env SEDEX_KEYSTORE=CONTENT-OF-YOUR-CERTIFICATE-FILE \
   --env SEDEX_KEYSTORE_PASSWORD=YOUR-PASSWORD \
   sedexch/sedex-client:container-1.1 init-script-existing-cert.sh
```

```shell
  $ docker run \
   --rm \
   --mount type=bind,source=/home/data/sedex-interface-1-1234-1,destination=/sedex-interface/ \
   --mount type=bind,source=/home/data/sedex-data-1-1234-1,destination=/sedex-data/ \
   --env SEDEX_ID=1-1234-1 \
   --env SEDEX_KEYSTORE=MIIHdgIBAzCCBzwGCSqGSIb3DQEHAaCCBy0EggcpMII[.....]wQIs0UZdpNO54oCAggA \
   --env SEDEX_KEYSTORE_PASSWORD=ALFJZIPNXG \
   sedexch/sedex-client:container-1.1 init-script-existing-cert.sh
```

--------------------------------

### SEDEX Admin API: Retrieve Envelope Example (JSON Response)

Source: https://docs.sedex.admin.ch/reference/messaging-rest-api-specification

This is an example of a successful JSON response when retrieving an individual SEDEX message envelope. It showcases the structure and typical values for fields such as document type, sender ID, recipient IDs, message type, and timestamps. Note that this example is auto-generated and may not be fully accurate; refer to the schema for definitive details.

```json
{
    "document-type": "envelope",
    "document-version": "1.0",
    "sender-id": "1-123-1",
    "recipient-ids": [
        "1-123-1"
    ],
    "message-type": 4711,
    "message-class": 0,
    "message-id": "08989cf0-d239-47a9-8cb0-54cd8be5e62d",
    "reference-message-id": "string",
    "message-date": "2022-04-13T15:42:05.901Z",
    "event-date": "2022-04-13T15:42:05.901Z",
    "loopback": false,
    "test-data": {
        "Optional test data key 1": "test-value 1 (normally test-data is not used)",
        "Optional test data key 2": "test-value 2"
    }
}

```

--------------------------------

### Docker Pull Command for Sedex Client Image

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-2-run/create-and-run

This command downloads the latest 'sedexch/sedex-client:container-1.1' Docker image from Docker Hub. It ensures the local environment has the necessary image to run the sedex client. The output confirms the successful download and status of the image layers.

```bash
user@ubuntu:~$ docker pull sedexch/sedex-client:container-1.1
latest: Pulling from sedexch/sedex-client
5843afab3874: Already exists 
8ad21265f689: Pull complete 
2e2eedfb8a20: Pull complete 
758917ddf915: Pull complete 
cec77cd3ca0e: Pull complete 
851831761fc3: Pull complete 
6e67829da275: Pull complete 
8b4ce7ee2e79: Pull complete 
3054efc41fea: Pull complete 
8e5f19c592ab: Pull complete 
f4033818fedc: Pull complete 
d2beedbac7c4: Pull complete 
50c17722356b: Pull complete 
e24d112671fd: Pull complete 
Digest: sha256:1bf69975acaa4fcea3c194e8390e823905c8fd77a172a514291b9f71d4d93fd6
Status: Downloaded newer image for sedexch/sedex-client:container-1.1


```

--------------------------------

### Example Sedex Message Status Response (200 OK)

Source: https://docs.sedex.admin.ch/reference/messaging-rest-api-specification

An example JSON structure for a successful response when querying the status of a Sedex message. It includes message identifiers, envelope details, payload information, and comprehensive current status, including overall status and status broken down by recipient.

```JSON
{
    "document-type": "string",
    "document-version": "string",
    "unique-sedex-message-id": 30,
    "envelope": {
        "document-type": "envelope",
        "document-version": "1.0",
        "sender-id": "1-123-1",
        "recipient-ids": [
            "1-123-1"
        ],
        "message-type": 4711,
        "message-class": 0,
        "message-id": "08989cf0-d239-47a9-8cb0-54cd8be5e62d",
        "reference-message-id": "string",
        "message-date": "2022-04-13T15:42:05.901Z",
        "event-date": "2022-04-13T15:42:05.901Z",
        "loopback": false,
        "test-data": {
            "Optional test data key 1": "test-value 1 (normally test-data is not used)",
            "Optional test data key 2": "test-value 2"
        }
    },
    "payload": {
        "size-in-bytes": 185
    },
    "current-status": {
        "overall": {
            "status": "string",
            "last-status-change": "2022-04-13T15:42:05.901Z",
            "registered-at": "2022-04-13T15:42:05.901Z",
            "completed-at": "2022-04-13T15:42:05.901Z",
            "delivery": "string"
        },
        "status-per-recipient": [
            {
                "recipient-id": "string",
                "status": "string",
                "last-status-change": "2022-04-13T15:42:05.901Z",
                "delivered-at": "2022-04-13T15:42:05.901Z",
                "final-state-code": 185,
                "final-state-information": "string"
            }
        ]
    }
}
```

--------------------------------

### Run sedex-Client Container with Environment Variables

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/configuration-options/how-to-configure

This snippet demonstrates how to run a new sedex-Client Docker container, applying custom configuration parameters as environment variables. It includes pulling the latest container image, stopping and removing any existing container, and then starting a new one with specified mounts, ports, and environment variables. Environment variables set here take precedence over the configuration file.

```bash
$ docker stop sedex-client
$ docker rm sedex-client

```

```bash
$ docker pull sedexch/sedex-client:container-1.1

```

```bash
$ docker run \
  --name sedex-client \
  --mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
  --mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
  --publish YOUR_MONITORING_PORT:8000 \
  --publish YOUR_WS_PROXY_HTTP_PORT:8080 \
  --publish YOUR_WS_PROXY_HTTPS_PORT:8443 \
  --stop-timeout 65 \
  --restart unless-stopped \
  --read-only \
  -d \
  --env KEY_NAME_1=VALUE_1 \
  --env KEY_NAME_2=VALUE_2 \
  sedexch/sedex-client:container-1.1

```

--------------------------------

### Docker Run Scripted Initial Configuration Template

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/getting-up-and-running/phase-1-initial-configuration/scripted-initial-configuration-with-crid-otp

This Docker command template initializes the sedex-Client container using a scripted approach. It mounts host directories for persistent storage and sets environment variables for participant ID, CRID, OTP, and optional proxy settings. The `init-script-new-cert.sh` script is executed to create configuration files. Ensure to replace placeholder values with your specific details.

```bash
docker run \
   --rm \
   --mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
   --mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
   --env SEDEX_ID=YOUR-SEDEX-ID \
   --env SEDEX_CRID=YOUR-CERTIFICATE-REQUEST-ID \
   --env SEDEX_OTP=YOUR-ONE-TIME-PASSWORD \
   sedexch/sedex-client:container-1.1 init-script-new-cert.sh
```

--------------------------------

### GET /pre-check

Source: https://docs.sedex.admin.ch/reference/messaging-rest-api-specification

Performs a pre-check to determine if a message can be sent.

```APIDOC
## GET /pre-check

### Description
Performs a pre-check to determine if a message can be sent.

### Method
GET

### Endpoint
/pre-check

### Parameters
#### Query Parameters
- **document-type** (string) - Required - The type of the document.
- **document-version** (string) - Required - The version of the document.
- **sender-id** (string) - Required - The ID of the sender.
- **recipient-id** (string) - Required - The ID of the recipient.

### Response
#### Success Response (200)
- **preCheckResponse** (PreCheckResponse) - The result of the pre-check.

#### Response Example
```json
{
  "preCheckResponse": {
    "allowed-to-send": true,
    "document-type": "string",
    "document-version": "string",
    "message-authorisation-result": {
      "overall": {
        "authorization-code": 0,
        "authorization-info": "string",
        "is-authorized": true
      },
      "per-recipient": {}
    }
  }
}
```
```

--------------------------------

### Example Sedex Test Message Envelope

Source: https://docs.sedex.admin.ch/reference/test-message

A concrete example of a filled XML envelope for a sedex test message. This demonstrates the expected format for fields like messageId, messageType, senderId, recipientId, eventDate, and messageDate. Replace these values with actual test data.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<envelope xmlns="http://www.ech.ch/xmlns/eCH-0090/1" version="1.0">
    <messageId>TestMessage01</messageId>
    <messageType>1234</messageType>
    <messageClass>0</messageClass>
    <senderId>1-1234-1</senderId>
    <recipientId>1-1234-1</recipientId>
    <eventDate>2023-12-31T23:00:00.000+02:00</eventDate>
    <messageDate>2023-12-31T23:00:00.000+02:00</messageDate>
</envelope>

```

--------------------------------

### Kubernetes Deployment for Sedex Admin Ch

Source: https://docs.sedex.admin.ch/installation-and-operation/container-installation/orchestration/sample-deployment

This Kubernetes Deployment manifest defines how to deploy the Sedex Admin Ch application. It specifies the container image, replicas, volumes, ports, and readiness/liveness probes. Ensure that persistent volume claims and the container image are correctly configured.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: sedex-client-1-1234-1-deployment
  namespace: sedex
  labels:
    app: sedex-client-1-1234-1
spec:
  replicas: 1
  strategy:
    type: Recreate
  selector:
    matchLabels:
      app: sedex-client-1-1234-1
  template:
    metadata:
      labels:
        app: sedex-client-1-1234-1
    spec:
      volumes:
        - name: sedex-client-1-1234-1-data-volume
          persistentVolumeClaim:
            claimName:  sedex-client-1-1234-1-data-pvc
        - name: sedex-client-1-1234-1-interface-volume
          persistentVolumeClaim:
            claimName:  sedex-client-1-1234-1-interface-pvc
      containers:
      - name: sedex-client
        image: sedexch/sedex-client:container-1.1
        ports:
        - containerPort: 8000
        - containerPort: 8080
        - containerPort: 8443
        volumeMounts:
        - mountPath: "/sedex-data"
          name: sedex-client-1-1234-1-data-volume
        - mountPath: "/sedex-interface"
          name: sedex-client-1-1234-1-interface-volume
        securityContext:
          allowPrivilegeEscalation: false
          readOnlyRootFilesystem: true
          runAsUser: 1000
          runAsGroup: 1000
        startupProbe:
          exec:
            command:
              - ./scripts/health/check-processes.sh
          initialDelaySeconds: 10
          failureThreshold: 10
          periodSeconds: 5
        livenessProbe:
          exec:
            command:
              - ./scripts/health/check-processes.sh
          failureThreshold: 3
          periodSeconds: 5
        readinessProbe:
          exec:
            command:
              - ./scripts/health/check-readiness.sh
          failureThreshold: 3
          periodSeconds: 5

```

--------------------------------

### Sedex Client Web Service Definition Example

Source: https://docs.sedex.admin.ch/web-service-proxy/provided-web-services

This snippet illustrates the configuration details for a specific Web service, 'CheckSedexWebService', as viewed on the sedex-Client's monitoring page. It includes the HTTP and HTTPS addresses for accessing the service via the proxy, user access configurations, and the target path on the provider.

```text
[...]
wsproxy-webservice-CheckSedexWebService-address-http=http://localhost:8080/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-address-https=https://localhost:8443/wsproxy/services/CheckSedexWebService
wsproxy-webservice-CheckSedexWebService-users=anonymous, authenticated
wsproxy-webservice-CheckSedexWebService-target=https://sedex-service.admin.ch:443/sedex-clientServices-ws/CheckSedexWebService
[...]
```

--------------------------------

### GET /tracking/{uniqueSedexMessageId}

Source: https://docs.sedex.admin.ch/reference/messaging-rest-api-specification

Retrieves tracking information for a specific Sedex message.

```APIDOC
## GET /tracking/{uniqueSedexMessageId}

### Description
Retrieves tracking information for a specific Sedex message.

### Method
GET

### Endpoint
/tracking/{uniqueSedexMessageId}

### Parameters
#### Path Parameters
- **uniqueSedexMessageId** (integer(int64)) - Required - The unique identifier for the message.

### Response
#### Success Response (200)
- **trackingInformation** (TrackingInformation) - The tracking details of the message.

#### Response Example
```json
{
  "trackingInformation": {
    "current-status": {
      "overall": {
        "status-per-recipient": [
          {
            "delivered-at": "2023-10-27T10:00:00Z",
            "final-state-code": 0,
            "final-state-information": "string",
            "last-status-change": "2023-10-27T10:00:00Z",
            "recipient-id": "string",
            "status": "string"
          }
        ],
        "overall": {
          "status-per-recipient": [
            {
              "delivered-at": "2023-10-27T10:00:00Z",
              "final-state-code": 0,
              "final-state-information": "string",
              "last-status-change": "2023-10-27T10:00:00Z",
              "recipient-id": "string",
              "status": "string"
            }
          ]
        }
      },
      "status-per-recipient": [
        {
          "delivered-at": "2023-10-27T10:00:00Z",
          "final-state-code": 0,
          "final-state-information": "string",
          "last-status-change": "2023-10-27T10:00:00Z",
          "recipient-id": "string",
          "status": "string"
        }
      ]
    },
    "document-type": "string",
    "document-version": "string",
    "envelope": {
      "document-type": "string",
      "document-version": "string",
      "event-date": "2023-10-27T10:00:00Z",
      "loopback": true,
      "message-class": 0,
      "message-date": "2023-10-27T10:00:00Z",
      "message-id": "string",
      "message-type": 0,
      "recipient-ids": [
        "string"
      ],
      "reference-message-id": "string",
      "sender-id": "string",
      "test-data": {
        "additionalProperties": "string"
      }
    },
    "payload": {
      "size-in-bytes": 0
    },
    "unique-sedex-message-id": 0
  }
}
```
```
Tokens:
Raw