From dc84868b8b32e106dd97672040f251bb78f7d9ab Mon Sep 17 00:00:00 2001 From: Michael Peter Christen Date: Fri, 10 Jul 2026 00:20:29 +0200 Subject: added help files for YaCy UI web pages --- help/Settings_p.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 help/Settings_p.md (limited to 'help/Settings_p.md') diff --git a/help/Settings_p.md b/help/Settings_p.md new file mode 100644 index 000000000..68cd915c0 --- /dev/null +++ b/help/Settings_p.md @@ -0,0 +1,68 @@ +--- +page: htroot/Settings_p.html +help: help/Settings_p.md +title: Advanced Settings +package: configuration-administration +access: admin +kind: admin-page +backend_java: source/net/yacy/htroot/Settings_p.java +--- + +# Advanced Settings + +## Purpose + +Advanced Settings gathers technical peer settings that do not fit the first-run setup pages. + +Use it for expert configuration after understanding the operational effect of each option. + +## What You Can Do Here + +- Advanced Settings gathers technical peer settings that do not fit the first-run setup pages. +- Read the current value before changing it. +- Verify the effect on the public page, status page, or related administration page. + +## Page Architecture + +Configuration pages usually contain persistent settings. A visible form writes values into YaCy configuration, while the backend may reload subsystems such as language files, network listeners, cache handling, or search presentation. + +## Correct Use + +Read the current value before changing it. Configuration changes often persist beyond the current request and may affect later crawling, search, network contact, authentication, or resource use. Change one operational idea at a time and verify the result. + +## Access And Safety + +Administrator access is required. YaCy protects `_p` pages as administration pages. + +Protected related endpoint(s): `/Settings_p.html`. + +Backend checks: transaction token issued for forms. + +## Automation And API + +Page backend: `source/net/yacy/htroot/Settings_p.java`. + +| Endpoint | Method | Access | Backend | +| --- | --- | --- | --- | +| `/Settings_p.html` | `GET or POST` | admin | `source/net/yacy/htroot/Settings_p.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 | +| --- | --- | --- | + +Example request shape: + +```http +GET or POST /Settings_p.html?page=... +``` + +## What To Expect + +A successful change is visible as a saved value, a confirmation, or changed behavior on a related page. Some settings take effect immediately; others require reconnecting, reloading translations, restarting services, or watching the status page. + +## Related Pages + +- Related configuration work is usually reached from `ConfigBasic.html`, `Settings_p.html`, or the adjacent configuration page in the administration menu. -- cgit v1.2.3