The edge reef¶
Every command of the edge reef: domains, zones and routes, in the order a person types them.
Commands¶
nereus reef apply edge
One command applies the edge reef, with its first kind, Routenereus nereid apply cloudflare
The cloudflare Nereid runs the tunnel its Mandate namesnereus nereid apply godaddyplanned #475
The godaddy Nereid talks to the registrar, through its Mandatenereus edge zone create getnereus.dev
A zone gives the domain the nameservers that will answer for itnereus edge domain listplanned #475
The registrar shows its domains, with the credentials asked for now and never storednereus edge domain apply getnereus.devplanned #475
Nereus takes the domain and sends it to the zone's nameserversnereus edge domain listplanned #475
The list shows the domains Nereus looks afternereus edge domain get getnereus.devplanned #475
One domain shows every detail, its nameservers one per linenereus edge route create triton
A route makes a hostname reach the platformnereus edge endpoint list
The Nereids say what they serve, never where it runsnereus edge route create triton
A route publishes a reef's endpoint at a fixed address
Examples¶
apply-reef¶
Apply the edge reef.
nereus reef apply edge
output
✓ core/reefs/edge 0.1.0 created
Next steps:
nereus edge --help
nereus nereid apply <nereid> --reef edge
apply-cloudflare¶
Apply the cloudflare Nereid to the edge reef.
nereus nereid apply cloudflare \
--reef edge
output
✓ core/nereids/cloudflare created, Ready
Next steps:
nereus mandate create cloudflare --reef edge --nereid cloudflare --param tunnel=<tunnel> --param credentialsSecret=edge/<secret> --default
nereus edge route create <name> --hostname <hostname>
apply-godaddy¶
Apply the godaddy Nereid to the edge reef.
nereus nereid apply godaddy \
--reef edge
output
✓ core/nereids/godaddy created, Ready
Next steps:
nereus mandate create godaddy --reef edge --nereid godaddy
zone-create¶
Delegate the domain to the platform.
nereus edge zone create getnereus.dev \
--mandate cloudflare
output
✓ edge/zones/getnereus.dev created, waiting for its delegation
nameservers: ada.ns.cloudflare.com, bob.ns.cloudflare.com
point the registrar of getnereus.dev at them; the zone turns Active once Cloudflare sees it
Next steps:
nereus edge zone get getnereus.dev
domain-list-registrar¶
What the registrar holds.
nereus edge domain list \
--at-registrar \
--mandate godaddy
output
GoDaddy API key: ****
GoDaddy API secret: ****
NAME NAMESERVERS EXPIRES MANAGED
getnereus.dev ns01.domaincontrol.com (+1) 2029-10-25 no
example.com ns01.domaincontrol.com (+1) 2029-10-25 no
example.org ns01.domaincontrol.com (+1) 2028-06-11 no
Next steps:
nereus edge domain get <name> --at-registrar --mandate godaddy
nereus edge domain apply <name> --mandate godaddy
domain-apply¶
Delegate getnereus.dev to the zone.
nereus edge domain apply getnereus.dev \
--nameservers-from zone/getnereus.dev \
--mandate godaddy
output
✓ domain/getnereus.dev created
Next steps:
nereus edge domain get getnereus.dev --watch
domain-list¶
What Nereus looks after.
nereus edge domain list
output
NAME MANDATE NAMESERVERS DELEGATED
getnereus.dev godaddy ada.ns.cloudflare.com (+1) True
Next steps:
nereus edge domain get getnereus.dev
domain-get¶
Every detail of one domain.
nereus edge domain get getnereus.dev
output
Name: getnereus.dev
Mandate: godaddy
Delegated: True
Expires: 2029-10-25
Nameservers:
ada.ns.cloudflare.com
bob.ns.cloudflare.com
(from zone/getnereus.dev)
Next steps:
nereus edge domain get getnereus.dev --watch
route-hostname¶
Carry Triton's hostname through the tunnel.
nereus edge route create triton \
--hostname triton.getnereus.dev
output
✓ edge/routes/triton created, Ready: https://triton.getnereus.dev
Next steps:
nereus edge route get triton
endpoint-list¶
What the Nereids serve at the instance's entrance.
nereus edge endpoint list
output
REEF ENDPOINT NEREID PROTOCOL PATHS HOSTS PUBLISHABLE PUBLISHED ROUTES
messaging mcp triton http / triton.example.com yes no -
route-create¶
Publish Triton's MCP endpoint.
nereus edge route create triton \
--hostname triton.example.com \
--endpoint messaging/mcp
output
✓ edge/routes/triton created, Ready: https://triton.example.com
Next steps:
nereus edge route get triton