From 6612372989f6447aed4b950ed5f035264a34ac32 Mon Sep 17 00:00:00 2001 From: JonnyRingo <92886988+Jonny-Ringo@users.noreply.github.com> Date: Thu, 14 May 2026 09:57:41 -0700 Subject: [PATCH 1/5] Add section on setting up a Scheduler device --- docs/run/running-a-hyperbeam-node.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/run/running-a-hyperbeam-node.md b/docs/run/running-a-hyperbeam-node.md index a0689c4b4..65098ee2f 100644 --- a/docs/run/running-a-hyperbeam-node.md +++ b/docs/run/running-a-hyperbeam-node.md @@ -248,3 +248,4 @@ To stop the node running *within the `rebar3 shell`*, press `Ctrl+C` twice or us * **Configure Your Node:** Deep dive into [configuration options](./configuring-your-machine.md). * **TEE Nodes:** Learn about running nodes in [Trusted Execution Environments](./tee-nodes.md) for enhanced security. * **Routers:** Understand how to configure and run a [router node](./joining-running-a-router.md). +* **Scheduler Device:** Learn how to [set up a Scheduler device](./setting-up-a-scheduler-device.md) to announce your node as an AO scheduler. From f4cebdf88fe657062e815732dd2365dc795d245a Mon Sep 17 00:00:00 2001 From: JonnyRingo <92886988+Jonny-Ringo@users.noreply.github.com> Date: Thu, 14 May 2026 10:04:19 -0700 Subject: [PATCH 2/5] Add guide for setting up a scheduler device This guide assists operators in registering their HyperBEAM node as an AO scheduler, including prerequisites and steps for announcing the scheduler location. --- docs/run/setting-up-a-scheduler-device.md | 47 +++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/run/setting-up-a-scheduler-device.md diff --git a/docs/run/setting-up-a-scheduler-device.md b/docs/run/setting-up-a-scheduler-device.md new file mode 100644 index 000000000..1081f66fd --- /dev/null +++ b/docs/run/setting-up-a-scheduler-device.md @@ -0,0 +1,47 @@ +# Setting Up a Scheduler Device + +> **Note:** When your node launches, it will normally post (announce) its scheduler location automatically. This guide is useful if you need to re-announce the location or manually update the published location data. + +This guide is for operators who are already running a production HyperBEAM node and want to register it as an AO scheduler. + +## Prerequisites + +If you started your node using the default device list in [hb_opts.erl](../../src/hb_opts.erl), both `~location@1.0` and `~scheduler@1.0` are already onboarded — no additional configuration is required. + +You must set `host` in your `config.flat` so the `~location@1.0` device announces the correct public URL for your node. + +Example: + +```erlang +host = "your-node-domain.example.com". +``` + +## Announcing Your Scheduler Location + +To register your node as a scheduler on the AO network, you need to call the `~location@1.0` device endpoint **from the node host itself** (i.e. run the command on the same machine running HyperBEAM). + +Run the following curl command on your node host (Linux/Mac): + +```bash +curl -sS -v http://127.0.0.1:8734/~location@1.0/node +``` + +### What Success Looks Like + +A successful call returns an **HTTP 200 OK** response from `~location@1.0` in the node logs and will give you some details in your local console. This publishes a transaction to the network announcing your scheduler location. + +## Emitted Transaction Tags + +The published transaction should include tags similar to the following: + +``` +data-Protocol: ao +variant: ao.N.1 +type: location +url: https://your-node-domain.example.com +nonce: +time-to-live: TTL +codec-device: Codec +``` + +> **Note:** The `url` field should point to your node's publicly accessible address (for example, `https://push.forward.computer`). The `nonce` value is generated automatically. From 221e03678de12a077cdf81fa3f8697aea5e8aab1 Mon Sep 17 00:00:00 2001 From: JonnyRingo <92886988+Jonny-Ringo@users.noreply.github.com> Date: Thu, 14 May 2026 10:11:27 -0700 Subject: [PATCH 3/5] Update running-a-hyperbeam-node.md with new note Added note about starting HyperBEAM with the genesis_wasm profile. --- docs/run/running-a-hyperbeam-node.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/run/running-a-hyperbeam-node.md b/docs/run/running-a-hyperbeam-node.md index 65098ee2f..5b8d7995f 100644 --- a/docs/run/running-a-hyperbeam-node.md +++ b/docs/run/running-a-hyperbeam-node.md @@ -147,6 +147,9 @@ The simplest way to start a HyperBEAM node for development or testing is using ` rebar3 shell ``` +>[!NOTE] +>For current process operations, start HyperBEAM with the genesis_wasm profile by running rebar3 as genesis_wasm shell. + This command: 1. Starts the Erlang Virtual Machine (BEAM) with all HyperBEAM modules loaded. From b419db6dd993efd6048ec988ccbd188208ae4567 Mon Sep 17 00:00:00 2001 From: JonnyRingo <92886988+Jonny-Ringo@users.noreply.github.com> Date: Thu, 14 May 2026 10:42:27 -0700 Subject: [PATCH 4/5] Update guide to clarify scheduler registration process Clarified the purpose of the guide for operators registering a HyperBEAM node as an AO scheduler on the network. --- docs/run/setting-up-a-scheduler-device.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/run/setting-up-a-scheduler-device.md b/docs/run/setting-up-a-scheduler-device.md index 1081f66fd..15986833f 100644 --- a/docs/run/setting-up-a-scheduler-device.md +++ b/docs/run/setting-up-a-scheduler-device.md @@ -1,8 +1,7 @@ # Setting Up a Scheduler Device -> **Note:** When your node launches, it will normally post (announce) its scheduler location automatically. This guide is useful if you need to re-announce the location or manually update the published location data. -This guide is for operators who are already running a production HyperBEAM node and want to register it as an AO scheduler. +This guide is for operators who are already running a production HyperBEAM node and want to register it as an AO scheduler on the network publicly. ## Prerequisites From e34edf4bf4e4c50bca8deed166a57fc2945fbcdc Mon Sep 17 00:00:00 2001 From: JonnyRingo <92886988+Jonny-Ringo@users.noreply.github.com> Date: Thu, 14 May 2026 10:53:12 -0700 Subject: [PATCH 5/5] Update running-a-hyperbeam-node.md Removed note about starting HyperBEAM with genesis_wasm profile. --- docs/run/running-a-hyperbeam-node.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/run/running-a-hyperbeam-node.md b/docs/run/running-a-hyperbeam-node.md index 5b8d7995f..65098ee2f 100644 --- a/docs/run/running-a-hyperbeam-node.md +++ b/docs/run/running-a-hyperbeam-node.md @@ -147,9 +147,6 @@ The simplest way to start a HyperBEAM node for development or testing is using ` rebar3 shell ``` ->[!NOTE] ->For current process operations, start HyperBEAM with the genesis_wasm profile by running rebar3 as genesis_wasm shell. - This command: 1. Starts the Erlang Virtual Machine (BEAM) with all HyperBEAM modules loaded.