Installing an Architect Agent

Any Agent installation requires a license key.

License keys are valid for a certain amount of Agent installations. For details, check your purchase confirmation.

Prior to any installation, please check the system requirements.

Some providers require specific system settings for the Agent to function correctly. Review Hosting providers if your provider is listed.

Windows

On Windows, Architect Toolbox is the recommended way to install and manage the Agent. Download it from the Architect install page. Toolbox installs the Agent as a Windows service, stays in the system tray, and lets you start, stop, update, and repair the service.

Full non-arbitrarily restricted administrator privileges are required on the system.

Video walkthrough: CFTools Architect | First-Steps

Installation through Toolbox

1. Download ArchitectToolbox.exe from the Architect install page and run it on the machine that hosts your game servers.
2. Install Toolbox, then install Architect Agent from the tray dashboard.
3. Enter your license key, choose the installation directory, and set the deployments folder.
4. Perform base configuration if you need values beyond the wizard.
5. Verify firewall rules for your Agent port (TCP, inbound and outbound). The default port is 8090.
6. Retrieve the root user password from root.txt in the Agent installation directory. Toolbox also shows it after a successful install.

See Architect Toolbox for silent install flags and tray actions.

Manual installation

Advanced topic. Installation through Toolbox is recommended.

• Create the directory where you want to install the Agent
• Download the executable through your CFTools account
• Move the executable into the installation directory
• Create config.toml next to the executable (config.toml format)
• Start a command prompt as Administrator
• Install the Agent as a Windows service:

ArchitectAgent.exe --mode install

The Windows service name is ArchitectAgent.

Linux

ARM is not supported.

Supported distributions are listed in System requirements.

All steps must be executed as root.

Installation via systemd

• Download the installer through your CFTools Cloud account
• Execute the installer
• Enter the license key
• Finalize installation
• Perform base configuration
• Verify firewall rules for your Agent port (TCP, inbound and outbound)
• Retrieve the root user password from root.txt in the Agent installation directory

The service is controlled with systemctl:

systemctl start architect-agent
systemctl stop architect-agent

Open file limit

The installer raises the open-file limit to fs.nr_open, with a floor of 1024.

It writes:

• /etc/security/limits.d/99-nofile.conf
• /etc/systemd/system.conf.d/99-nofile.conf (DefaultLimitNOFILE)

Set NOFILE_TARGET to choose a number before you run the installer. The value is clamped between 1024 and fs.nr_open.

On a host that is already installed:

sudo ./install.sh --correct-nofile

Then restart the Agent service.

Docker

No Docker image is provided. Install the Agent on the host with the systemd installer.