Hermes

Deploy Hermes Agent, an open source AI agent platform that executes tasks through a persistent gateway connecting communication channels, tools, and AI models.

1. Deploy Hermes

 Estimated deployment time: 5–10 minutes

Follow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the Configuration options section.

Base distribution and plan

  • Supported distribution: Ubuntu 24.04 LTS
  • Recommended plans: All plan types and sizes can be used.

Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.

StackScript ID: 2141074

UI fieldAPI/CLI keyDescription
Required options
Limited sudo useruser_nameYour preferred username for the limited sudo user, entered without any capital letters, spaces, or special characters.
When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.
Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an authorized_user. Their SSH pubkey will be assigned to both the root and limited sudo users.
Advanced options
Disable root access over SSHdisable_rootApplies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No.
Note: When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the authorized_user, you can still switch to the root user. To do that, log in as root via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited sudo user.
Linode API tokentoken_passwordApplies to a custom domain. The Linode API token if you want to use Linode's DNS Manager to manage DNS records for your custom domain. Follow Manage personal access tokens to get your token on your account with Read/Write access to Domains.
  • If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API.
  • If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
SubdomainsubdomainApplies to a custom domain. The subdomain you want to use, like blog for blog.example.com. Use it only if you specify a Domain.
DomaindomainApplies to a custom domain. The domain name you want to use, like example.com. Use it only if you specify a Linode API token.
Email address (for SOA Email DNS record)soa_email_addressYour email address for a new DNS zone.
Optional data exporter Add-onsadd_onsAn option to include add-ons for your deployment. Possible values are:
  • none (default)
  • alloy
  • node_exporter
  • mysqld_exporter
  • newrelic
  • opentelemetry_collector

Notes:

  • After the app deployment completes, the password for your limited sudo user is generated and stored in the .credentials file in the home directory, along with application-specific passwords. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.
  • You can automatically configure a custom domain (optional) during deployment. To do that:
    1. First, configure your domain to use Linode’s name servers via your registrar. See Configure your domain's authoritative name servers for details.
    2. Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.

Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.

curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-2",
        "image": "linode/ubuntu24.04",
        "label": "my-hermes-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 2141074,
        "stackscript_data": {
            "user_name":"jsmith"
        }
    }'
linode-cli linodes create \
    --region us-east \
    --type g6-standard-2 \
    --label my-hermes-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 2141074 \
    --stackscript_data '{"user_name":"jsmith"}'
resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-2"
    label          = "my-hermes-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 2141074
    stackscript_data = {
        "user_name" = "jsmith"
    }
}

2. Access Hermes

Onboard the agent

Once the deployment is complete, hermes is installed on the instance but is not running yet. Before you can start using Hermes Agent, you need to go through the setup wizard. This app triggers onboarding for you when you log in as root.

  1. Log in to your instance.

    If you disabled root login to the server during the setup of the Hermes Agent app, log in as a sudo user.

    ssh admin@YOUR_INSTANCE_IP

    Replace YOUR_INSTANCE_IP with the IP address of your Linode instance and admin with the sudo user you created.

  2. Escalate privileges to root. Once you’ve logged in, the motd (message of the day) appears.

    *********************************************************
    Akamai Connected Cloud Hermes Quick Deploy App
    Credentials File: /home/admin/.credentials
    Documentation: https://techdocs.akamai.com/quick-deploy-apps/docs/hermes
    *********************************************************
  3. Copy the sudo password from the ~/.credentials file and enter the sudo su - command in the terminal.

  4. When prompted for the password, paste the sudo password you copied from the ~/.credentials file. When you log in as root, the setup wizard message appears.

  5. If you're ready to perform the onboarding, enter y. It takes you to Hermes Agent’s & Hermes Gateway setup wizards where you can complete the configuration.

    Once the setup is complete, the onboarding script is removed.

Confirm the agent and gateway statuses

At this point, you’ve configured Hermes Agent on the server. To verify the agent and gateway are running, you need to become the hermes user.

  1. Run the su - hermes command in the terminal as the root user.
  2. To view the agent and gateway statuses, run the hermes agent status and hermes gateway status commands as the hermes user.

Additional resources

For more information about the installed packages, see their official documentation.

📘

Note that we can't vouch for the accuracy or timeliness of externally hosted resources.


Did this page help you?