yacy_search_server/help/yacy/hello.md

page, help, title, package, access, kind, backend_java

page	help	title	package	access	kind	backend_java
htroot/yacy/hello.html	help/yacy/hello.md	hello	machine-api-peer	peer-service	peer-endpoint	source/net/yacy/htroot/yacy/hello.java

hello

Purpose

hello is the peer greeting endpoint.

Use it when another peer or diagnostic tool needs to identify and negotiate with this YaCy peer.

What You Can Do Here

• Identify this peer during YaCy peer-to-peer handshakes.
• Send the peer identity, key, seed, and protocol fields exactly as expected by the backend.
• Use the response to confirm that the peer can be reached and understood by another YaCy component.

Page Architecture

This is a compact endpoint-style page. Its behavior is driven mainly by request parameters and the selected response template, so callers should send only the fields needed for the specific query or peer-service action.

Correct Use

Call the endpoint as a protocol surface. Use exact parameter names and encoded values, authenticate when required, and inspect the response before relying on it. Avoid sending browser-only submit buttons unless the backend explicitly requires the action key.

Access And Safety

This is a peer-service endpoint for YaCy peer communication, not a normal editing page.

Behind a reverse proxy, YaCy accepts X-Real-IP as the effective client and routing address only when the proxy socket IP matches server.reverseProxy.trusted and the header contains one valid IPv4 or IPv6 address. Otherwise YaCy uses the socket IP. Authentication and access control always use the socket IP. The proxy must overwrite, not pass through, any client-supplied X-Real-IP value.

Automation And API

Page backend: source/net/yacy/htroot/yacy/hello.java.

Endpoint	Method	Access	Backend
/yacy/hello.html	GET or POST	peer-service	source/net/yacy/htroot/yacy/hello.java

Parameter Guide

The table explains values that an agent or script must set deliberately. Parameters not relevant to a task should be omitted or left at the page default.

Parameter	Meaning and valid values	Care
count	SRU-style result count. It is an alternative to maximumRecords on search endpoints.	Controls the scope or format of the result. Prefer the narrowest value that answers the request.

Example request shape:

GET or POST /yacy/hello.html?count=...&iam=...&key=...&magic=...&seed=...

What To Expect

Expect a compact service response rather than a teaching interface. The response may be XML, RSS, JSON-like text, plain text, or a small HTML template depending on the endpoint.

Related Pages

• Related protocol work usually continues through the calling tool, the peer endpoint family under /yacy/, or the API page that consumes this response.