Managing Devo Relay on the command line
Introduction
Ubuntu / Red Hat / CentOS | The relay is a Java process that runs as a service in the machine and is managed by the system manager systemd. |
---|---|
docker-compose | The provided docker-compose file contains two services (devo-ng-relay and devo-ng-relay-cli). Note that the CLI service does not need to be running all the time - it will just run while the CLI is in use. Find below the commands that can be used to perform the most common operations. You must be in the same folder where the .yml file is located to run these commands. |
Start the relay
To start your relay, use the required command according to your OS:
Ubuntu / Red Hat / CentOS | sudo systemctl start devo-ng-relay |
---|---|
docker-compose | docker-compose run --rm devo-ng-relay-cli |
Stop the relay
You can stop your relay process using these commands:
Ubuntu / Red Hat / CentOS | sudo systemctl stop devo-ng-relay |
---|---|
docker-compose |
Restart the relay
Restart a relay process using these commands:
Ubuntu / Red Hat / CentOS | |
---|---|
docker-compose |
Check the status of the relay service
You can check the status of the relay Java service using this command:
Ubuntu / Red Hat / CentOS | Note that this command checks the status of the service that runs the relay, not the relay itself. To check the status of your current relay, you must use the relay CLI. Learn more in Working with the Devo Relay CLI. |
---|
Check the relay logs
As the relay runs as a systemd
service, the logs can be consulted using the following commands:
Ubuntu / Red Hat / CentOS | You can use the -f flag to actively follow the logs as they are being written |
---|---|
docker-compose | You can use the -f flag to actively follow the logs as they are being written |
Upgrade the relay
Use the following commands to update your relay and CLI to the last version available:
Ubuntu | |
---|---|
Red Hat / CentOS | |
docker-compose |
|
Uninstall the relay
Use the following commands to uninstall the relay from your machine:
Ubuntu | |
---|---|
Red Hat / CentOS | |
docker-compose |