-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[Add] Hermes Quick Deploy app Doc #7487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+103
−0
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cd5dac9
add hermes
hmorris3293 25b6c38
Make edits to the Hermes guide and update the dictionary file
niemczyk-m 97dd79a
Merge pull request #1 from niemczyk-m/hermes
hmorris3293 ca27bc3
Update terminology from 'relay' to 'gateway'
hmorris3293 fa03c0a
Copy edit
nmelehan-akamai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| title: "Deploy Hermes Agent" | ||
| description: "This tutorial will show you how to deploy Hermes Agent as a Quick Deploy App." | ||
| published: 2026-06-17 | ||
| modified: 2026-06-17 | ||
| keywords: ['AI', 'AI Agent'] | ||
| tags: ["quick deploy apps", "AI", "AI Agent"] | ||
| aliases: ['/products/tools/marketplace/guides/hermes/','/guides/hermes/'] | ||
| external_resources: | ||
| - '[Hermes Agent](https://hermes-agent.nousresearch.com)' | ||
| - '[Hermes Agent Documentation](https://hermes-agent.nousresearch.com/docs)' | ||
| authors: ["Akamai"] | ||
| contributors: ["Akamai"] | ||
| license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' | ||
| marketplace_app_id: 2141074 | ||
| marketplace_app_name: "Hermes" | ||
| --- | ||
|
|
||
| [Hermes Agent](https://hermes-agent.nousresearch.com) is an open-source AI agent platform designed for autonomous task execution through a persistent Relay service. The Relay connects communication channels, tools, and AI models, allowing the agent to receive instructions, perform actions, and automate multi-step workflows. Administrators configure and manage the system through a CLI setup wizard and a local web dashboard. Our Quick Deploy App allows you to connect to the Hermes Agent dashboard via a secure HTTPS endpoint protected by HTPASSWD. | ||
|
|
||
| This Quick Deploy App creates a Hermes Agent user on the system called `hermes`. | ||
|
|
||
| ## Deploying a Quick Deploy App | ||
|
|
||
| {{% content "deploy-marketplace-apps-shortguide" %}} | ||
|
|
||
| {{% content "marketplace-verify-standard-shortguide" %}} | ||
|
|
||
| {{< note >}} | ||
| **Estimated deployment time:** Hermes Agent should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning. | ||
| {{< /note >}} | ||
|
|
||
| ## Configuration Options | ||
|
|
||
| - **Supported distributions:** Ubuntu 24.04 LTS | ||
| - **Recommended plan:** All plan types and sizes can be used. | ||
|
|
||
| ## Hermes Agent Options | ||
|
|
||
| - **Email address** *(optional)*: Enter the email address you want to use for SOA email DNS record. | ||
|
hmorris3293 marked this conversation as resolved.
Outdated
|
||
|
|
||
| {{% content "marketplace-required-limited-user-fields-shortguide" %}} | ||
|
|
||
| {{% content "marketplace-custom-domain-fields-shortguide" %}} | ||
|
|
||
| {{% content "marketplace-special-character-limitations-shortguide" %}} | ||
|
|
||
| ## Getting Started after Deployment | ||
|
|
||
| ### Performing Hermes Agent Onboarding | ||
|
|
||
| Once the deployment is complete, `hermes` will be installed on the instance but will not be running. Before you can start using Hermes Agent, you need to go through the setup wizard. This Quick Deploy App triggers the onboarding for you when you log in as root. | ||
|
|
||
| 1. Log into the instance. | ||
|
|
||
| If you disabled root login to the server during the setup of the Hermes Agent app, you need to log into the server as the sudo user. | ||
|
|
||
| ```command | ||
| 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. | ||
|
|
||
| 1. Escalate privileges to root. | ||
|
|
||
| Once you've logged in, note the [motd](https://man7.org/linux/man-pages/man5/motd.5.html): | ||
|
|
||
| ```output | ||
| ********************************************************* | ||
| Akamai Connected Cloud Hermes Quick Deploy App | ||
| Credentials File: /home/admin/.credentials | ||
| Documentation: https://www.linode.com/docs/marketplace-docs/guides/hermes/ | ||
| ********************************************************* | ||
| ``` | ||
|
|
||
| Copy the sudo password from `~/.credentials.txt` and enter the following command from the terminal: | ||
|
|
||
| ```command | ||
| sudo su - | ||
| ``` | ||
|
|
||
| When prompted for the password, paste the sudo password you got from the `~/.credentials.txt` file. When you log in as **root**, note the following message about the setup wizard. If you are ready to perform the onboarding, enter `y` and it will take you to Hermes Agent's & Hermes Gateway setup wizards where you can complete the configuration. | ||
|
|
||
| Once onboarding is complete, the setup script is removed. | ||
|
|
||
| ### Confirm Hermes Status | ||
|
|
||
| At this time, you've configured Hermes Agent on the server. To verify the relay is running, you need to become the `hermes` user. Enter the following from the terminal as the **root** user: | ||
|
|
||
| ```command | ||
| su - hermes | ||
| ``` | ||
|
|
||
| To view the hermes status, enter the following as the **hermes** user: | ||
|
Check failure on line 94 in docs/marketplace-docs/guides/hermes/index.md
|
||
|
|
||
| ```command | ||
| hermes agent status | ||
| ``` | ||
|
|
||
| ### Confirm Gateway Status | ||
|
|
||
| To verify the gateway is running, you need to become the `hermes` user. Enter the following from the terminal as the **root** user: | ||
|
|
||
| ```command | ||
| su - hermes | ||
| ``` | ||
|
|
||
| To view the gateway status, enter the following as the **hermes** user: | ||
|
|
||
| ```command | ||
| hermes gateway status | ||
| ``` | ||
|
|
||
| {{% content "marketplace-update-note-shortguide" %}} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.