Setup

Download the opendut-edgar binary for your target from the openDuT GitHub project: https://github.com/eclipse-opendut/opendut/releases
Unpack the archive on your target system.
If you want to use CAN, follow the steps in CAN Setup before continuing.
If you want to use a self-hosted backend server without DNS name or with a self-signed certificate, follow the steps in Self-Hosted Backend Server before continuing.
EDGAR comes with a scripted setup, which you can initiate by running:
```
opendut-edgar setup managed <SETUP-STRING>
```

You can get the <SETUP-STRING> from LEA or CLEO after creating a Peer.

This will configure your operating system and start the EDGAR Service, which will receive its configuration from CARL.

Download EDGAR from CARL

You can download the EDGAR binary as tarball from one of CARLs endpoints.

The archive can be requested at https://{CARL-HOST}/api/edgar/{architecture}/download.

Available architectures are:

x86_64-unknown-linux-gnu
armv7-unknown-linux-gnueabihf
aarch64-unknown-linux-gnu

Once downloaded, extract the files with the command tar xvf opendut-edgar-{architecture}.tar.gz. It will then be extracted into the folder which is the current work directory. You might want to use another directory of your choice.

CAN Setup

Only if you want to use CAN, it is mandatory to set the environment variable OPENDUT_EDGAR_SERVICE_USER.
```
export OPENDUT_EDGAR_SERVICE_USER=root
```

It is possible that there are no bridges configured, in that case use those two commands:

# Replace vcan0 with your bridge name
ip link add dev vcan0 type vcan
ip link set dev vcan0 up

Install wireguard-tools:

sudo apt install wireguard-tools
# You can use it with `sudo wg`
# To view a more comprehensive information use `/opt/opendut/edgar/netbird/netbird status -d`

Test CAN connection with multiple EDGARs, execute on EDGAR leader:
```
candump -d can0
```
On EDGAR peer execute:
```
cansend can0 01a#01020304
```
Now you should see a can frame on leader side:
```
root@host:~# candump -d can0
can0  01A   [4]  01 02 03 04
```

Cannelloni

Install the following packages:

sudo apt install -y python3-can can-utils

Download Cannelloni from here: https://github.com/eclipse-opendut/cannelloni/releases/

Unpack the Cannelloni tarball and copy the files into your filesystem like so:

sudo cp libcannelloni-common.so.0 /lib/
sudo cp libsctp.so* /lib/
sudo cp cannelloni /usr/local/bin/

Self-Hosted Backend Server

DNS

If your backend server does not have a public DNS entry, you will need to adjust the /etc/hosts/ file, by appending entries like this (using your server's IP address):

123.456.789.101 opendut.local
123.456.789.101 carl.opendut.local
123.456.789.101 auth.opendut.local
123.456.789.101 netbird.opendut.local
123.456.789.101 netbird-api.opendut.local
123.456.789.101 signal.opendut.local

Now the following command should complete without errors:

ping carl.opendut.local

Self-Signed Certificate with Unmanaged Setup

If you plan to use the unmanaged setup and your NetBird server uses a self-signed certificate, follow these steps:

Create the certificate directory on the OLU: mkdir -p /usr/local/share/ca-certificates/
Copy your NetBird server certificate onto the OLU, for example, by running the following from outside the OLU:
```
scp certificate.crt root@10.10.4.1:/usr/local/share/ca-certificates/
```
Ensure that the certificate has a file extension of "crt".
Run update-ca-certificates on the OLU.
It should output "1 added", if everything works correctly.
Now the following commands should complete without errors:
```
curl https://netbird-api.opendut.local
```

Troubleshooting

In case of issues during the managed setup see:
```
journalctl -u opendut-edgar.service
```

Sometimes it might be necessary to stop and re-start the EDGAR service:

# Stop service
sudo systemctl stop opendut-edgar.service
# Start service
sudo systemctl start opendut-edgar.service
# Restart service
sudo systemctl restart opendut-edgar.service
# Check status
systemctl status opendut-edgar.service

Netbird service on host machine. It might happen that Netbird is not able to connect, in that case stop it and re-run EDGAR managed setup:
```
# Stop service
sudo systemctl stop netbird.service
# Start service
sudo systemctl start netbird.service
```

More log files / statements can be found in the corresponding Docker containers:

docker logs localenv-keycloak-1
docker logs localenv-carl-1
# To display all running containers use:
docker ps

Netbird logs are available on host machine

cat /var/lib/netbird/client.log
cat /var/lib/netbird/netbird.err
cat /var/lib/netbird/netbird.out

EDGAR might start with an old IP, different from command sudo wg would print. In that particular case stop netbird service and opendut-edgar service and re-run the setup. This might happen to all EDGARs. If this is not enough, and it keeps getting the old IP, it is necessary to set up all devices and clusters from scratch.
```
sudo wg
```

If this ERROR appears: ERROR opendut_edgar::service::cannelloni_manager: Failed to start cannelloni instance for remote IP 100.80.171.237: 'No such file or directory (os error 2)'. (OPTIONAL) Copy cannelloni to custom location. This is the way to go, if the step before is not possible to be done. This can happen for whatever reason, i.e. missing root rights.

export LD_LIBRARY_PATH=/your-path-to-cannelloni/cannelloni (just folder, not the binary)
export PATH={all_other_PATH_variables}:/your-path-to-cannelloni/cannelloni
vim /etc/systemd/system/opendut-edgar.service 
systemctl daemon-reload
systemctl restart opendut-edgar.service

Copy the two Environment variables into your opendut-edgar.service file.

[Unit]
...

[Service]
...
Environment="LD_LIBRARY_PATH=/opt/opendut/edgar/cannelloni"
Environment="PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/opendut/edgar/cannelloni"


[Install]
...

openDuT