Self-hosted edition

Connecting agents

Install the ords-agent package on every Oracle REST Data Services server you want to monitor. The agent connects out to the server over one WebSocket; nothing connects in to the ORDS host.

1. Install the agent

sudo dnf install ./ords-agent-*.x86_64.rpm

The installer runs the agent as the OS user that owns ORDS: if an oracle user exists it is used, otherwise a dedicated ords-agent account. The agent never runs as root — it needs exactly the rights of the ORDS owner to start and stop ORDS and read its configuration and logs.

2. Run the guided setup

sudo ords-agent setup

It asks for the server URL (ws://<server>:3000/agent-ws, or wss:// behind HTTPS) and a one-time enrollment token from Settings → Agents, writes /etc/ords-agent/ords-agent.env, and tests the connection. Then:

sudo ords-agent instances:add --id ords-01 --name Production \
     --bin /opt/oracle/ords/bin/ords --config /etc/ords/config --logdir /opt/oracle/ords/logs
sudo systemctl enable --now ords-agent

Within a few seconds the agent appears on the dashboard's Agents page and its instances start reporting.

Checking an agent

sudo systemctl status ords-agent
sudo journalctl -u ords-agent -f

sudo ords-agent status shows whether the agent is enrolled and which instances it manages; sudo ords-agent help lists every command.