| ... | @@ -51,6 +51,7 @@ To begin the setup, ensure you have the following: |
... | @@ -51,6 +51,7 @@ To begin the setup, ensure you have the following: |
|
|
# How to setup
|
|
# How to setup
|
|
|
### A - Admin User
|
|
### A - Admin User
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
As a best practice, create a dedicated user with appropriate privileges as the first step for enhanced security and adherence to the principle of least privilege.
|
|
As a best practice, create a dedicated user with appropriate privileges as the first step for enhanced security and adherence to the principle of least privilege.
|
|
|
|
|
|
|
|
- Create an admin username of your choice.
|
|
- Create an admin username of your choice.
|
| ... | @@ -72,6 +73,7 @@ sudo systemctl restart ssh |
... | @@ -72,6 +73,7 @@ sudo systemctl restart ssh |
|
|
```
|
|
```
|
|
|
### B - Docker group
|
|
### B - Docker group
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
For better security, run Docker as a regular user. By default, Docker requires root privileges `sudo`. Follow these steps:
|
|
For better security, run Docker as a regular user. By default, Docker requires root privileges `sudo`. Follow these steps:
|
|
|
|
|
|
|
|
- Create a `docker` group if it doesn't exist.
|
|
- Create a `docker` group if it doesn't exist.
|
| ... | @@ -89,6 +91,7 @@ newgrp docker |
... | @@ -89,6 +91,7 @@ newgrp docker |
|
|
|
|
|
|
|
## 1 - Docker Compose
|
|
## 1 - Docker Compose
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
Access your server using SSH.
|
|
Access your server using SSH.
|
|
|
Consider creating the **`{DOMIBUS_SERVER_DIRECTORY}`** in the **`/opt/`** folder. Within this directory, establish a `compose.yaml` file containing the following content:
|
|
Consider creating the **`{DOMIBUS_SERVER_DIRECTORY}`** in the **`/opt/`** folder. Within this directory, establish a `compose.yaml` file containing the following content:
|
|
|
|
|
|
| ... | @@ -161,6 +164,7 @@ docker compose up -d |
... | @@ -161,6 +164,7 @@ docker compose up -d |
|
|
The startup process may take 2-5 minutes. Once completed, you can verify that your Domibus server is running by accessing on your personal computer by opening a navigator through the following URL:
|
|
The startup process may take 2-5 minutes. Once completed, you can verify that your Domibus server is running by accessing on your personal computer by opening a navigator through the following URL:
|
|
|
|
|
|
|
|
:computer:
|
|
:computer:
|
|
|
|
|
|
|
```http
|
|
```http
|
|
|
http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus
|
|
http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus
|
|
|
```
|
|
```
|
| ... | @@ -169,6 +173,7 @@ http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus |
... | @@ -169,6 +173,7 @@ http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus |
|
|
|
|
|
|
|
## 2 - Self-Signed Certificate
|
|
## 2 - Self-Signed Certificate
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
> :warning: **Attention**:
|
|
> :warning: **Attention**:
|
|
|
Self-signed certificates are intended for testing purposes only and should not be used in production. For production use, consider obtaining certificates from a trusted certificate provider. Additional information on certificate providers can be found [here](https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/PKI+Service).
|
|
Self-signed certificates are intended for testing purposes only and should not be used in production. For production use, consider obtaining certificates from a trusted certificate provider. Additional information on certificate providers can be found [here](https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/PKI+Service).
|
|
|
|
|
|
| ... | @@ -209,6 +214,7 @@ Attach the certificate file, `{DOMIBUS_ACCESS_POINT}.cer`, generated in your **` |
... | @@ -209,6 +214,7 @@ Attach the certificate file, `{DOMIBUS_ACCESS_POINT}.cer`, generated in your **` |
|
|
You may need to use `scp` on your PC to copy this file from the server to your personal computer. For example:
|
|
You may need to use `scp` on your PC to copy this file from the server to your personal computer. For example:
|
|
|
|
|
|
|
|
:computer:
|
|
:computer:
|
|
|
|
|
|
|
```shell
|
|
```shell
|
|
|
scp {ADMIN_USER}@{DOMIBUS_HOSTNAME}:/opt/{DOMIBUS_SERVER_DIRECTORY}/domibus/keystores/{DOMIBUS_ACCESS_POINT}.cer /path/on/your/personal/computer
|
|
scp {ADMIN_USER}@{DOMIBUS_HOSTNAME}:/opt/{DOMIBUS_SERVER_DIRECTORY}/domibus/keystores/{DOMIBUS_ACCESS_POINT}.cer /path/on/your/personal/computer
|
|
|
```
|
|
```
|
| ... | @@ -220,6 +226,7 @@ This step ensures that you have a local copy of the certificate file for further |
... | @@ -220,6 +226,7 @@ This step ensures that you have a local copy of the certificate file for further |
|
|
|
|
|
|
|
## 3 - Domibus Properties
|
|
## 3 - Domibus Properties
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
In the file **`{DOMIBUS_SERVER_DIRECTORY}/domibus/domibus.properties`**, locate the section labeled `Keystore/Truststore (Single Tenancy)` and set the passwords you configured on the previous step:
|
|
In the file **`{DOMIBUS_SERVER_DIRECTORY}/domibus/domibus.properties`**, locate the section labeled `Keystore/Truststore (Single Tenancy)` and set the passwords you configured on the previous step:
|
|
|
|
|
|
|
|
```properties
|
|
```properties
|
| ... | @@ -253,6 +260,7 @@ While you might consider creating a `PKCS12` KeyStore, please be aware that it c |
... | @@ -253,6 +260,7 @@ While you might consider creating a `PKCS12` KeyStore, please be aware that it c |
|
|
|
|
|
|
|
## 4 - Users Credentials
|
|
## 4 - Users Credentials
|
|
|
:globe_with_meridians:
|
|
:globe_with_meridians:
|
|
|
|
|
|
|
Within the directory or any of its subdirectories of the **`{DOMIBUS_SERVER_DIRECTORY}`**, restart your Domibus server by doing the command:
|
|
Within the directory or any of its subdirectories of the **`{DOMIBUS_SERVER_DIRECTORY}`**, restart your Domibus server by doing the command:
|
|
|
```shell
|
|
```shell
|
|
|
docker compose restart
|
|
docker compose restart
|
| ... | @@ -264,6 +272,7 @@ http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus |
... | @@ -264,6 +272,7 @@ http://{DOMIBUS_HOSTNAME}:{DOMIBUS_PORT}/domibus |
|
|
```
|
|
```
|
|
|
### A - Dashboard Users
|
|
### A - Dashboard Users
|
|
|
:computer:
|
|
:computer:
|
|
|
|
|
|
|
Access the Domibus Admin Console using the default credentials:
|
|
Access the Domibus Admin Console using the default credentials:
|
|
|
```
|
|
```
|
|
|
Username: admin
|
|
Username: admin
|
| ... | @@ -277,6 +286,7 @@ Alternatively, user management can be performed in the `Users` section of the le |
... | @@ -277,6 +286,7 @@ Alternatively, user management can be performed in the `Users` section of the le |
|
|
|
|
|
|
|
### B - Plugin Users
|
|
### B - Plugin Users
|
|
|
:computer:
|
|
:computer:
|
|
|
|
|
|
|
A plugin user, specifically utilized for eDelivery message exchange through our Connector API, can be added in the `Plugin Users` section. To do so, navigate to this section, click on `+ New`, and provide the desired username, password, and role.
|
|
A plugin user, specifically utilized for eDelivery message exchange through our Connector API, can be added in the `Plugin Users` section. To do so, navigate to this section, click on `+ New`, and provide the desired username, password, and role.
|
|
|
|
|
|
|
|
Make sure that you save your modification.
|
|
Make sure that you save your modification.
|
| ... | @@ -288,6 +298,7 @@ For the French-Connector, you might create a user named `frc_user`. |
... | @@ -288,6 +298,7 @@ For the French-Connector, you might create a user named `frc_user`. |
|
|
|
|
|
|
|
## 5 - Processing Modes
|
|
## 5 - Processing Modes
|
|
|
:computer:
|
|
:computer:
|
|
|
|
|
|
|
Processing Modes _PModes_ configure Access Points by loading parameters via an XML file. Please perform this task from your personal computer
|
|
Processing Modes _PModes_ configure Access Points by loading parameters via an XML file. Please perform this task from your personal computer
|
|
|
|
|
|
|
|
Start by downloading the PMode template file [pmode.xml](https://drive.google.com/file/d/1onmrwqKYcVeTwSZLzzD0WrYd9ndJbLxW/view?usp=drive_link). After downloading, replace the variables in the file with the appropriate values for your configuration. Once modified, proceed to upload the file under:
|
|
Start by downloading the PMode template file [pmode.xml](https://drive.google.com/file/d/1onmrwqKYcVeTwSZLzzD0WrYd9ndJbLxW/view?usp=drive_link). After downloading, replace the variables in the file with the appropriate values for your configuration. Once modified, proceed to upload the file under:
|
| ... | @@ -333,15 +344,21 @@ You are now able to communicate with the Access Point you just added. |
... | @@ -333,15 +344,21 @@ You are now able to communicate with the Access Point you just added. |
|
|
Verify on the `Parties` tab to ensure that all parties are configured correctly.
|
|
Verify on the `Parties` tab to ensure that all parties are configured correctly.
|
|
|
|
|
|
|
|
# Testing Configuration
|
|
# Testing Configuration
|
|
|
Congratulations on successfully setting up your Domibus server. To ensure everything is functioning correctly, let's proceed with testing. Please run all the tests on your personal computer :computer:
|
|
:computer:
|
|
|
|
|
|
|
|
Congratulations on successfully setting up your Domibus server. To ensure everything is functioning correctly, let's proceed with testing.
|
|
|
|
|
|
|
|
### 1 - Console Monitoring test
|
|
### 1 - Console Monitoring test
|
|
|
|
:computer:
|
|
|
|
|
|
|
In the Domibus Console, navigate to the `Connection Monitoring` section and try sending a message to your own Access Point and to `europe_ap`. If the status shows as green for both, your Domibus server is ready for message exchange.
|
|
In the Domibus Console, navigate to the `Connection Monitoring` section and try sending a message to your own Access Point and to `europe_ap`. If the status shows as green for both, your Domibus server is ready for message exchange.
|
|
|
|
|
|
|
|

|
|

|
|
|
|
|
|
|
|
### 2- SoapUI test
|
|
### 2- SoapUI test
|
|
|
To perform testing with SoapUI, follow these steps:
|
|
:computer:
|
|
|
|
|
|
|
|
To perform testing with SoapUI, follow these steps on your personal computer:
|
|
|
|
|
|
|
|
##### A - Install SoapUI:
|
|
##### A - Install SoapUI:
|
|
|
- Ensure you have the latest version of [SoapUI](https://www.soapui.org/) installed on your PC.
|
|
- Ensure you have the latest version of [SoapUI](https://www.soapui.org/) installed on your PC.
|
| ... | |
... | |
| ... | | ... | |