yagonode

module
v0.0.0-...-9b85f49 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2026 License: AGPL-3.0

Directories

Path Synopsis
cmd
yago-node command
yago-peer-hash command
Command yago-peer-hash prints a freshly generated YaCy peer hash.
Command yago-peer-hash prints a freshly generated YaCy peer hash.
internal
adminui
Package adminui serves the yago operator console as a server-rendered surface styled with IBM Carbon design tokens and progressively enhanced with htmx.
Package adminui serves the yago operator console as a server-rendered surface styled with IBM Carbon design tokens and progressively enhanced with htmx.
boltvault
Package boltvault is the bbolt implementation of the vault Engine.
Package boltvault is the bbolt implementation of the vault Engine.
bootstrap
Package bootstrap fetches the configured YaCy seed lists and returns the seeds they advertise.
Package bootstrap fetches the configured YaCy seed lists and returns the seeds they advertise.
cachedpage
Package cachedpage serves read-only cached copies of locally stored pages on the public listener: the text this node extracted at crawl time, rendered escaped, so a searcher can inspect a result without visiting the origin site.
Package cachedpage serves read-only cached copies of locally stored pages on the public listener: the text this node extracted at crawl time, rendered escaped, so a searcher can inspect a result without visiting the origin site.
contentquality
Package contentquality gates crawled text before it is stored and indexed, using the deterministic token-based subset of the Gopher (Rae et al., arXiv:2112.11446, Appendix A) and C4 (Raffel et al., arXiv:1910.10683) quality rules that FineWeb (arXiv:2406.17557) validated at web scale.
Package contentquality gates crawled text before it is stored and indexed, using the deterministic token-based subset of the Gopher (Rae et al., arXiv:2112.11446, Appendix A) and C4 (Raffel et al., arXiv:1910.10683) quality rules that FineWeb (arXiv:2406.17557) validated at web scale.
crawlbroker
Package crawlbroker is the node's gRPC edge to the crawl fleet.
Package crawlbroker is the node's gRPC edge to the crawl fleet.
crawldispatch
Package crawldispatch turns an operator's request to crawl seed URLs into a CrawlOrder and hands it to the crawl fleet.
Package crawldispatch turns an operator's request to crawl seed URLs into a CrawlOrder and hands it to the crawl fleet.
crawlformats
Package crawlformats persists the operator's shared document-format toggles: which format families every crawl parses (YaCy TextParser parity).
Package crawlformats persists the operator's shared document-format toggles: which format families every crawl parses (YaCy TextParser parity).
crawling
Package crawling owns the crawlReceipt endpoint, which rejects remote crawl receipts until an operator policy enables remote crawl work.
Package crawling owns the crawlReceipt endpoint, which rejects remote crawl receipts until an operator policy enables remote crawl work.
crawlresults
Package crawlresults absorbs ingest batches returned by the crawl fleet, storing their URL metadata and then their postings through the node's existing receivers.
Package crawlresults absorbs ingest batches returned by the crawl fleet, storing their URL metadata and then their postings through the node's existing receivers.
crawlruns
Package crawlruns is the node's in-memory registry of crawl runs.
Package crawlruns is the node's in-memory registry of crawl runs.
crawlschedule
Package crawlschedule stores recurring crawl definitions and decides when each is due — YaCy's Automation_p (recorded API calls with a recurring schedule) parity for the one action worth repeating: re-crawling a site (UI-19).
Package crawlschedule stores recurring crawl definitions and decides when each is due — YaCy's Automation_p (recorded API calls with a recurring schedule) parity for the one action worth repeating: re-crawling a site (UI-19).
crossorigin
Package crossorigin applies a configurable, default-deny CORS policy to an HTTP handler.
Package crossorigin applies a configurable, default-deny CORS policy to an HTTP handler.
dhtexchange
Package dhtexchange builds outbound YaCy DHT exchange batches.
Package dhtexchange builds outbound YaCy DHT exchange batches.
documentsearch
Package documentsearch finds documents containing wanted terms, orders them by relevance, and reports how many documents matched each term.
Package documentsearch finds documents containing wanted terms, orders them by relevance, and reports how many documents matched each term.
events
Package events records recent structured node events in a bounded in-memory ring so operators and the admin UI can review important activity without scraping logs.
Package events records recent structured node events in a bounded in-memory ring so operators and the admin UI can review important activity without scraping logs.
eventstore
Package eventstore is a durable, bounded log of structured node events so the admin event log survives restarts.
Package eventstore is a durable, bounded log of structured node events so the admin event log survives restarts.
eviction
Package eviction frees storage when the vault nears its quota.
Package eviction frees storage when the vault nears its quota.
faviconproxy
Package faviconproxy serves result favicons through this node, so the hosts behind search results never see the searcher's browser before a click (the privacy property YaCy gets from its ViewImage proxy).
Package faviconproxy serves result favicons through this node, so the hosts behind search results never see the searcher's browser before a click (the privacy property YaCy gets from its ViewImage proxy).
filetypeclass
Package filetypeclass classifies a crawled document's file type from its Content-Type and URL, so the filetype: search operator and the filetype navigation facet recognise a document by what it actually is rather than only by a file extension in its URL.
Package filetypeclass classifies a crawled document's file type from its Content-Type and URL, so the filetype: search operator and the filetype navigation facet recognise a document by what it actually is rather than only by a file extension in its URL.
httpguard
Package httpguard enforces the HTTP request invariants every module endpoint shares: method set, body limit, and request timeout.
Package httpguard enforces the HTTP request invariants every module endpoint shares: method set, body limit, and request timeout.
indextransfer
Package indextransfer owns outbound YaCy index transfer HTTP calls.
Package indextransfer owns outbound YaCy index transfer HTTP calls.
judgments
Package judgments persists operator-curated relevance judgments — a query paired with graded result URLs — as the human-labelled training and regression set the ranking learner (YagoRank, ADR-0035) fits weights against.
Package judgments persists operator-curated relevance judgments — a query paired with graded result URLs — as the human-labelled training and regression set the ranking learner (YagoRank, ADR-0035) fits weights against.
landing
Package landing serves the node's static landing page on GET and HEAD.
Package landing serves the node's static landing page on GET and HEAD.
landiscovery
Package landiscovery finds peers on the local network the way Syncthing's local discovery does: a small UDP beacon broadcast on a fixed port announces this node's hash and peer port, and received announcements from other nodes hand a candidate endpoint to the greeter, which runs the ordinary hello exchange — the beacon itself is never trusted for anything but «someone at this address claims to be a peer», so a forged packet can at most trigger one verified greet.
Package landiscovery finds peers on the local network the way Syncthing's local discovery does: a small UDP beacon broadcast on a fixed port announces this node's hash and peer port, and received announcements from other nodes hand a candidate endpoint to the greeter, which runs the ordinary hello exchange — the beacon itself is never trusted for anything but «someone at this address claims to be a peer», so a forged packet can at most trigger one verified greet.
memvault
Package memvault is the in-memory implementation of the vault Engine.
Package memvault is the in-memory implementation of the vault Engine.
metrichistory
Package metrichistory samples a curated set of the node's Prometheus metrics into a bounded in-memory ring, so the admin Performance page can render a short operational history (request throughput, error rate, latency, DHT transfer rate, queue depths) without an external metrics stack.
Package metrichistory samples a curated set of the node's Prometheus metrics into a bounded in-memory ring, so the admin Performance page can render a short operational history (request throughput, error rate, latency, DHT transfer rate, queue depths) without an external metrics stack.
metrics
Package metrics translates domain results into Prometheus series.
Package metrics translates domain results into Prometheus series.
modifierhint
Package modifierhint supplies the guidance shown when a search carried a filter operator (filetype:, site:, tld:, inurl:) but no free-text term and so matched nothing.
Package modifierhint supplies the guidance shown when a search carried a filter operator (filetype:, site:, tld:, inurl:) but no free-text term and so matched nothing.
nodeidentity
Package nodeidentity holds this node's self-description: the hash, network, and seed attributes that identify it, and the rule for whether a peer request addresses it.
Package nodeidentity holds this node's self-description: the hash, network, and seed attributes that identify it, and the rule for whether a peer request addresses it.
nodestatus
Package nodestatus owns the node's runtime status: its self-seed, the version/uptime header every endpoint echoes, and the query.html capacity answers.
Package nodestatus owns the node's runtime status: its self-seed, the version/uptime header every endpoint echoes, and the query.html capacity answers.
peeradmission
Package peeradmission answers inbound hello requests: it classifies the calling peer by probing it back, and returns a bounded freshest set of reachable peers.
Package peeradmission answers inbound hello requests: it classifies the calling peer by probing it back, and returns a bounded freshest set of reachable peers.
peerannouncement
Package peerannouncement greets known peers on an interval: it announces this node to them and reports their reachability to the peer roster.
Package peerannouncement greets known peers on an interval: it announces this node to them and reports their reachability to the peer roster.
peerbirth
Package peerbirth keeps this peer's birth date: the moment the node first started with its data directory.
Package peerbirth keeps this peer's birth date: the moment the node first started with its data directory.
peerblock
Package peerblock keeps a durable operator-managed blocklist of peer hashes.
Package peerblock keeps a durable operator-managed blocklist of peer hashes.
peeridentity
Package peeridentity keeps this peer's stable identity — its hash and name — so a node bootstraps without the operator having to supply them.
Package peeridentity keeps this peer's stable identity — its hash and name — so a node bootstraps without the operator having to supply them.
peernews
Package peernews keeps the YaCy peer news pool: news records this peer publishes to the network and news records that arrive attached to other peers' seeds.
Package peernews keeps the YaCy peer news pool: news records this peer publishes to the network and news records that arrive attached to other peers' seeds.
peerroster
Package peerroster owns the set of network peers this node knows.
Package peerroster owns the set of network peers this node knows.
portaltheme
Package portaltheme stores and renders the operator-editable public portal theme (ADR-0033): Handlebars templates for the search and results pages plus a shared styles block, persisted in the durable vault and rendered server-side.
Package portaltheme stores and renders the operator-editable public portal theme (ADR-0033): Handlebars templates for the search and results pages plus a shared styles block, persisted in the durable vault and rendered server-side.
publicportal
Package publicportal serves the anonymous public search portal: a minimal, server-rendered search page on the node's public HTTP listener that works without JavaScript and in legacy browsers.
Package publicportal serves the anonymous public search portal: a minimal, server-rendered search page on the node's public HTTP listener that works without JavaScript and in legacy browsers.
publicratelimit
Package publicratelimit throttles the anonymous public search surfaces the way YaCy's search.public.max.access tiers do: per-client sliding windows at three second, one minute, and ten minute horizons, with raised limits for authenticated callers (a valid bearer key or the local operator).
Package publicratelimit throttles the anonymous public search surfaces the way YaCy's search.public.max.access tiers do: per-client sliding windows at three second, one minute, and ten minute horizons, with raised limits for authenticated callers (a valid bearer key or the local operator).
publicrobots
Package publicrobots serves the node's own /robots.txt — YaCy's ConfigRobotsTxt_p parity.
Package publicrobots serves the node's own /robots.txt — YaCy's ConfigRobotsTxt_p parity.
rankfit
Package rankfit fits the ranking weight profile to measured relevance (YagoRank, ADR-0035).
Package rankfit fits the ranking weight profile to measured relevance (YagoRank, ADR-0035).
rankingprofile
Package rankingprofile persists the node's default search ranking weights and serves them live to the local searcher, so an operator can retune ranking without a restart and the setting survives one.
Package rankingprofile persists the node's default search ranking weights and serves them live to the local searcher, so an operator can retune ranking without a restart and the setting survives one.
readpriority
Package readpriority defers a bulk writer while interactive reads are in flight, so searches and admin pages reach the disk ahead of ingest writes and their fsyncs (IO-PRIO-01, made a configurable, observable gate for PERF-PRIO-02).
Package readpriority defers a bulk writer while interactive reads are in flight, so searches and admin pages reach the disk ahead of ingest writes and their fsyncs (IO-PRIO-01, made a configurable, observable gate for PERF-PRIO-02).
recrawlfrontier
Package recrawlfrontier keeps a durable, node-side recrawl schedule: for each crawled URL it records when the page was last fetched and when it is next due for a recrawl, so pages are refetched on their profile's cadence and the schedule survives node and crawler restarts.
Package recrawlfrontier keeps a durable, node-side recrawl schedule: for each crawled URL it records when the page was last fetched and when it is next due for a recrawl, so pages are refetched on their profile's cadence and the schedule survives node and crawler restarts.
redirectpurge
Package redirectpurge sweeps already-indexed search-engine click-tracking documents out of the live corpus (SEARCH-29).
Package redirectpurge sweeps already-indexed search-engine click-tracking documents out of the live corpus (SEARCH-29).
remotecrawl
Package remotecrawl owns opt-in YaCy remote crawl delegation.
Package remotecrawl owns opt-in YaCy remote crawl delegation.
rwi
Package rwi owns RWI posting intake, storage, search, and eviction.
Package rwi owns RWI posting intake, storage, search, and eviction.
searchactivity
Package searchactivity keeps a bounded in-memory journal of recent search requests for the admin console — YaCy's AccessTracker_p parity (UI-16).
Package searchactivity keeps a bounded in-memory journal of recent search requests for the admin console — YaCy's AccessTracker_p parity (UI-16).
searcheval
Package searcheval scores a searcher's ranking quality with NDCG@k so a test can gate ranking changes against regression, and turns query→relevant-URL labels (including corpus-derived pseudo-labels) into judgments.
Package searcheval scores a searcher's ranking quality with NDCG@k so a test can gate ranking changes against regression, and turns query→relevant-URL labels (including corpus-derived pseudo-labels) into judgments.
searchsession
Package searchsession keeps paging stable by caching assembled result prefixes and extending them in bounded windows when a deeper page needs more results.
Package searchsession keeps paging stable by caching assembled result prefixes and extending them in bounded windows when a deeper page needs more results.
seedimport
Package seedimport keeps a durable per-URL record of the last seed-list import so the admin console can show when each configured seed list was last refreshed and whether it succeeded.
Package seedimport keeps a durable per-URL record of the last seed-list import so the admin console can show when each configured seed list was last refreshed and whether it succeeded.
settingsstore
Package settingsstore is a durable, admin-writable key/value store for the node's operator-overridable runtime settings.
Package settingsstore is a durable, admin-writable key/value store for the node's operator-overridable runtime settings.
shardvault
Package shardvault is the sharded, compressed bbolt implementation of the vault Engine (ADR-0025).
Package shardvault is the sharded, compressed bbolt implementation of the vault Engine (ADR-0025).
snippetmark
Package snippetmark highlights query terms in result snippets for the human search surfaces.
Package snippetmark highlights query terms in result snippets for the human search surfaces.
spellcheck
Package spellcheck corrects query spelling against the node's own indexed vocabulary with the Symmetric Delete algorithm (SymSpell, Garbe 2012): the dictionary is precomputed once so a lookup only deletes characters from the query term, never the dictionary, making correction fast enough to run on every zero-result query.
Package spellcheck corrects query spelling against the node's own indexed vocabulary with the Symmetric Delete algorithm (SymSpell, Garbe 2012): the dictionary is precomputed once so a lookup only deletes characters from the query term, never the dictionary, making correction fast enough to run on every zero-result query.
stopwords
Package stopwords carries a compact multilingual function-word list for query-time decisions: which query words may be required of documents, verified against peer results, anchor snippets, or drive highlighting.
Package stopwords carries a compact multilingual function-word list for query-time decisions: which query words may be required of documents, verified against peer results, anchor snippets, or drive highlighting.
tracectx
Package tracectx implements the W3C Trace Context header (traceparent) for the node's own request legs — enough to correlate one public search with the peer fan-out it caused and to attach exemplars to latency histograms (OPS-10).
Package tracectx implements the W3C Trace Context header (traceparent) for the node's own request legs — enough to correlate one public search with the peer fan-out it caused and to attach exemplars to latency histograms (OPS-10).
transfertally
Package transfertally keeps the running and persisted totals of this peer's YaCy index exchange for the advertised seed statistics.
Package transfertally keeps the running and persisted totals of this peer's YaCy index exchange for the advertised seed statistics.
urldenylist
Package urldenylist keeps a durable, operator-managed denylist of URLs and whole domains.
Package urldenylist keeps a durable, operator-managed denylist of URLs and whole domains.
urlmeta
Package urlmeta owns the transferURL endpoint, URL intake, and URL metadata storage and lookup.
Package urlmeta owns the transferURL endpoint, URL intake, and URL metadata storage and lookup.
urlmetastaleness
Package urlmetastaleness orders url metadata from stalest to freshest so eviction can name the stalest urls without decompressing a single row.
Package urlmetastaleness orders url metadata from stalest to freshest so eviction can name the stalest urls without decompressing a single row.
urlreferences
Package urlreferences knows, for every url, the words that reference it, so eviction can drop a url's postings without scanning the word index.
Package urlreferences knows, for every url, the words that reference it, so eviction can drop a url's postings without scanning the word index.
vault
Package vault lends each module a transactionally-scoped, codec-typed collection over its own ordered byte buckets.
Package vault lends each module a transactionally-scoped, codec-typed collection over its own ordered byte buckets.
vaulttest
Package vaulttest holds the storage-contract suite every vault Engine driver runs against itself.
Package vaulttest holds the storage-contract suite every vault Engine driver runs against itself.
websearch
Package websearch provides optional, admin-gated web retrieval after a local and federated miss or alongside those sources in always mode.
Package websearch provides optional, admin-gated web retrieval after a local and federated miss or alongside those sources in always mode.
wordforms
Package wordforms expands a query word into the inflected surface forms that actually occur in the node's index.
Package wordforms expands a query word into the inflected surface forms that actually occur in the node's index.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL