Update the Edge wrapper

The Update button on the Edges page updates the Edge software that runs inside the Edge. Some releases also change the wrapper: the outer xyte_edge container that runs on your machine. The Release Notes list these under Wrapper Changes. A wrapper change reaches your Edge only when you re-create the container on the host. Your Edge keeps its Edge ID, devices and history.

⚠️

This interrupts monitoring

While the container is re-created, the Edge is offline: every device behind it stops reporting, and you may see offline incidents. It usually takes a few minutes. Plan it for a maintenance window and let the people who watch these rooms know in advance.

Before you start

You need access to the machine that runs the Edge, and the folder you installed it from: the one that holds the edge_data folder. edge_data keeps your Edge ID. As long as you re-create the container from that same folder, the Edge reconnects as itself.

Check you're in the right folder: it must contain edge_data/proxy_name.txt, and that file must hold your Edge ID (portal → Edges → ⋯ → Edit Edge → Edge ID).

🚧

Can't find the edge_data folder?

Don't continue. Re-creating the container without it creates a new Edge. Follow Recover an Edge agent instead: it brings the Edge back under its original Edge ID.

Update the wrapper

In a terminal, go to the install folder and run:

cd <your install folder>          # the folder that contains edge_data
cat edge_data/proxy_name.txt      # must print your Edge ID
docker rm -f xyte_edge
source <(curl -sS https://raw.githubusercontent.com/xyte-io/edge/refs/heads/main/edge_runner_script.sh)

The script pulls the latest wrapper and starts it with your existing edge_data. It prints your Edge ID when it's ready: it must match the one you checked.

Verify

Within a few minutes the Edge shows Online on the Edges page under the same Edge ID, and its devices reconnect on their own.

If a new Edge appears instead, the container started without your original edge_data. Follow Recover an Edge agent to point it back at your original Edge ID.


Did this page help you?