Moving an Agent installation

Move an agent installation to either a different folder/drive or system
Written by Philipp
Updated 8 months ago

Moving individual Agent directories

Depending on requirement, you may not require to move the entire installation, it is possible to change the locations of the following directories:
# Internal folder structure
# database_dir = "" # optional override for database directory, full path
# log_dir = "" # optional override for agent logs directory, full path
# deployments_dir = "" # optional override for deployments directory, full path
# cache_dir = "" # optional override for cache directory, full path
# certs_dir= "" # optional override for certs directory, full path
# backups_dir= "" # optional override for backups directory, full path

To perform this change:

  1. Stop the Agent
  2. Create new directory at new target location
  3. Copy the contents of the current folder you want to override to the new location
  4. Update the `config.toml` according to the changes you intend to make
  5. Restart the Agent

Moving an Agent to a new installation location

Before going forward, verify that this change is absolutely required as it may result in issues.

Follow these steps:

  1. Stop the Agent
  2. Open a Windows CMD / Linux Shell and navigate to the Agent installation directory
  3. Execute the following command:
    # Windows
    ArchitectAgent.exe --mode=remove --tray-uninstall
    
    # Linux
    ArchitectAgent --mode=remove
  4. Create new directory at target location
  5. Copy the entire contents of the existing installation to the new location
  6. Modify the `agent_dir` parameter within `config.toml` to point to the new location
  7. Execute the following command:
    # Windows
    ArchitectAgent.exe --mode=install --tray-install
    
    # Linux
    ArchitectAgent --mode=install

Moving an Agent between systems

The agent can not be copy-pasted between systems.

It is not possible to transmit agent settings between installations.

Given you have already installed the agent on a new system, perform following actions to transmit the server deployments.

  1. Click "Export" under Server, Maintenance for each game server deployment you want to migrate
    This is a LONG running task as all files within the deployment will be packed alongside metadata about the deployment itself. To speed up the process, delete ALL UNNECESSARY files before creating the archive.
  2. Upload all generated export files to the new agent installation directory where the ArchitectAgent(.exe) resides
  3. Prepare the deployment of the archived deployments by switching to the archive deployment mode on the new agent
  4. Start the deployment process for a new server, and allocate new ports or re-use the ports for the existing deployments
  5. Wait for the archive deployment to complete.
    This is a LONG running task as all titles, mods will be downloaded checked and restored, alongside unpacking all existing data.

Once all deployments have been deployed from their respective archives, you have fully copied the entire game server to their new agent. You can now go through the process of setting up the agent environment, (users, webhooks etc.) to your liking again.

Did this answer your question?