summaryrefslogtreecommitdiff
path: root/help/proxymsg
diff options
context:
space:
mode:
authorMichael Peter Christen <mc@yacy.net>2026-07-10 00:20:29 +0200
committerMichael Peter Christen <mc@yacy.net>2026-07-10 00:20:29 +0200
commitdc84868b8b32e106dd97672040f251bb78f7d9ab (patch)
tree2b566a7fc8d6f63d1e3c89cec38c25aefe2e8ec6 /help/proxymsg
parentae8941b245f0e4b6e3c5f04bcac7a3ceb53ac370 (diff)
added help files for YaCy UI web pages
Diffstat (limited to 'help/proxymsg')
-rw-r--r--help/proxymsg/error.md49
-rw-r--r--help/proxymsg/urlproxyheader.md71
2 files changed, 120 insertions, 0 deletions
diff --git a/help/proxymsg/error.md b/help/proxymsg/error.md
new file mode 100644
index 000000000..64d151f49
--- /dev/null
+++ b/help/proxymsg/error.md
@@ -0,0 +1,49 @@
+---
+page: htroot/proxymsg/error.html
+help: help/proxymsg/error.md
+title: Error Message
+package: proxy-embedded-static
+access: public
+kind: proxy-message
+backend_java: none
+---
+
+# Error Message
+
+## Purpose
+
+Proxy Error Message explains a failed proxy request.
+
+Use it when YaCy acts as a proxy and must tell the browser why a page could not be delivered.
+
+## What You Can Do Here
+
+- Proxy Error Message explains a failed proxy request.
+- Use it through the page or proxy context that includes it.
+- Treat it as a support view unless the parameters document a direct service call.
+
+## Page Architecture
+
+The page is built around a visible form and backend parameters. The visible controls are the starting point; hidden fields usually carry defaults, transaction data, or browser state.
+
+## Correct Use
+
+Use this page in the context where YaCy displays it. Embedded and static pages usually explain, wrap, or visualize another workflow; direct calls should stay minimal and read-only unless documented otherwise.
+
+## Access And Safety
+
+The page is normally public or read-only, unless the peer is configured to require authentication for all pages.
+
+## Automation And API
+
+No matching Java servlet was found for this template.
+
+No request parameters are needed for normal use of this page.
+
+## What To Expect
+
+Expect a focused support view, embedded fragment, visual page, or proxy message. The important action usually happens on the page that linked here.
+
+## Related Pages
+
+- Related embedded work usually continues in the proxy page, portal page, or visualization that included this fragment.
diff --git a/help/proxymsg/urlproxyheader.md b/help/proxymsg/urlproxyheader.md
new file mode 100644
index 000000000..73cec77c6
--- /dev/null
+++ b/help/proxymsg/urlproxyheader.md
@@ -0,0 +1,71 @@
+---
+page: htroot/proxymsg/urlproxyheader.html
+help: help/proxymsg/urlproxyheader.md
+title: urlproxyheader
+package: proxy-embedded-static
+access: public
+kind: proxy-message
+backend_java: source/net/yacy/htroot/proxymsg/urlproxyheader.java
+---
+
+# urlproxyheader
+
+## Purpose
+
+URL Proxy Header is an embedded proxy information fragment.
+
+Use it to understand the header area shown around proxied content.
+
+## What You Can Do Here
+
+- URL Proxy Header is an embedded proxy information fragment.
+- Use it through the page or proxy context that includes it.
+- Treat it as a support view unless the parameters document a direct service call.
+
+## Page Architecture
+
+The page is built around a visible form and backend parameters. The visible controls are the starting point; hidden fields usually carry defaults, transaction data, or browser state.
+
+| Control | Meaning | Values or examples |
+| --- | --- | --- |
+
+## Correct Use
+
+Use this page in the context where YaCy displays it. Embedded and static pages usually explain, wrap, or visualize another workflow; direct calls should stay minimal and read-only unless documented otherwise.
+
+## Access And Safety
+
+The page is normally public or read-only, unless the peer is configured to require authentication for all pages.
+
+Backend checks: user authentication.
+
+## Automation And API
+
+Page backend: `source/net/yacy/htroot/proxymsg/urlproxyheader.java`.
+
+| Endpoint | Method | Access | Backend |
+| --- | --- | --- | --- |
+| `/proxymsg/urlproxyheader.html` | `GET` | public or page-dependent | `source/net/yacy/htroot/proxymsg/urlproxyheader.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. Low-level generated parameters are omitted when they are only meaningful inside the rendered YaCy form.
+
+| Parameter | Meaning and valid values | Care |
+| --- | --- | --- |
+| `hash` | YaCy hash identifier for a peer, URL, row, or stored object. Use exact values copied from YaCy output. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. |
+| `url` | URL to inspect, crawl, import, or act on. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. |
+
+Example request shape:
+
+```http
+GET /proxymsg/urlproxyheader.html?url=...&exit=...&addbookmark=...&bookmark=...&hash=...
+```
+
+## What To Expect
+
+Expect a focused support view, embedded fragment, visual page, or proxy message. The important action usually happens on the page that linked here.
+
+## Related Pages
+
+- Related embedded work usually continues in the proxy page, portal page, or visualization that included this fragment.