Update Agentivity and back up your data

This page is for the Community edition, which you install yourself. In a hosted workspace Agentivity updates the product for you, and announces it in the Studio: see When your workspace sleeps or is updated. Agentivity backs up a hosted workspace every day and keeps the backups for 7, 14 or 30 days, according to the plan: to restore one, write to security@agentivity.io. To keep a copy of your own, the owner uses Administration > Data > Export: see Workspace panes.

Everything you build in Agentivity is kept in one Docker volume. This page shows how to copy it to a file, how to bring it back, and how to update Agentivity.

A Docker volume is a storage space that Docker keeps apart from the container. It stays when the container is removed.

• Agentivity installed as in Install Agentivity with Docker: a container named agentivity, and a volume named agentivity-data.
• A terminal on the machine where Agentivity runs.

The backup file holds your credentials. Keep it as carefully as a password.

1. Stop Agentivity, so that nothing changes during the copy.

   docker stop agentivity

2. Copy the volume into a file in the current folder.

   docker run --rm -v agentivity-data:/data:ro -v "$(pwd):/backup" alpine tar czf /backup/agentivity-data.tar.gz -C /data .

3. Start Agentivity again.

   docker start agentivity

The second command starts a small temporary container that reads the volume and writes the file agentivity-data.tar.gz. On Windows, run it in PowerShell or in Git Bash.

How to know it worked: the file agentivity-data.tar.gz is in the current folder, and it is not empty.

To bring a backup back, on the same machine or on another one:

1. Stop and remove the container, if there is one.

   docker rm -f agentivity

2. Fill the volume from the file. Run this in the folder that holds the file.

   docker run --rm -v agentivity-data:/data -v "$(pwd):/backup" alpine tar xzf /backup/agentivity-data.tar.gz -C /data

3. Start Agentivity with the usual command.

   docker run -d --name agentivity -p 5005:5005 -v agentivity-data:/app/_data agentivitylabs/agentivity

If the volume already holds data, the files of the backup replace the files that have the same name. To start clean, remove the volume first with docker volume rm agentivity-data. This deletes what it holds.

1. Back up, as above.

2. Get the new image.

   docker pull agentivitylabs/agentivity

3. Remove the old container. The volume is kept.

   docker rm -f agentivity

4. Start Agentivity with the usual command.

   docker run -d --name agentivity -p 5005:5005 -v agentivity-data:/app/_data agentivitylabs/agentivity

How to know it worked: open the Studio. Your agents, teams and workflows are in their lists.

• “The container name “/agentivity” is already in use.” The old container still exists. Run docker rm -f agentivity, then start again.
• The Studio is empty after an update. The container was started without the volume, or with another volume name. Check that the command has -v agentivity-data:/app/_data.

• Removing the container does not remove your data. Removing the volume does.
• What is not in the volume is not kept across an update: the log files. The execution history, the conversations of past executions and the uploaded files are in the volume. See Configuration reference of the server.

Keep your Agentivity server private.