mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-11-02 19:02:31 +00:00
docs: review settings documentation in all seven translations
This commit is contained in:
Jonatan
@@ -84,7 +84,7 @@
|
||||
"downloadCmd": "curl -fsSL -o /tmp/test https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh && head -1 /tmp/test",
|
||||
"downloadOutro": "If this fails outside ProxMenux, it's a network / proxy issue on the host.",
|
||||
"errorsTitle": "“Installer finished with errors”",
|
||||
"errorsBody": "The installer surfaced a non-zero exit code. The previous channel and any already-installed components are left as they were before the switch. Re-run the action; if it keeps failing, run the installer manually from a shell (see the manual equivalent above) — that gives you the full output instead of the dialog summary.",
|
||||
"errorsBody": "The installer returned a non-zero exit code. There is no automatic rollback: some files or components may already have changed. Inspect the output and current state before retrying. Run the installer manually from SSH or the host console for the full output.",
|
||||
"configTitle": "“Could not update config file” after switching to Stable",
|
||||
"configBody": "The post-install cleanup of beta metadata failed — usually because <code>config.json</code> has a syntax error from a manual edit. Validate it:",
|
||||
"configCmd": "jq . /usr/local/share/proxmenux/config.json",
|
||||
|
||||
@@ -1,22 +1,22 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Change Language | ProxMenux Documentation",
|
||||
"description": "Switch ProxMenux UI between English, Spanish, French, German, Italian or Portuguese. Translation install only — uses googletrans + a pre-cached translation table. The menu reloads automatically with the new language.",
|
||||
"description": "Choose from eight ProxMenux interface languages. Every installation includes pre-generated JSON translation catalogs; no translation service or Python environment is needed on the host. The menu reloads automatically.",
|
||||
"ogTitle": "Change Language | ProxMenux Documentation",
|
||||
"ogDescription": "Pick the ProxMenux interface language from the Settings menu. Six languages supported."
|
||||
"ogDescription": "Pick one of eight ProxMenux interface languages from Settings. Available on every installation."
|
||||
},
|
||||
"header": {
|
||||
"title": "Change Language",
|
||||
"description": "Switch the ProxMenux UI between six supported languages. Saves the choice to config.json and re-execs the menu with the new language. Only available on the Translation install type — the Normal (lightweight) install is English-only by design.",
|
||||
"description": "Switch the ProxMenux interface between eight supported languages. The choice is saved to config.json and the menu is restarted in the new language. Every installation includes the translation catalogs.",
|
||||
"section": "Settings"
|
||||
},
|
||||
"intro": {
|
||||
"title": "What this is",
|
||||
"body": "A dialog menu that lists the six supported languages. Pick one, ProxMenux saves it to <code>config.json</code> as <code>.language</code>, then re-execs <code>config_menu.sh</code> so the new language takes effect immediately."
|
||||
"body": "A dialog lists the eight supported languages. ProxMenux saves your choice to <code>config.json</code> as <code>.language</code>, then restarts <code>config_menu.sh</code> so it takes effect immediately."
|
||||
},
|
||||
"warn": {
|
||||
"title": "Translation install only",
|
||||
"body": "This option only appears in Settings if both checks pass: <code>/opt/googletrans-env/bin/activate</code> exists (Python venv with googletrans), <em>and</em> <code>config.json</code> has a non-empty <code>.language</code>. On the Normal (English-only) install neither is present and the language picker is not shown."
|
||||
"title": "Available on every installation",
|
||||
"body": "Settings always shows Change Language. Translation catalogs are installed in <code>/usr/local/share/proxmenux/lang/</code>, <em>and</em> the selected language is stored in <code>config.json</code>. No legacy Python translation environment is required."
|
||||
},
|
||||
"supported": {
|
||||
"heading": "Supported languages",
|
||||
@@ -32,38 +32,48 @@
|
||||
{
|
||||
"code": "es",
|
||||
"lang": "Spanish",
|
||||
"notes": "Cached + auto-translated"
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "fr",
|
||||
"lang": "French",
|
||||
"notes": "Cached + auto-translated"
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "de",
|
||||
"lang": "German",
|
||||
"notes": "Cached + auto-translated"
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "it",
|
||||
"lang": "Italian",
|
||||
"notes": "Cached + auto-translated"
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "pt",
|
||||
"lang": "Portuguese",
|
||||
"notes": "Cached + auto-translated"
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "sk",
|
||||
"lang": "Slovak",
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
},
|
||||
{
|
||||
"code": "sv",
|
||||
"lang": "Swedish",
|
||||
"notes": "Pre-generated JSON catalog"
|
||||
}
|
||||
]
|
||||
},
|
||||
"englishTip": {
|
||||
"title": "English is the most accurate",
|
||||
"body": "Non-English strings are produced by a pre-cached table seeded from googletrans. Edge-case strings (rarely triggered options, recent additions) may fall through to a live googletrans call or to the English original. If a translation feels off, English is always the source of truth."
|
||||
"body": "Non-English text comes from pre-generated JSON catalogs included with ProxMenux. Missing translations fall back to English; there is no live translation call on the host. English remains the reference when a translation seems incorrect."
|
||||
},
|
||||
"underHood": {
|
||||
"heading": "How it works under the hood",
|
||||
"items": [
|
||||
"Dialog menu lists the 6 codes; you pick one.",
|
||||
"The dialog lists eight language codes; choose one.",
|
||||
"If <code>config.json</code> exists: <code>jq --arg lang \"$new_language\" '.language = $lang''</code> updates the field in place.",
|
||||
"If <code>config.json</code> doesn't exist: a fresh one is created with the language code in a single-field object.",
|
||||
"Confirmation dialog: <em>\"Language changed to [code]\"</em>.",
|
||||
@@ -76,7 +86,7 @@
|
||||
"troubleshoot": {
|
||||
"heading": "Troubleshooting",
|
||||
"noOptionTitle": "Option doesn't appear in Settings",
|
||||
"noOptionBody": "You're on the Normal (English-only) install. To get language support, reinstall ProxMenux choosing the Translation install option (it pulls Python venv + googletrans).",
|
||||
"noOptionBody": "Change Language is always available in current releases. If it is missing, update ProxMenux using the official installer and open Settings again.",
|
||||
"stillEnglishTitle": "Language changed but UI still shows English",
|
||||
"stillEnglishBody": "The menu re-execs itself after the change. If you opened a fresh shell and started a different ProxMenux entrypoint, run <code>menu</code> again to pick up the new language. Confirm: <code>jq -r '.language' /usr/local/share/proxmenux/config.json</code>."
|
||||
},
|
||||
@@ -86,7 +96,7 @@
|
||||
{
|
||||
"href": "/docs/settings/show-version-information",
|
||||
"label": "Show Version Information",
|
||||
"tail": " — confirms install type and current language."
|
||||
"tail": " — confirms the release channel, translation files and current language."
|
||||
},
|
||||
{
|
||||
"href": "/docs/settings",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "ProxMenux Settings — Monitor Activation, Release Channel, Languages | ProxMenux",
|
||||
"description": "ProxMenux configuration menu: ProxMenux Monitor activation and service toggle, Reset Monitor Password, Change Release Channel between Stable and Beta, language selection (translation install), version information and uninstall. Options appear conditionally based on what is installed and active.",
|
||||
"description": "ProxMenux settings: Monitor service and password reset, Stable/Beta release channel, eight interface languages, version diagnostics and uninstall. Monitor options appear when its service is installed.",
|
||||
"ogTitle": "ProxMenux Settings — Monitor Activation, Release Channel, Languages",
|
||||
"ogDescription": "Configure ProxMenux — Monitor service, Release Channel, language, version info and uninstall.",
|
||||
"twitterTitle": "ProxMenux Settings",
|
||||
@@ -9,7 +9,7 @@
|
||||
},
|
||||
"header": {
|
||||
"title": "Settings",
|
||||
"description": "ProxMenux configuration menu. Lists what's installed, lets you toggle the Monitor service, reset the Monitor login password, switch between Stable and Beta release channels in either direction, change the UI language (Translation install only), and provides a clean uninstaller. Options appear conditionally — what you see depends on your install type and current state.",
|
||||
"description": "Configure ProxMenux: toggle the Monitor service, reset its login credentials, switch between Stable and Beta in either direction, choose one of eight interface languages, inspect version diagnostics and uninstall. Monitor actions require its service to be installed; language selection is always available.",
|
||||
"section": "Settings"
|
||||
},
|
||||
"intro": {
|
||||
@@ -18,33 +18,33 @@
|
||||
},
|
||||
"opening": {
|
||||
"heading": "Opening the menu",
|
||||
"body": "From ProxMenux's main menu, press <kbd>s</kbd>. The options shown depend on your install type and on what is currently active:",
|
||||
"imageAlt": "Settings ProxMenux menu with conditional options based on install type and component state"
|
||||
"body": "From ProxMenux's main menu, press <kbd>s</kbd>. Monitor actions appear when its service is installed; the remaining settings are always available:",
|
||||
"imageAlt": "ProxMenux Settings menu with conditional Monitor actions"
|
||||
},
|
||||
"installTypes": {
|
||||
"heading": "Two install types, different menus",
|
||||
"intro": "ProxMenux ships in two flavours. The Settings menu adapts to which one you have:",
|
||||
"heading": "One installation, all languages",
|
||||
"intro": "Current releases include static JSON translation catalogs in every installation. Older releases offered separate Translation and Normal modes:",
|
||||
"headerType": "Install type",
|
||||
"headerBundles": "What it bundles",
|
||||
"headerMenu": "Menu shows",
|
||||
"rows": [
|
||||
{
|
||||
"type": "Translation",
|
||||
"bundles": "Python venv + googletrans + multi-language config",
|
||||
"type": "Current installation",
|
||||
"bundles": "Static JSON catalogs for eight languages; no translation Python environment",
|
||||
"menuRich": "<strong>Change Language</strong> + Show Version + Uninstall"
|
||||
},
|
||||
{
|
||||
"type": "Normal (lightweight)",
|
||||
"bundles": "English-only, no venv, smaller footprint",
|
||||
"menu": "Show Version + Uninstall (no language picker)"
|
||||
"type": "Legacy Translation / Normal modes",
|
||||
"bundles": "Obsolete split between a translation environment and an English-only installation",
|
||||
"menu": "Update with the official installer to use the current unified menu"
|
||||
}
|
||||
],
|
||||
"detectionTitle": "Detection happens automatically",
|
||||
"detectionBody": "The script checks for <code>/opt/googletrans-env/bin/activate</code> and a non-empty <code>language</code> key in <code>config.json</code>. Both present → Translation install. Either missing → Normal install. You don't choose; the menu adapts."
|
||||
"detectionTitle": "Language selection is always available",
|
||||
"detectionBody": "The menu no longer checks for a translation environment. Every installation includes <code>/usr/local/share/proxmenux/lang/</code> and saves the selected <code>language</code> in <code>config.json</code>."
|
||||
},
|
||||
"options": {
|
||||
"heading": "Menu options",
|
||||
"intro": "Five tools. The <em>Conditional</em> badges mean the option only appears when the prerequisite is met (Monitor installed; Beta program active; Translation install).",
|
||||
"intro": "The tools below manage ProxMenux itself. <em>Conditional</em> means the Monitor actions appear only when its systemd service is installed. Release channel, language, version diagnostics and uninstall are always available.",
|
||||
"list": [
|
||||
{
|
||||
"icon": "Activity",
|
||||
@@ -64,7 +64,7 @@
|
||||
"icon": "Info",
|
||||
"href": "/docs/settings/show-version-information",
|
||||
"title": "Show Version Information",
|
||||
"description": "ProxMenux version, install type, installed components, file paths, virtual environment state and current language."
|
||||
"description": "ProxMenux version, release channel, installed components, file paths, translation files and current language."
|
||||
},
|
||||
{
|
||||
"icon": "Trash2",
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Show Version Information | ProxMenux Documentation",
|
||||
"description": "Read-only ProxMenux self-diagnostic: version number, install type (Translation / Normal), installed components from config.json, file paths, virtual environment state and current language.",
|
||||
"description": "Read-only ProxMenux diagnostics: version, release channel, components recorded in config.json, file paths, translation catalogs and current language.",
|
||||
"ogTitle": "Show Version Information | ProxMenux Documentation",
|
||||
"ogDescription": "Diagnostic dump of ProxMenux version, install type, components, files and language."
|
||||
"ogDescription": "Diagnostic output of ProxMenux version, release channel, components, files and language."
|
||||
},
|
||||
"header": {
|
||||
"title": "Show Version Information",
|
||||
"description": "Read-only diagnostic. Reads version.txt, config.json and a few well-known file paths, then renders a scrollable text box with version, install type, installed components, file presence, virtual environment state and current language.",
|
||||
"description": "Read-only diagnostics. Reads version.txt, config.json and known file paths, then shows a scrollable text box with the version, release channel, installed components, file presence, translation files and current language.",
|
||||
"section": "Settings"
|
||||
},
|
||||
"intro": {
|
||||
@@ -26,9 +26,9 @@
|
||||
"contentRich": "Single-line version number; <code>Unknown</code> if file missing"
|
||||
},
|
||||
{
|
||||
"section": "Install type",
|
||||
"source": "venv + config.json checks",
|
||||
"content": "Translation (multi-language) or Normal (English-only)"
|
||||
"section": "Release channel",
|
||||
"source": "config.json beta-program status",
|
||||
"content": "Stable (main) or Beta (develop); beta version when available"
|
||||
},
|
||||
{
|
||||
"section": "Installed components",
|
||||
@@ -41,14 +41,14 @@
|
||||
"contentRich": "<code>menu</code>, <code>utils.sh</code>, <code>config.json</code>, <code>version.txt</code> presence + paths"
|
||||
},
|
||||
{
|
||||
"section": "Virtual environment",
|
||||
"source": "/opt/googletrans-env",
|
||||
"content": "Translation install only — venv + pip presence"
|
||||
"section": "Translation files",
|
||||
"source": "/usr/local/share/proxmenux/lang/",
|
||||
"content": "Presence of the lang/ directory included with every installation"
|
||||
},
|
||||
{
|
||||
"section": "Current language",
|
||||
"source": "config.json",
|
||||
"contentRich": "Translation: language code from <code>.language</code>; Normal: <code>English (Fixed)</code>"
|
||||
"contentRich": "Language code from <code>.language</code>; defaults to <code>en</code> when unset"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Uninstall ProxMenux | ProxMenux Documentation",
|
||||
"description": "Clean ProxMenux uninstaller with optional dependency removal (jq, dialog, python3-*) and automatic restoration of /root/.bashrc and /etc/motd backups created at install time. Also removes the proxmenux-monitor service if present.",
|
||||
"description": "Clean ProxMenux uninstaller with optional removal of jq and dialog, cleanup of legacy translation files and the Monitor service, and restoration of system-file backups.",
|
||||
"ogTitle": "Uninstall ProxMenux | ProxMenux Documentation",
|
||||
"ogDescription": "Cleanly remove ProxMenux from a Proxmox host with optional dependency cleanup."
|
||||
},
|
||||
@@ -18,32 +18,32 @@
|
||||
"heading": "The uninstall flow",
|
||||
"items": [
|
||||
"<strong>Confirmation dialog.</strong> Yes/no — “Are you sure you want to uninstall ProxMenux?”",
|
||||
"<strong>Dependency removal checklist.</strong> Pre-selected list depends on install type (see table below). All boxes default to OFF — you opt in to removing each dependency.",
|
||||
"<strong>Removal runs with a progress bar.</strong> Removes the venv (Translation install only), the <code>menu</code> launcher, the <code>/usr/local/share/proxmenux/</code> tree, the ProxMenux Monitor service if present together with the notification target it registered in Proxmox VE (<code>proxmenux-webhook</code> and its matcher), the dependencies you ticked, and finally restores the system file backups (see below).",
|
||||
"<strong>Dependency removal checklist.</strong> Offers jq and dialog. Both boxes are OFF by default; select only dependencies that no other application needs.",
|
||||
"<strong>Removal runs with a progress bar.</strong> Removes any leftover legacy translation environment, the <code>menu</code> launcher, the <code>/usr/local/share/proxmenux/</code> tree, the ProxMenux Monitor service if present together with the notification target it registered in Proxmox VE (<code>proxmenux-webhook</code> and its matcher), the dependencies you ticked, and finally restores the system file backups (see below).",
|
||||
"<strong>Completion dialog.</strong> Lists removed dependencies and exits."
|
||||
]
|
||||
},
|
||||
"deps": {
|
||||
"heading": "Dependency removal: what's offered",
|
||||
"intro": "The checklist depends on install type. <strong>None of the boxes is checked by default</strong> — these are system-wide packages that other applications might use, so the safer default is to leave them.",
|
||||
"headerType": "Install type",
|
||||
"intro": "The checklist offers jq and dialog. <strong>Neither box is checked by default</strong>: other applications may use these system-wide packages, so keeping them is safer.",
|
||||
"headerType": "Installation",
|
||||
"headerOffered": "Offered for removal",
|
||||
"rows": [
|
||||
{
|
||||
"type": "Translation",
|
||||
"offeredRich": "<code>python3-venv</code>, <code>python3-pip</code>, <code>python3</code>, <code>jq</code>"
|
||||
"type": "Current releases",
|
||||
"offeredRich": "<code>dialog</code>, <code>jq</code>"
|
||||
},
|
||||
{
|
||||
"type": "Normal",
|
||||
"type": "Legacy installations after updating",
|
||||
"offeredRich": "<code>dialog</code>, <code>jq</code>"
|
||||
}
|
||||
],
|
||||
"warnTitle": "System-wide packages — think twice",
|
||||
"warnBody": "<code>python3</code>, <code>jq</code> and <code>dialog</code> are commonly used by other tools (including Proxmox itself in some workflows). Removing <code>python3</code> in particular can break Proxmox helpers, Ceph utilities and many third-party scripts. Leave them unless you're positive nothing else needs them."
|
||||
"warnBody": "The current checklist offers <code>jq</code> and <code>dialog</code>, not <code>python3</code>. These are system packages that other tools may need. Removal can also remove dependent packages or unused dependencies. Keep required packages and review any proposed removal before running apt manually."
|
||||
},
|
||||
"removed": {
|
||||
"heading": "What gets removed",
|
||||
"code": "/usr/local/bin/menu # the launcher\n/usr/local/share/proxmenux/ # everything: scripts, config, cache, version\n/opt/googletrans-env/ # virtual env (Translation install only)\n/etc/systemd/system/proxmenux-monitor.service # Monitor service unit\n/root/.config/proxmenux-monitor/ # Monitor config dir\n # + dependencies you ticked in the checklist"
|
||||
"code": "/usr/local/bin/menu # the launcher\n/usr/local/share/proxmenux/ # everything: scripts, config, cache, version\n/opt/googletrans-env/ # leftover legacy translation environment\n/etc/systemd/system/proxmenux-monitor.service # Monitor service unit\n/root/.config/proxmenux-monitor/ # Monitor config dir\n # + dependencies you ticked in the checklist"
|
||||
},
|
||||
"restored": {
|
||||
"heading": "What gets restored",
|
||||
@@ -59,18 +59,18 @@
|
||||
"manual": {
|
||||
"heading": "Manual uninstall",
|
||||
"intro": "If for some reason the menu uninstaller can't run (e.g. <code>dialog</code> already missing), the equivalent manual sequence:",
|
||||
"code": "# 1. Stop and remove the Monitor service (if installed)\nsystemctl stop proxmenux-monitor.service 2>/dev/null\nsystemctl disable proxmenux-monitor.service 2>/dev/null\nrm -f /etc/systemd/system/proxmenux-monitor.service\nrm -rf /root/.config/proxmenux-monitor\nsystemctl daemon-reload\nsystemctl reset-failed 2>/dev/null\n\n# 2. Remove the venv (Translation install only)\nrm -rf /opt/googletrans-env\n\n# 3. Remove ProxMenux files\nrm -f /usr/local/bin/menu\nrm -rf /usr/local/share/proxmenux\n\n# 4. Restore backups\n[ -f /root/.bashrc.bak ] && mv /root/.bashrc.bak /root/.bashrc\n[ -f /etc/motd.bak ] && mv /etc/motd.bak /etc/motd \\\n || sed -i '/This system is optimised by: ProxMenux/d' /etc/motd"
|
||||
"code": "# 1. Stop and remove the Monitor service (if installed)\nsystemctl stop proxmenux-monitor.service 2>/dev/null\nsystemctl disable proxmenux-monitor.service 2>/dev/null\nrm -f /etc/systemd/system/proxmenux-monitor.service\nrm -rf /root/.config/proxmenux-monitor\nsystemctl daemon-reload\nsystemctl reset-failed 2>/dev/null\n\n# 2. Remove a leftover legacy translation environment\nrm -rf /opt/googletrans-env\n\n# 3. Remove ProxMenux files\nrm -f /usr/local/bin/menu\nrm -rf /usr/local/share/proxmenux\n\n# 4. Restore backups\n[ -f /root/.bashrc.bak ] && mv /root/.bashrc.bak /root/.bashrc\n[ -f /etc/motd.bak ] && mv /etc/motd.bak /etc/motd \\\n || sed -i '/This system is optimised by: ProxMenux/d' /etc/motd"
|
||||
},
|
||||
"reinstall": {
|
||||
"heading": "Reinstalling later",
|
||||
"body": "Run the official ProxMenux installer again. Pick Translation or Normal as you prefer — the choice is independent of what you had before."
|
||||
"body": "Run the official ProxMenux installer again. Current releases use one installation path with all eight interface languages included."
|
||||
},
|
||||
"troubleshoot": {
|
||||
"heading": "Troubleshooting",
|
||||
"hangTitle": "Uninstall hangs at “Removing googletrans and virtual environment”",
|
||||
"hangBody": "<code>pip uninstall</code> can stall if pip is unresponsive. From another shell: <code>rm -rf /opt/googletrans-env</code> directly (the script does the same as a fallback after pip).",
|
||||
"hangTitle": "Uninstall stalls while removing a legacy translation environment",
|
||||
"hangBody": "Current releases remove a leftover environment with <code>rm -rf /opt/googletrans-env</code>; they do not run <code>pip uninstall</code>. If this step stalls, inspect it from another shell and check the host filesystem before retrying.",
|
||||
"aptTitle": "apt warns about packages still in use during dependency removal",
|
||||
"aptBody": "Expected if you ticked <code>python3</code> or <code>jq</code> while other things on the host depend on them. apt's <code>autoremove</code> will refuse to remove them in that case (which is the safe behaviour). Untick that dependency and re-run.",
|
||||
"aptBody": "Selected packages are marked automatic and passed to <code>apt-get -y --purge autoremove</code>. This does not guarantee that dependent services are protected. Leave dependencies unchecked if other tools need them; review apt’s proposed removals before any manual cleanup.",
|
||||
"motdTitle": "MOTD still shows the ProxMenux line after uninstall",
|
||||
"motdBody": "Either no <code>/etc/motd.bak</code> existed and the sed strip didn't match (e.g. the line was modified). Edit <code>/etc/motd</code> by hand and remove any leftover ProxMenux line."
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user