From 537a178d81616090ee1201603c73948db4ae8c18 Mon Sep 17 00:00:00 2001 From: bergware Date: Sat, 9 May 2020 09:15:03 +0200 Subject: [PATCH 01/14] Multi-language support --- plugins/dynamix.apcupsd/UPSsettings.page | 68 +- .../DockerRepositories.page | 7 +- .../DockerSettings.page | 119 +- .../include/CreateDocker.php | 89 +- .../dynamix.plugin.manager/PluginInstall.page | 6 +- .../dynamix.plugin.manager/PluginsError.page | 5 +- .../dynamix.plugin.manager/PluginsStale.page | 4 +- plugins/dynamix.vm.manager/VMSettings.page | 83 +- plugins/dynamix/ArrayDevices.page | 67 +- plugins/dynamix/ArrayOperation.page | 97 +- plugins/dynamix/BootDevice.page | 7 +- plugins/dynamix/CPUisol.page | 7 +- plugins/dynamix/CPUpin.page | 19 +- plugins/dynamix/CPUvms.page | 12 +- plugins/dynamix/CacheDevices.page | 37 +- plugins/dynamix/Confirmations.page | 8 +- plugins/dynamix/DateTime.page | 29 +- plugins/dynamix/DeviceAttributes.page | 9 +- plugins/dynamix/DeviceCapabilities.page | 6 +- plugins/dynamix/DeviceIdentify.page | 4 +- plugins/dynamix/DeviceInfo.page | 166 +- plugins/dynamix/DiskList.page | 20 +- plugins/dynamix/DiskSettings.page | 150 +- plugins/dynamix/DisplaySettings.page | 36 +- plugins/dynamix/Eth0.page | 207 +- plugins/dynamix/EthX.page | 169 +- plugins/dynamix/FTP.page | 20 +- plugins/dynamix/FlashInfo.page | 4 +- plugins/dynamix/Identification.page | 16 +- plugins/dynamix/ManagementAccess.page | 124 +- plugins/dynamix/MoverSettings.page | 24 +- plugins/dynamix/NFS.page | 29 +- plugins/dynamix/NetworkRules.page | 10 +- plugins/dynamix/Notifications.page | 64 +- plugins/dynamix/OpenDevices.page | 5 +- plugins/dynamix/ParityCheck.page | 25 +- plugins/dynamix/RoutingTable.page | 9 +- plugins/dynamix/SMBExtras.page | 8 +- plugins/dynamix/SMBWorkGroup.page | 9 +- plugins/dynamix/SMBsettings.page | 36 +- plugins/dynamix/SecurityNFS.page | 10 +- plugins/dynamix/SecuritySMB.page | 76 +- plugins/dynamix/Selftest.page | 31 +- plugins/dynamix/ShareEdit.page | 133 +- plugins/dynamix/ShareList.page | 20 +- plugins/dynamix/ShareSettings.page | 44 +- plugins/dynamix/SmtpSettings.page | 46 +- plugins/dynamix/Syslinux.page | 14 +- plugins/dynamix/SyslogSettings.page | 38 +- plugins/dynamix/UserAdd.page | 17 +- plugins/dynamix/UserEdit.page | 12 +- plugins/dynamix/help/helptext.txt | 2046 +++++++++++++++++ plugins/dynamix/include/Translations.php | 14 +- 53 files changed, 2382 insertions(+), 1933 deletions(-) create mode 100644 plugins/dynamix/help/helptext.txt diff --git a/plugins/dynamix.apcupsd/UPSsettings.page b/plugins/dynamix.apcupsd/UPSsettings.page index 363f69210..fb6f541d2 100644 --- a/plugins/dynamix.apcupsd/UPSsettings.page +++ b/plugins/dynamix.apcupsd/UPSsettings.page @@ -60,9 +60,7 @@ _(Start APC UPS daemon)_: -:help155 -> Set to 'Yes' to enable apcupsd and start the daemon, set to 'No' to disable apcupsd and stop the daemon. -:end +:apc_ups_daemon_help: _(UPS cable)_: : -:help156 -> Defines the type of cable connecting the UPS to your computer.Possible generic choices for 'cable' are: -> -> + USB, Simple, Smart, Ether, or Custom to specify a special cable. -:end +:apc_ups_cable_help: _(Custom UPS cable)_: : -:help157 -> Specify a special cable by model number, only applicable when *UPS cable* is set to Custom. -> -> + 940-0119A, 940-0127A, 940-0128A, 940-0020B -> + 940-0020C, 940-0023A, 940-0024B, 940-0024C -> + 940-1524C, 940-0024G, 940-0095A, 940-0095B -> + 940-0095C, 940-0625A, M-04-02-2000 -:end +:apc_ups_custom_cable_help: _(UPS type)_: : -:help158 -> Define a *UPS type*, which corresponds to the type of UPS you have (see the Description for more details). -> -> + **USB** - most new UPSes are USB -> + **APCsmart** - newer serial character device, appropriate for SmartUPS models using a serial cable (not USB) -> + **Net** - network link to a master apcupsd through apcupsd's Network Information Server. This is used if the UPS powering your computer is connected to a different computer for monitoring -> + **SNMP** - SNMP network link to an SNMP-enabled UPS device -> + **Dumb** - old serial character device for use with simple-signaling UPSes -> + **PCnet** - PowerChute Network Shutdown protocol which can be used as an alternative to SNMP with the AP9617 family of smart slot cards -> + **ModBus** - serial device for use with newest SmartUPS models supporting the MODBUS protocol -:end +:apc_ups_type_help: _(Device)_: : -:help159 -> Enter the *device* which correspondes to your situation, only applicable when *UPS type* is not set to USB. -> -> + **apcsmart** - /dev/tty** -> + **net** - hostname:port. Hostname is the IP address of the NIS server. The deafult port is 3551 -> + **snmp** - hostname:port:vendor:community. Hostname is the ip address or hostname of the UPS on the network. Vendor can be can be "APC" or "APC_NOTRAP". "APC_NOTRAP" will disable SNMP trap catching; you usually want "APC". Port is usually 161. Community is usually "private" -> + **dumb** - /dev/tty** -> + **pcnet** - ipaddr:username:passphrase:port. ipaddr is the IP address of the UPS management card. username and passphrase are the credentials for which the card has been configured. port is the port number on which to listen for messages from the UPS, normally 3052. If this parameter is empty or missing, the default of 3052 will be used -> + **modbus** - /dev/tty** -:end +:apc_ups_device_help: _(Battery level to initiate shutdown)_ (%): : -:help160 -> If during a power failure, the remaining battery percentage (as reported by the UPS) is below or equal to *Battery level*, apcupsd will initiate a system shutdown. -:end +:apc_battery_level_help: _(Runtime left to initiate shutdown)_ (_(minutes)_): : -:help161 -> If during a power failure, the remaining runtime in minutes (as calculated internally by the UPS) is below or equal to *minutes*, apcupsd, will initiate a system shutdown. -:end +:apc_runtime_left_help: _(Time on battery before shutdown)_ (_(seconds)_): : -:help162 -> If during a power failure, the UPS has run on batteries for *time-out* many seconds or longer; apcupsd will initiate a system shutdown. A value of zero disables this timer. -> -> If you have a Smart UPS, you will most likely want to disable this timer by setting it to zero. -> That way, your UPS will continue on batteries until either the % charge remaining drops to or below *Battery level* or the remaining battery runtime drops to or below *minutes*. -> -> Of course - when testing - setting this to 60 causes a quick system shutdown if you pull the power plug. -> If you have an older dumb UPS, you will want to set this to less than the time you know you can run on batteries. -:end +:apc_battery_time_help:
-:help163 -> **Note:** *Battery level*, *Runtime left*, and *Time on battery* work in conjunction, so the first that occurs will cause the initiation of a shutdown. -:end +:apc_note_help: _(Turn off UPS after shutdown)_: : -:help164 -> Set to *Yes* to turn off the power to the UPS after a shutdown. -:end +:apc_killups_help: : diff --git a/plugins/dynamix.docker.manager/DockerRepositories.page b/plugins/dynamix.docker.manager/DockerRepositories.page index 6a955d145..bf35db91a 100644 --- a/plugins/dynamix.docker.manager/DockerRepositories.page +++ b/plugins/dynamix.docker.manager/DockerRepositories.page @@ -27,12 +27,7 @@ $template_repos = $dockerManPaths['template-repos']; _(Template repositories)_: : -:help1 -> Use this field to add template repositories. -> Docker templates are used to facilitate the creation and re-creation of Docker containers. Please setup one per line. -> -> For a list of popular community-supported repositories, visit here: http://lime-technology.com/forum/index.php?topic=37958.0 -:end +:docker_repostiroties_help:   : diff --git a/plugins/dynamix.docker.manager/DockerSettings.page b/plugins/dynamix.docker.manager/DockerSettings.page index 7860eaf30..baf4c5d9f 100644 --- a/plugins/dynamix.docker.manager/DockerSettings.page +++ b/plugins/dynamix.docker.manager/DockerSettings.page @@ -153,22 +153,14 @@ _(Enable Docker)_: _(One or more paths do not exist)_ (_(view)_) -:help33 -> Before you can start the Docker service for the first time, please specify an image file for Docker to install to. -> -> Once started, Docker will always automatically start after the array has been started. -:end +:docker_enable_help: _(Docker vDisk size)_: : GB -:help34 -> If the system needs to create a new docker image file, this is the default size to use specified in GB. -> -> To resize an existing image file, specify the new size here. Next time the Docker service is started the file (and file system) will increased to the new size (but never decreased). -:end +:docker_vdisk_size_help: _(Docker vDisk location)_: : @@ -181,13 +173,7 @@ _(Docker vDisk location)_: _(Path does not exist)_ -:help35 -> You must specify an image file for Docker. The system will automatically create this file when the Docker service is first started. -> -> The image file name must have the extension .img, e.g. If not the input is not accepted and marked red. -> -> It is recommended to create this image file outside the array, e.g. on the Cache pool. For best performance SSD devices are preferred. -:end +:docker_vdisk_location_help: _(Default appdata storage location)_: : @@ -197,15 +183,7 @@ _(Default appdata storage location)_: _(Path does not exist)_ -:help36 -> You can specify a folder to automatically generate and store subfolders containing configuration files for each Docker app (via the /config mapped volume). -> -> The folder's path must end with a trailing slash (/) character. If not the input is not accepted and marked red. -> -> It is recommended to create this folder outside the array, e.g. on the Cache pool. For best performance SSD devices are preferred. -> -> Only used when adding new Docker apps. Editing existing Docker apps will not be affected by this setting. -:end +:docker_appdata_location_help:
_(Docker LOG rotation)_: @@ -214,11 +192,7 @@ _(Docker LOG rotation)_: -:help37 -> By default LOG rotation is disabled and will create a single LOG file of unlimited size. -> -> Enable LOG rotation to limit the size of the LOG file and specify the number of files to keep in the rotation scheme. -:end +:docker_log_rotation_help: _(Template Authoring Mode)_: @@ -253,9 +223,7 @@ _(Template Authoring Mode)_: -:help40 -> If set to **Yes**, when creating/editing containers the interface will be present with some extra fields related to template authoring. -:end +:docker_authoring_mode_help: _(Host access to custom networks)_: : -:help41 -> Allows direct communication between the host and containers using a custom (macvlan) network.
-> By default this is prohibited. -:end +:docker_custom_network_access_help: _(Preserve user defined networks)_: : -:help42 -> User created networks are networks created by the user outside of the GUI.
-> By default user created networks are removed from Docker. This is done to prevent potential conflicts with the automatic generation of custom networks. -> -> Change this setting to preserve user defined networks, but it is the responsibility of the user to ensure these entries work correctly and are conflict free. -:end +:docker_user_defined_network_help: $route):?> (_(optional)_): -:help43 -> Include (default) or exclude the above interfaces or VLANs as custom network for Docker. -> -> Enter the pool range within each allocated subnet which is used for DHCPv4 assignments by Docker. E.g. 192.168.1.128/25 -:end +:docker_include_interface_vlan_ipv4_help: @@ -369,11 +325,7 @@ _(IPv4 custom network on interface)_ (_(optional)_): -:help44 -> Include or exclude (default) the above interfaces or VLANs as custom network for Docker. -> -> Enter the pool range within each allocated subnet which is used for DHCPv4 assignments by Docker. E.g. 192.168.1.128/25 -:end +:docker_exclude_interface_vlan_ipv4_help: @@ -412,11 +364,7 @@ _(IPv6 custom network on interface)_ (_(optional)_): -:help45 -> Include (default) or exclude the above interfaces or VLANs as custom network for Docker. -> -> Enter the pool range within each allocated subnet which is used for DHCPv6 assignments by Docker. E.g. 2a02:abcd:9ef5:100:1::/72 -:end +:docker_include_interface_vlan_ipv6_help: @@ -443,11 +391,7 @@ _(IPv6 custom network on interface)_ (_(optional)_): -:help46 -> Include or exclude (default) the above interfaces or VLANs as custom network for Docker. -> -> Enter the pool range within each allocated subnet which is used for DHCPv6 assignments by Docker. E.g. 2a02:abcd:9ef5:100:1::/72 -:end +:docker_exclude_interface_vlan_ipv6_help:
@@ -456,46 +400,33 @@ _(IPv6 custom network on interface)_ (_(optional)_): _(Docker version)_: : getInfo(); echo $arrInfo['Version']?> -:help47 -> This is the active Docker version. -:end +:docker_version_help: _(Docker vDisk location)_: : -:help48 -> This is the location of the Docker image. -:end +:docker_vdisk_location_active_help: _(Default appdata storage location)_: : -:help49 -> This is the storage location for Docker containers. -:end +:docker_appdata_location_active_help:
_(Docker LOG rotation)_: : -:help50 -> By default a single unlimited LOG file is created. Otherwise LOG file size and number of files are limited when LOG rotation is enabled. -:end +:docker_log_rotation_active_help: _(Host access to custom networks)_: : -:help51 -> Allows direct communication between the host and containers using a custom (macvlan) network.
-> By default this is prohibited. -:end +:docker_user_defined_network_active_help: _(Preserve user defined networks)_: : -:help52 -> Shows whether networks created outside of the GUI are removed or preserved for Docker. When preserved *user defined networks* become available in the *Network type* dropdown list of containers. -:end +:docker_user_defined_network_active_help: $route):?> -:help53 -> **Scrub** runs the *btrfs scrub* program to check file system integrity. -> -> If repair is needed you should check the *Correct file system errors* and run a second Scrub pass; this will permit *btrfs scrub* to fix the file system. -:end +:docker_scrub_help: @@ -611,9 +538,7 @@ _(btrfs scrub status)_:   : -:help54 -> **Cancel** will cancel the Scrub operation in progress. -:end +:docker_cancel_help: diff --git a/plugins/dynamix.docker.manager/include/CreateDocker.php b/plugins/dynamix.docker.manager/include/CreateDocker.php index 67d5f8db4..55194cd39 100644 --- a/plugins/dynamix.docker.manager/include/CreateDocker.php +++ b/plugins/dynamix.docker.manager/include/CreateDocker.php @@ -705,21 +705,7 @@ _(Template)_: } ?> -:help1 -> Templates are a quicker way to setting up Docker Containers on your Unraid server. There are two types of templates: -> -> **Default templates**
-> When valid repositories are added to your Docker Repositories page, they will appear in a section on this drop down for you to choose (master categorized by author, then by application template). -> After selecting a default template, the page will populate with new information about the application in the Description field, and will typically provide instructions for how to setup the container. -> Select a default template when it is the first time you are configuring this application. -> -> **User-defined templates**
-> Once you've added an application to your system through a Default template, -> the settings you specified are saved to your USB flash device to make it easy to rebuild your applications in the event an upgrade were to fail or if another issue occurred. -> To rebuild, simply select the previously loaded application from the User-defined list and all the settings for the container will appear populated from your previous setup. -> Clicking create will redownload the necessary files for the application and should restore you to a working state. -> To delete a User-defined template, select it from the list above and click the red X to the right of it. -:end +:docker_client_general_help:
@@ -728,9 +714,7 @@ _(Template)_: _(Name)_: : -:help2 -> Give the container a name or leave it as default. -:end +:docker_client_name_help:
@@ -742,9 +726,7 @@ _(Overview)_: _(Overview)_: : -:help3 -> A description for the application container. Supports basic HTML mark-up. -:end +:docker_client_overview_help:
@@ -752,10 +734,7 @@ _(Overview)_: _(Repository)_: : -:help4 -> The repository for the application on the Docker Registry. Format of authorname/appname. -> Optionally you can add a : after appname and request a specific version for the container image. -:end +:docker_client_repository_help:
@@ -807,88 +786,63 @@ _(Categories)_: _(Support Thread)_: : -:help5 -> Link to a support thread on Lime-Technology's forum. -:end +:docker_client_support_thread_help: _(Project Page)_: : -:help6 -> Link to the project page (eg: www.plex.tv) -:end +:docker_client_project_page_help: _(Donation Text)_: : -:help7 -> Text to appear on Donation Links Within The Apps Tab -:end +:docker_client_donation_text_help: _(Donation Link)_: : -:help8 -> Link to the donation page. If using donation's, both the image and link must be set -:end +:docker_client_donation_link_help:
_(Docker Hub URL)_: : -:help9 -> The path to the container's repository location on the Docker Hub. -:end +:docker_client_hub_url_help:
_(Template URL)_: : -:help10 -> This URL is used to keep the template updated. -:end +:docker_client_template_url_help:
_(Icon URL)_: : -:help11 -> Link to the icon image for your application (only displayed on dashboard if Show Dashboard apps under Display Settings is set to Icons). -:end +:docker_client_icon_url_help: _(WebUI)_: : -:help12 -> When you click on an application icon from the Docker Containers page, the WebUI option will link to the path in this field. -> Use [IP] to identify the IP of your host and [PORT:####] replacing the #'s for your port. -:end +:docker_client_webui_help: _(Extra Parameters)_: : -:help13 -> If you wish to append additional commands to your Docker container at run-time, you can specify them here.
-> For all possible Docker run-time commands, see here: https://docs.docker.com/reference/run/ -:end +:docker_extra_parameters_help: _(Post Arguments)_: : -:help14 -> If you wish to append additional arguments AFTER the container definition, you can specify them here. -> The content of this field is container specific. -:end +:docker_post_arguments_help: _(CPU Pinning)_: : -:help15 -> Checking a CPU core(s) will limit the container to run on the selected cores only. Selecting no cores lets the container run on all available cores (default) -:end +:docker_cpu_pinning_help:
_(Network Type)_: @@ -904,13 +858,7 @@ _(Network Type)_: _(Fixed IP address)_ (_(optional)_): : -:help16 -> If the Bridge type is selected, the application’s network access will be restricted to only communicating on the ports specified in the port mappings section. -> If the Host type is selected, the application will be given access to communicate using any port on the host that isn’t already mapped to another in-use application/service. -> Generally speaking, it is recommended to leave this setting to its default value as specified per application template. -> -> IMPORTANT NOTE: If adjusting port mappings, do not modify the settings for the Container port as only the Host port can be adjusted. -:end +:docker_fixed_ip_help: _(Console shell command)_: @@ -922,10 +870,7 @@ _(Console shell command)_: _(Privileged)_: : -:help17 -> For containers that require the use of host-device access directly or need full exposure to host capabilities, this option will need to be selected. -> For more information, see this link: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities -:end +:docker_privileged_help:
diff --git a/plugins/dynamix.plugin.manager/PluginInstall.page b/plugins/dynamix.plugin.manager/PluginInstall.page index 9ce920956..193b4d410 100644 --- a/plugins/dynamix.plugin.manager/PluginInstall.page +++ b/plugins/dynamix.plugin.manager/PluginInstall.page @@ -28,11 +28,7 @@ function installPlugin(name) { -:help1 -> To download and install a plugin, enter the plg file URL and click **Install**. A window will open -> that displays install progress. Do not close this window until install has completed. You may also specify -> the local file name of an extension. -:end +:plugin_install_help: **_(Select local plugin file)_**
diff --git a/plugins/dynamix.plugin.manager/PluginsError.page b/plugins/dynamix.plugin.manager/PluginsError.page index c50ef7f88..352f7b83e 100644 --- a/plugins/dynamix.plugin.manager/PluginsError.page +++ b/plugins/dynamix.plugin.manager/PluginsError.page @@ -36,7 +36,4 @@ foreach (glob("/boot/config/plugins-error/*.plg", GLOB_NOSORT) as $plugin_file) echo ""; ?> -:help2 -> These plugins were not installed because of some kind of installation error. You should delete these -> plugins and then **reboot** your server.* -:end +:plugin_error_help: diff --git a/plugins/dynamix.plugin.manager/PluginsStale.page b/plugins/dynamix.plugin.manager/PluginsStale.page index 264dbbe0c..7b82cd18c 100644 --- a/plugins/dynamix.plugin.manager/PluginsStale.page +++ b/plugins/dynamix.plugin.manager/PluginsStale.page @@ -68,6 +68,4 @@ foreach (glob("/boot/config/plugins-stale/*.plg", GLOB_NOSORT) as $plugin_file) echo ""; ?> -:help3 -> These plugins were not installed because newer code already exists. It is safe to simply delete these. -:end +:plugin_stale_help: diff --git a/plugins/dynamix.vm.manager/VMSettings.page b/plugins/dynamix.vm.manager/VMSettings.page index cb0c13b55..922e0157c 100644 --- a/plugins/dynamix.vm.manager/VMSettings.page +++ b/plugins/dynamix.vm.manager/VMSettings.page @@ -94,9 +94,7 @@ _(Enable VMs)_: -:help105 -> Stopping the VM Manager will first attempt to shutdown all running VMs. After 60 seconds, any remaining VM instances will be terminated. -:end +:vms_enable_help:
@@ -112,7 +110,7 @@ _(QEMU version)_: _(Libvirt storage location)_: : -:help106 +:vms_libvirt_volume_help: > This is the libvirt volume. :end @@ -120,32 +118,23 @@ _(Libvirt storage location)_: _(Libvirt vdisk size)_: : _(GB)_ -:help107 -> If the system needs to create a new libvirt image file, this is the default size to use specified in GB. -> To resize an existing image file, specify the new size here. Next time the Libvirt service is started the file (and file system) will increased to the new size (but never decreased). -:end +:vms_libvirt_vdisk_size_help: _(Libvirt storage location)_: : _(Modify with caution: unable to validate path until Array is Started)_ _(Path does not exist)_ -:help108 -> You must specify an image file for Libvirt. The system will automatically create this file when the Libvirt service is first started. -:end +:vms_libvirt_location_help: _(Default VM storage path)_: : _(Modify with caution: unable to validate path until Array is Started)_ _(Path does not exist)_ -:help109 -> Specify a user share that contains all your VM subdirectories with vdisks -:end +:vms_libvirt_storage_help: _(Default ISO storage path)_: : _(Modify with caution: unable to validate path until Array is Started)_ _(Path does not exist)_ -:help110 -> Specify a user share that contains all your installation media for operating systems -:end +:vms_libvirt_iso_storage_help:
_(Default Windows VirtIO driver ISO)_ (_(optional)_): @@ -170,15 +159,7 @@ _(Default Windows VirtIO driver ISO)_ (_(optional)_): ?> placeholder="_(Click to Select)_" pattern="^[^\\]*\.(iso|ISO)$"> _(Remove)_ _(Download)_> -:help111 -> Specify the virtual CD-ROM (ISO) that contains the VirtIO Windows drivers as provided by the Fedora Project. -> Download the latest ISO from here: fedoraproject.org -> -> When installing Windows, you will reach a step where no disk devices will be found. There is an option to browse for drivers on that screen. -> Click browse and locate the additional CD-ROM in the menu. Inside there will be various folders for the different versions of Windows. -> Open the folder for the version of Windows you are installing and then select the AMD64 subfolder inside (even if you are on an Intel system, select AMD64). -> Three drivers will be found. Select them all, click next, and the vDisks you have assigned will appear. -:end +:vms_virtio_driver_help:
_(Default network bridge)_: @@ -186,14 +167,7 @@ _(Default network bridge)_: -:help112 -> Select the name of the network bridge you wish to use as default for your VMs, -> the setting 'virbr0' will let libvirt create a virtual bridge that utilizes NAT (network address translation) -> and act as a DHCP server to hand out IP addresses to virtual machines directly. -> More optional selections are present when virtual bridges are created under network settings. -> -> NOTE: You can also specify a network bridge on a per-VM basis. -:end +:vms_network_bridge_help: _(Upon host shutdown)_: : -:help113 -> When shutting down the server, this defines the action to take upon running VMs. If *Hibernate VMs* is chosen, -> the VM will be instructed to hibernate (if supported) otherwise it will attempt a VM shutdown. -:end +:vms_host_shutdown_help: _(VM shutdown time-out)_: : @@ -212,10 +183,7 @@ _(VM shutdown time-out)_: _(exceeds Disk Shutdown)_ s _(time-out)_ (_(edit)_) -:help114 -> When shutting down the server, this defines how long to wait in seconds for *graceful* VM shutdown before forcing shutdown to continue. -> NOTE: It's recommended to shut down guest VMs from within the VM. -:end +:vms_shutdown_timeout_help: _(PCIe ACS override)_: : *_(Setting disabled in **safe mode**)_* -:help115 -> *PCIe ACS override* allows various hardware components to expose themselves as isolated devices. -> Typically it is sufficient to isolate *Downstream* ports. -> A hardware component may need the setting *Multi-function* or *Both* to further isolate different hardware functions.
-> A reboot is required for changes to this setting to take affect. -> -> **Warning: use of this setting could cause possible data corruption with certain hardware configurations.** -> Please visit the [Lime Technology forums](https://forums.unraid.net/forum/51-vm-engine-kvm) for more information. -:end +:vms_acs_override_help: _(VFIO allow unsafe interrupts)_: : *_(Setting disabled in **safe mode**)_* -:help116 -> If your system doesn't support interrupt remapping, these can be enabled by allowing unsafe interrupts.
-> A reboot will be required for changes to this setting to take affect. -> -> **Warning: use of this setting could cause possible data corruption with certain hardware configurations.** -> Please visit the [Lime Technology forums](https://forums.unraid.net/forum/51-vm-engine-kvm) for more information. -:end +:vms_vfio_interupts_help:
@@ -260,9 +214,7 @@ _(VFIO allow unsafe interrupts)_: -:help117 -> View the log for libvirt: /var/log/libvirt/libvirtd.log -:end +:vms_libvirt_log_help: @@ -285,10 +237,7 @@ _(btrfs scrub status)_:   : -:help118 -> **Scrub** runs the *btrfs scrub* program to check file system integrity. -> If repair is needed you should check the *Correct file system errors* and run a second Scrub pass; this will permit *btrfs scrub* to fix the file system. -:end +:vms_scrub_help: @@ -297,9 +246,7 @@ _(btrfs scrub status)_:   : -:help119 -> **Cancel* will cancel the Scrub operation in progress. -:end +:vms_cancel_help: diff --git a/plugins/dynamix/ArrayDevices.page b/plugins/dynamix/ArrayDevices.page index b4cd15c8c..d10487565 100644 --- a/plugins/dynamix/ArrayDevices.page +++ b/plugins/dynamix/ArrayDevices.page @@ -78,72 +78,9 @@ if ($display['total']) echo "  -:help1 -> **Colored Status Indicator** the significance of the color indicator at the beginning of each line in *Array Devices* is as follows: -> -> Normal operation, device is active. -> -> Device is in standby mode (spun-down). -> -> Device contents emulated. -> -> Device is disabled, contents emulated. -> -> New device. -> -> No device present, position is empty. -> -> **Identification** is the *signature* that uniquely identifies a storage device. The signature -> includes the device model number, serial number, linux device id, and the device size. -> -> **Temp.** (temperature) is read directly from the device. You configure which units to use on -> the [Display Preferences](Settings/DisplaySettings) page. We do not read the temperature of spun-down hard -> drives since this typically causes them to spin up; instead we display the `*` symbol. We also -> display the `*` symbol for SSD and Flash devices, though sometimes these devices do report a valid -> temperature, and sometimes they return the value `0`. -> -> **Size, Used, Free** reports the total device size, used space, and remaining space for files. These -> units are also configured on the [Display Preferences](Settings/DisplaySettings) page. The -> amount of space used will be non-zero even for an empty disk due to file system overhead. -> -> *Note: for a multi-device cache pool, this data is for the entire pool as returned by btrfs.* -> -> **Reads, Writes** are a count of I/O requests sent to the device I/O drivers. These statistics may -> be cleared at any time, refer to the Array Status section below. -> -> **Errors** counts the number of *unrecoverable* errors reported by the device -> I/O drivers. Missing data due to unrecoverable array read errors is filled in on-the-fly using parity -> reconstruct (and we attempt to write this data back to the sector(s) which failed). Any unrecoverable -> write error results in *disabling* the disk. -> -> **FS** indicates the file system detected in partition 1 of the device. -> -> **View** column contains a folder icon indicating the device is *mounted*. Click the icon to -> browse the file system. -> -> If "Display array totals" is enable on the [Display Preferences](Settings/DisplaySettings) page, a -> **Total** line is included which provides a tally of the device statistics, including the average temperature -> of your devices. -> -> The Array must be Stopped in order to change Array device assignments. -> -> An Unraid array consists of one or two Parity disks and a number of Data disks. The Data -> disks are exclusively used to store user data, and the Parity disk(s) provides the redundancy necessary -> to recover from disk failures. -> -> Since data is not striped across the array, the Parity disk(s) must be as large, or larger than the largest Data -> disk. Parity should also be your highest performance drive. -> -> Each Data disk has its own file system and can be exported as a -> separate share. -> -> Click on the Device name to configure individual device settings and launch certain utilities. -:end +:main_array_devices_help:
-:help2 -> **Slots** select the number of device slots in your server designated for Array devices. -> The minimum number of Array slots is 2, and you must have at least one device assigned to the array. -:end +:main_slots_help: diff --git a/plugins/dynamix/ArrayOperation.page b/plugins/dynamix/ArrayOperation.page index 0112a5ff5..713aa874c 100644 --- a/plugins/dynamix/ArrayOperation.page +++ b/plugins/dynamix/ArrayOperation.page @@ -570,103 +570,12 @@ enable_stop(); -:help6 -> **Colored Status Indicator** the significance of the color indicator of the *Array* is as follows: -> -> Array is Started and Parity is valid. -> -> Array is Stopped, Parity is valid. -> -> Array is Started, but Parity is invalid. -> -> Array is Stopped, Parity is invalid. -> -:end +:array_status_help: -:help7 -> #### Assigning Devices -> -> An Unraid disk array consists of a single parity disk and a number of data disks. The data -> disks are exclusively used to store user data, and the parity disk provides the redundancy necessary -> to recover from any singe disk failure. -> -> Note that we are careful to use the term *disk* when referring to an array storage device. We -> use the term *hard drive* (or sometimes just *drive*) when referring to an actual hard disk drive (HDD) -> device. This is because in a RAID system it is possible to read/write an array disk whose corresponding -> hard drive is disabled or even missing! In addition, it is useful to be able to ask, "which device is -> assigned to be the parity disk?"; or, "which device corresponds to disk2?". -> -> We therefore need a way to assign hard drives to array disks. This is accomplished here on the -> Main page when the array is stopped. There is a drop-down box for each array disk which lists all the -> unassigned devices. To assign a device simply select it from the list. Each time a device -> assignment is made, the system updates a configuration file to record the assignment. -> -> #### Requirements -> -> Unlike traditional RAID systems which stripe data across all the array devices, an Unraid server -> stores files on individual hard drives. Consequently, all file write operations will involve both the -> data disk the file is being written to, and the parity disk. For these reasons, -> -> * the parity disk size must be as large or larger than any of the data disks, -> -> and -> -> * given a choice, the parity disk should be the fastest disk in your collection. -> -> #### Guidelines -> -> Here are the steps you should follow when designing your Unraid disk array: -> -> 1. Decide which hard drive you will use for parity, and which hard drives you will use for -> data disk1, disk2, etc., and label them in some fashion. Also, find the serial number of each hard -> drive and jot it down somewhere; you will need this information later. -> -> 2. Install your hard drive devices, boot Unraid OS and bring up the webGui. If this is a fresh system -> build, then the Main page will show no disks installed. This doesn't mean the system can't detect your -> hard drives; it just means that none have been assigned yet. -> -> 3. Remember the serial numbers you recored back in step 1? For parity and each data disk, select the -> proper hard drive based on its serial number from the drop down list. -> -> #### Hot Plug -> -> You may also *hot plug* hard drives into your server if your hardware supports it. For example, -> if you are using hard drive cages, you may simply plug them into your server while powered on and -> with array Stopped. Refresh the Main page to have new unassigned devices appear in the assignment -> dropdown lists. -> -> #### Next Steps -> -> Once you have assigned all of your hard drives, refer to the Array Status section below -> and Start the array. -:end +:array_devices_help:
-:help8 -> #### Encryption input -> -> With array Stopped, the user can specify a new encryption key. Note that once a device -> is formatted with a particular key it may only be opened using that same key. Changing the encryption key requires -> encrypted devices to be reformatted **resulting in permanent loss of all existing data on those devices.** -> -> #### Passphrase -> -> Enter a passphrase of up to 512 characters. It is highly advisable to only use the 95 printable characters from the -> first 128 characters of the [ASCII table](https://en.wikipedia.org/wiki/ASCII), as they will always have the same binary -> representation. Other characters may have different encoding depending on system configuration and your passphrase will -> not work with a different encoding. If you want a longer passphrase or to include binary data, upload a keyfile instead. -> -> Please refer to the [cryptsetup FAQ](https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions#5-security-aspects) -> for what constitutes a *secure* passphrase. -> -> **Memorize** this passphrase. **IF LOST, ENCRYPTED CONTENT CANNOT BE RECOVERED!** -> -> #### Keyfile -> -> Select a local keyfile with a stored encryption key or a binary file. The maximum size of the keyfile is 8M (8388608 byte). -> -> **Backup** your local keyfile. **IF LOST, ENCRYPTED CONTENT CANNOT BE RECOVERED!** -:end +:encryption_help: diff --git a/plugins/dynamix/BootDevice.page b/plugins/dynamix/BootDevice.page index b1d6da4e0..0af108955 100644 --- a/plugins/dynamix/BootDevice.page +++ b/plugins/dynamix/BootDevice.page @@ -37,9 +37,4 @@ boot_status(); -:help5 -> Vital array configuration is maintained on the USB Flash device; for this reason, it must remain -> plugged in to your server. Click on [Flash](/Main/Flash?name=flash) to see the GUID and registration -> information, and to configure export settings. Since the USB Flash device is formatted using FAT file system, -> it may only be exported using SMB protocol. -:end +:boot_device_help: diff --git a/plugins/dynamix/CPUisol.page b/plugins/dynamix/CPUisol.page index 9d3bb9822..5268b81de 100644 --- a/plugins/dynamix/CPUisol.page +++ b/plugins/dynamix/CPUisol.page @@ -27,9 +27,4 @@ Tag="icon-cpu"
_(CPU isolation is prohibited while system is running in SAFE MODE)_!
-:help3 -> CPU isolation allows the user to specify CPU cores that are to be explicitly reserved for assignment (to VMs or Docker containers). -> -> This is incredibly important for gaming VMs to run smoothly because even if you manually pin your Docker containers to not overlap with your gaming VM, -> the host OS can still utilize those same cores as the guest VM needs for things like returning responses for the webGui, running a parity check, btrfs operations, etc. -:end +:cpu_isolation_help: diff --git a/plugins/dynamix/CPUpin.page b/plugins/dynamix/CPUpin.page index 68bb30e2f..584544167 100644 --- a/plugins/dynamix/CPUpin.page +++ b/plugins/dynamix/CPUpin.page @@ -27,21 +27,4 @@ Tag="icon-cpu"
_(No CPU pinning available. Docker service must be started)_
-:help2 -> This page gives a total view of the current CPU pinning assignments for Docker containers.
-> It also allows to modify these assignments. -> -> Running containers are **stopped first** and restarted after the modification.
-> Stopped containers are instantly modified and new assignments become active when the user manually starts the container. -> -> When ***Apply*** is pressed a scan is performed to find the changes, subsequently containers which have changes are modified in parallel. -> -> *Important: Please wait until all updates are finished before leaving this page*. -> -> By default NO cores are selected for a Docker container, which means it uses all available cores.
-> Do not select **ALL** cores for containers, just select **NO** cores if you want unrestricted core use. -> -> Do not select cores for containers which are *isolated*. -> By design a container will only use a single core (the lowest numbered core) when multiple isolated cores are selected.
-> Usually this is not what a user wants when selecting multiple cores. -:end +:cpu_pinning_help: diff --git a/plugins/dynamix/CPUvms.page b/plugins/dynamix/CPUvms.page index 8871dd042..6acc65fa4 100644 --- a/plugins/dynamix/CPUvms.page +++ b/plugins/dynamix/CPUvms.page @@ -206,14 +206,4 @@ $(function(){
_(No CPU pinning available. VM service must be started)_
-:help1 -> This page gives a total view of the current CPU pinning assignments for VMs.
-> It also allows to modify these assignments. -> -> Running VMs are **stopped first** and restarted after the modification.
-> Stopped VMs are instantly modified and new assignments become active when the VM is started. -> -> When ***Apply*** is pressed a scan is performed to find the changes, subsequently only VMs which have changes are modified in parallel. -> -> *Important: Please wait until all updates are finished before leaving this page*. -:end +:cpu_vms_help: diff --git a/plugins/dynamix/CacheDevices.page b/plugins/dynamix/CacheDevices.page index a0e36dc18..0326ecdac 100644 --- a/plugins/dynamix/CacheDevices.page +++ b/plugins/dynamix/CacheDevices.page @@ -131,42 +131,9 @@ _(Slots)_: -:help3 -> **Colored Status Indicator** the significance of the color indicator at the beginning of each line in *Pool Devices* is as follows: -> -> Normal operation, device is active. -> -> Device is in standby mode (spun-down). -> -> New device. -> -> No device present, position is empty. -> -> **Pool Devices** is a single device, or pool of multiple devices, *outside* the Unraid array. It may be exported for network access just -> like an Array device. Being outside the Unraid array results in significantly faster write access. -> -> There are two ways to configure the Pool devices: -> -> 1. As a single device, or -> 2. As a multi-device pool. -> -> When configured as a single device you may format the device using any supported file system (btrfs, reiserfs, -> or xfs). This configuration offers the highest performance, but at the cost of no data protection - if the -> single pool device fails all data contained on it may be lost. -> -> When configured as a multi-device pool, Unraid OS will automatically select *btrfs-raid1* format (for both data -> and meta-data). btrfs permits any number of devices to be added to the pool and each copy of data is guaranteed -> to be written to two different devices. Hence the pool can withstand a single-disk failure without losing data. -> -> When [User Shares](/Settings/ShareSettings) are enabled, user shares may be configured to -> automatically make use of the Pool device in order to -> speed up writes. A special background process called the *mover* can be scheduled to run -> periodically to move user share files off the Cache and onto the Array. -:end +:cache_devices_help:
-:help4 -> **Slots** select the number of device slots in your server designated for Cache devices. -:end +:cache_slots_help: diff --git a/plugins/dynamix/Confirmations.page b/plugins/dynamix/Confirmations.page index f54edf784..551031ad9 100644 --- a/plugins/dynamix/Confirmations.page +++ b/plugins/dynamix/Confirmations.page @@ -25,9 +25,7 @@ _(Confirm reboot & powerdown commands)_: -:help98 -> Choose if rebooting or powering down the server needs a confirmation checkbox. -:end +:confirm_reboot_help: _(Confirm array stop command)_: : -:help99 -> Choose if stopping the array needs a confirmation checkbox. -:end +:confirm_array_stop_help: _(Confirm sleep command)_: diff --git a/plugins/dynamix/DateTime.page b/plugins/dynamix/DateTime.page index e93ca38bc..35f04f45c 100644 --- a/plugins/dynamix/DateTime.page +++ b/plugins/dynamix/DateTime.page @@ -29,9 +29,7 @@ _(Time zone)_: } ?> -:help4 -> Select your applicable time zone from the drop-down list. -:end +:timezone_help: _(Use NTP)_: : -:help5 -> Select 'Yes' to use Network Time Protocol to keep your server time accurate. -> We **highly** recommend the use of a network time server, especially if you plan on using Active Directory. -> -> Note: if using `pool.ntp.org` time servers, please also refer to [their documentation](http://www.pool.ntp.org/en/use.html). -:end +:use_ntp_help: _(NTP server)_ 1: : -:help6 -> This is the primary NTP server to use. Enter a FQDN or an IP address. -:end +:ntp_server1_help: _(NTP server)_ 2: : -:help7 -> This is the alternate NTP server to use if NTP Server 1 is down. -:end +:ntp_server2_help: _(NTP server)_ 3: : -:help8 -> This is the alternate NTP Server to use if NTP Servers 1 and 2 are both down. -:end +:ntp_server3_help: _(NTP server)_ 4: : -:help9 -> This is the alternate NTP Server to use if NTP Servers 1, 2, and 3 are all down. -:end +:ntp_server4_help: _(New date and time)_: : "> -:help10 +:current_time_help: > Enter the current time-of-day. Use format YYYY-MM-DD HH:MM:SS. Greyed out when using NTP. :end diff --git a/plugins/dynamix/DeviceAttributes.page b/plugins/dynamix/DeviceAttributes.page index 836425e18..54403b160 100644 --- a/plugins/dynamix/DeviceAttributes.page +++ b/plugins/dynamix/DeviceAttributes.page @@ -28,10 +28,5 @@ $(function() { -:help34 -> This list shows the SMART attributes supported by this disk. For more information about each SMART attribute, it is recommended to search online. -> -> Attributes in *orange* may require your attention. They have a **raw value** greater than zero and may indicate a pending disk failure. -> -> Special attention is required when the particular attribute raw value starts to increase over time. When in doubt, consult the Limetech forum for advice. -:end +:smart_attributes_help: + diff --git a/plugins/dynamix/DeviceCapabilities.page b/plugins/dynamix/DeviceCapabilities.page index 37f2e0cf7..d9730226b 100644 --- a/plugins/dynamix/DeviceCapabilities.page +++ b/plugins/dynamix/DeviceCapabilities.page @@ -28,8 +28,4 @@ $(function() { -:help35 -> This list shows the SMART capabilities supported by this disk. -> -> Observe here the estimated duration of the SMART short and extended self-tests. -:end +:smart_capabilities_help: diff --git a/plugins/dynamix/DeviceIdentify.page b/plugins/dynamix/DeviceIdentify.page index 1a5f74767..b1b0b5f75 100644 --- a/plugins/dynamix/DeviceIdentify.page +++ b/plugins/dynamix/DeviceIdentify.page @@ -36,6 +36,4 @@ $(function() { -:help36 -> This list shows the SMART identity information of this disk -:end +:smart_identity_help: diff --git a/plugins/dynamix/DeviceInfo.page b/plugins/dynamix/DeviceInfo.page index 3bb9470ee..cf8320a8d 100644 --- a/plugins/dynamix/DeviceInfo.page +++ b/plugins/dynamix/DeviceInfo.page @@ -340,10 +340,7 @@ _(Name)_: _(Comments)_: : -:help12 -> This text will appear under the *Comments* column for the share in Windows Explorer. -> Enter anything you like, up to 256 characters. -:end +:info_comments_help: _(Partition size)_: : KB (K=1024) @@ -377,20 +374,12 @@ _(Spin down delay)_: _(Warning disk temperature threshold)_ (°): : -:help9 -> *Warning disk temperature* sets the warning threshold for this hard disk temperature. Exceeding this threshold will result in a warning notification. -> -> A value of zero will disable the warning threshold (including notifications). -:end +:info_warning_temp_help: _(Critical disk temperature threshold)_ (°): : -:help10 -> *Critical disk temperature* sets the critical threshold for this hard disk temperature. Exceeding this threshold will result in an alert notification. -> -> A value of zero will disable the critical threshold (including notifications). -:end +:info_critical_temp_help: _(File system status)_: @@ -410,10 +399,7 @@ _(File system type)_: -:help11 -> Enter the desired file system type. Changing the file system type of a device will permit you to reformat -> that device using the new file system. Be aware that **all existing data on the device will be lost**. -:end +:info_file_system_help: 1):?> _(File system type)_: @@ -434,44 +420,18 @@ _(File system type)_: _(Minimum free space)_: : placeholder="0"> -:help41 -> This defines a "floor" for the amount of free space remaining in the volume. -> If the free space becomes less than this value, then new files written via user shares will fail with "not enough space" error. -> -> Enter a numeric value with one of these suffixes: -> -> **KB** = 1,000
-> **MB** = 1,000,000
-> **GB** = 1,000,000,000
-> **TB** = 1,000,000,000,000
-> **K** = 1,024 (ie, 2^10)
-> **M** = 1,048,576 (ie, 2^20)
-> **G** = 1,073,741,824 (ie, 2^30)
-> **T** = 1,099,511,627,776 (ie, 2^40)
-> -> If no suffix, a count of 1024-byte blocks is assumed. -:end +:info_free_space_help: _(Warning disk utilization threshold)_ (%): : -:help13 -> *Warning disk utilization* sets the warning threshold for this hard disk utilization. Exceeding this threshold will result in a warning notification. -> -> When the warning threshold is set equal or greater than the critical threshold, there will be only critical notifications (warnings are not existing). -> -> A value of zero will disable the warning threshold (including notifications). -:end +:info_warning_utilization_help: _(Critical disk utilization threshold)_ (%): : -:help14 -> *Critical disk utilization* sets the critical threshold for this hard disk utilization. Exceeding this threshold will result in an alert notification. -> -> A value of zero will disable the critical threshold (including notifications). -:end +:info_critical_utilization_help:   @@ -516,24 +476,7 @@ _(btrfs balance status)_: *_(Perform full balance)_* -:help15 -> **Balance** will run the *btrfs balance* program to restripe the extents across all pool devices, for example, -> to convert the pool from raid1 to raid0 or vice-versa. -> -> When a *full balance* is perfomred, it basically rewrites everything in the current filesystem. -> -> A *mode conversion* affects the btrfs data extents; metadata always uses raid1 and is converted to raid1 if necessary by any balance operation. -> -> The run time is potentially very long, depending on the filesystem size and speed of the device. -> -> Unraid uses these default options when creating a multiple-device pool: -> -> `-dconvert=raid1 -mconvert=raid1` -> -> For more complete documentation, please refer to the btrfs-balance [Manpage](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-balance) -> -> *Note: raid5 and raid6 are generally still considered **experimental** by the Linux community* -:end +:info_btrfs_balance_help: @@ -543,9 +486,7 @@ _(btrfs balance status)_:   : -:help16 -> **Cancel** will cancel the balance operation in progress. -:end +:info_balance_cancel_help: @@ -574,12 +515,7 @@ _(btrfs scrub status)_:   : -:help17 -> **Scrub** runs the *btrfs scrub* program which will read all data and metadata blocks from all -> devices and verify checksums. -> -> If *Repair corrupted blocks* is checked, *btrfs scrub* will repair corrupted blocks if there’s a correct copy available. -:end +:info_btrfs_scrub_help: @@ -589,9 +525,7 @@ _(btrfs scrub status)_:   : -:help18 -> **Cancel** will cancel the Scrub operation in progress. -:end +:info_scrub_cancel_help: @@ -620,17 +554,7 @@ _(btrfs check status)_:   : _(Options (see Help))_ -:help19 -> **Check** will run the *btrfs check* program to check file system integrity on the device. -> -> The *Options* field is initialized with *--readonly* which specifies check-only. If repair is needed, you should run -> a second Check pass, setting the *Options* to *--repair*; this will permit *btrfs check* to fix the file system. -> -> After starting a Check, you should Refresh to monitor progress and status. Depending on -> how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours). -> Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters -> increasing for the device on the Main page. -:end +:info_btrfs_check_help: @@ -641,9 +565,7 @@ _(btrfs check status)_:   : *_(Running)_* -:help20 -> **Cancel** will cancel the Check operation in progress. -:end +:info_check_cancel_help: @@ -678,18 +600,7 @@ _(reiserfsck status)_:   : _(Options (see Help))_ -:help21 -> **Check** will run the *reiserfsck* program to check file system integrity on the device. -> -> The *Options* field may be filled in with specific options used to fix problems in the file system. Typically, you -> first run a Check pass leaving *Options* blank. Upon completion, if *reiserfsck* finds any problems, you must -> run a second Check pass, using a specific option as instructed by the first *reiserfsck* pass. -> -> After starting a Check you should Refresh to monitor progress and status. Depending on -> how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours). -> Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters -> increasing for the device on the Main page. -:end +:info_reiserfs_check_help: @@ -700,9 +611,7 @@ _(reiserfsck status)_:   : *_(Running)_* -:help22 -> **Cancel** will cancel the Check operation in progress. -:end +:info_reiserfs_cancel_help: @@ -731,17 +640,7 @@ _(xfs_repair status)_:   : _(Options (see Help))_ -:help23 -> **Check** will run the *xfs_repair* program to check file system integrity on the device. -> -> The *Options* field is initialized with *-n* which specifies check-only. If repair is needed, you should run -> a second Check pass, setting the *Options* blank; this will permit *xfs_repair* to fix the file system. -> -> After starting a Check, you should Refresh to monitor progress and status. Depending on -> how large the file system is, and what errors might be present, the operation can take **a long time** to finish (hours). -> Not much info is printed in the window, but you can verify the operation is running by observing the read/write counters -> increasing for the device on the Main page. -:end +:info_xfs_check_help: @@ -751,9 +650,7 @@ _(xfs_repair status)_:   : *_(Running)_* -:help24 -> **Cancel** will cancel the Check operation in progress. -:end +:info_xfs_cancel_help: @@ -781,11 +678,7 @@ _(SMART notification value)_: -:help25 -> SMART notifications are generated on either an increasing RAW value of the attribute, or a decreasing NORMALIZED value which reaches a predefined threshold set by the manufacturer. -> -> Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings). -:end +:info_smart_notifications_help: _(SMART notification tolerance level)_: : -:help26 -> A tolerance level may be given to prevent that small changes result in a notification. Setting a too high tolerance level may result in critical changes without a notification. -> -> Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings). -:end +:info_tolerance_level_help: _(SMART controller type)_: : /dev/ enter disk index and device name as applicable to your controller -:help27 -> By default automatic controller selection is done by smartctl to read the SMART information. Certain controllers however need specific settings for smartctl to work. -> Use this setting to select your controller type and fill-in the specific disk index and device name for your situation. Use the manufacturer's documentation to find the relevant information. -> -> Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings). -:end +:info_controller_type_help: _(SMART attribute notifications)_: : _(Custom attributes (use comma to separate numbers))_ @@ -841,14 +725,7 @@ _(SMART attribute notifications)_: : >_(Attribute)_ = -:help28 -> The user can enable or disable notifications for the given SMART attributes. It is recommended to keep the default, which is ALL selected attributes, -> when certain attributes are not present on your hard disk or do not provide the correct information, these may be excluded. -> In addition custom SMART attributes can be entered to generate notifications. Be careful in this selection, -> it may cause an avalance of notifcations if inappropriate SMART attributes are chosen. -> -> Each disk may have its own specific setting overruling the 'default' setting (see global SMART settings under Disk Settings). -:end +:info_attribute_notifications_help: : @@ -871,4 +748,3 @@ _(Name)_: - diff --git a/plugins/dynamix/DiskList.page b/plugins/dynamix/DiskList.page index 899a04daa..ba0a06b0f 100644 --- a/plugins/dynamix/DiskList.page +++ b/plugins/dynamix/DiskList.page @@ -39,22 +39,4 @@ $(function() {

-:help2 -> **Colored Status Indicator** -- the significance of the color indicator at the beginning of each line in *Disk Shares* is as follows: -> -> Mounted, underlying device has redundancy/protection. -> -> Mounted, underlying device does not have redundancy/protection. -> -> **Security modes:** - -> + '-' -- disk share is not exported and unavailable on the network -> + *Public* -- all users including guests have full read/write access (open access) -> + *Secure* -- all users including guests have read access, write access is set per user (limited access) -> + *Private* -- no guest access at all, read/write or read-only access is set per user (closed access) -> -> **Special modes:** - -> + SMB security mode displayed in *italics* indicates exported hidden disk shares. -> + NFS does not have special modes for disk shares. -:end +:disk_list_help: diff --git a/plugins/dynamix/DiskSettings.page b/plugins/dynamix/DiskSettings.page index 33cec7d5e..ad3cdfba9 100644 --- a/plugins/dynamix/DiskSettings.page +++ b/plugins/dynamix/DiskSettings.page @@ -64,11 +64,7 @@ _(Enable auto start)_: -:help11 -> If set to 'Yes' then if the device configuration is correct upon server start-up, -> the array will be automatically Started and shares exported.
-> If set to 'No' then you must Start the array yourself. -:end +:disk_enable_autostart_help: _(Default spin down delay)_: : -:help12 -> This setting defines the 'default' time-out for spinning hard drives down after a period -> of no I/O activity. You may override the default value for an individual disk on the Disk Settings -> page for that disk. -:end +:disk_spindown_delay_help: _(Enable spinup groups)_: : -:help13 -> If set to 'Yes' then the [Spinup Groups](/Help) feature is enabled. -:end +:disk_spinup_groups_help: _(Default partition format)_: : -:help14 -> Defines the type of partition layout to create when formatting hard drives 2TB in size and -> smaller **only**. (All devices larger then 2TB are always set up with GPT partition tables.) -> -> **MBR: unaligned** setting will create MBR-style partition table, where the single -> partition 1 will start in the **63rd sector** from the start of the disk. This is the *traditional* -> setting for virtually all MBR-style partition tables. -> -> **MBR: 4K-aligned** setting will create an MBR-style partition table, where the single -> partition 1 will start in the **64th sector** from the start of the disk. Since the sector size is 512 bytes, -> this will *align* the start of partition 1 on a 4K-byte boundry. This is required for proper -> support of so-called *Advanced Format* drives. -> -> Unless you have a specific requirement do not change this setting from the default **MBR: 4K-aligned**. -:end +:disk_default_partition_format_help: _(Default file system)_: : -:help15 -> Defines the default file system type to create when an *unmountable* array device is formatted. -> -> The default file system type for a single or multi-device cache is always Btrfs. -:end +:disk_default_file_system_help: _(Shutdown time-out)_: : -:help16 -> When shutting down the server, this defines how long to wait in seconds for *graceful* shutdown before forcing -> shutdown to continue. -:end +:disk_shutdown_timeout_help: _(Tunable (poll_attributes))_: : -:help17 -> This defines the disk SMART polling interval, in seconds. A value of 0 disables SMART polling (not recommended). -:end +:disk_tunable_poll_attributes_help: _(Tunable (enable NCQ))_: : -:help18 -> If set to **No** then *Native Command Queuing* is disabled for all array devices that support NCQ. -> -> **Auto** leaves the setting for each device as-is. -> -> Note: You must reboot after selecting Auto for setting to take effect. -:end +:disk_tunable_enable_ncq_help: _(Tunable (nr_requests))_: : -:help19 -> This defines the `nr_requests` device driver setting for all array devices. -> -> **Auto** leaves the setting for each device as-is. -> -> Note: if you set to blank and click Apply, the setting is restored to its default, and you must reboot for setting to take effect. -:end +:disk_tunable_nr_requests_help: _(Tunable (scheduler))_: : -:help20 -> Selects which kernel I/O scheduler to use for all array devices. -> -> **Auto** leaves the setting for each device as-is (mq-deadline). -> -> Note: You must reboot after selecting Auto for setting to take effect. -:end +:disk_tunable_scheduler_help: _(Tunable (md_num_stripes))_: : -:help21 -> This is the size of the *stripe pool* in number of *stripes*. A *stripe* refers to a data structure that faclitiates parallel 4K read/write -> operations necessary for a parity-protected array. -> -> Note: if you set to blank and click Apply, the setting is restored to its default, and will take effect after reboot. -:end +:disk_tunable_md_num_stripes_help: _(Tunable (md_queue_limit))_: : -:help22 -> This is a number in [1..100] which is the maximum steady-load percentage of the stripe pool permitted to be in use. -> -> Note: if you set to blank and click Apply, the setting is restored to its default. -:end +:disk_tunable_md_queue_limit_help: _(Tunable (md_sync_limit))_: : -:help23 -> This is a number in [0..100] which is the maximum percentage of the stripe pool allocated for parity sync/check in the presence of other I/O. -> -> Note: if you set to blank and click Apply, the setting is restored to its default. -:end +:disk_tunable_md_sync_limit_help: _(Tunable (md_write_method))_: : -:help24 -> Selects the method to employ when writing to enabled disk in parity protected array. -> -> *Auto* selects `read/modify/write`. -:end +:disk_tunable_md_write_method_help: _(Default warning disk utilization threshold)_ (%): : -:help25 -> *Warning disk utilization* sets the default warning threshold for all hard disks utilization. Exceeding this threshold will result in a warning notification. -> -> When the warning threshold is set equal or greater than the critical threshold, there will be only critical notifications (warnings are not existing). -> -> A value of zero will disable the warning threshold (including notifications). -:end +:disk_default_warning_utilization_help: _(Default critical disk utilization threshold)_ (%): : -:help26 -> *Critical disk utilization* sets the default critical threshold for all hard disks utilization. Exceeding this threshold will result in an alert notification. -> -> A value of zero will disable the critical threshold (including notifications). -:end +:disk_default_critical_utilization_help: _(Default warning disk temperature threshold)_ (°): : -:help27 -> *Warning disk temperature* sets the default warning threshold for all hard disks temperature. Exceeding this threshold will result in a warning notification. -> -> A value of zero will disable the warning threshold (including notifications). -:end +:disk_default_warning_temperature_help: _(Default critical disk temperature threshold)_ (°): : -:help28 -> *Critical disk temperature* sets the default critical threshold for all hard disks temperature. Exceeding this threshold will result in an alert notification. -> -> A value of zero will disable the critical threshold (including notifications). -:end +:disk_default_critical_temperature_help:   : @@ -296,11 +210,7 @@ _(Default SMART notification value)_: -:help29 -> SMART notifications are generated on either an increasing RAW value of the attribute, or a decreasing NORMALIZED value which reaches a predefined threshold set by the manufacturer. -> -> This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks. -:end +:disk_default_smart_notification_help: _(Default SMART notification tolerance level)_: : -:help30 -> A tolerance level may be given to prevent that small changes result in a notification. Setting a too high tolerance level may result in critical changes without a notification. -> -> This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks. -:end +:disk_default_smart_tolerance_help: _(Default SMART controller type)_: : -:help31 -> By default automatic controller selection is done by smartctl to read the SMART information. Certain controllers however need specific settings for smartctl to work. -> Use this setting to select your controller type and fill-in the specific disk index and device name for your situation. Use the manufacturer's documentation to find the relevant information. -> -> This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks. -:end +:disk_default_smart_controller_help: _(Default SMART attribute notifications)_: : _(Custom attributes (use comma to separate numbers))_ @@ -350,14 +251,7 @@ _(Default SMART attribute notifications)_: : >_(Attribute)_ = -:help32 -> The user can enable or disable notifications for the given SMART attributes. It is recommended to keep the default, which is ALL selected attributes, -> when certain attributes are not present on your hard disk or do not provide the correct information, these may be excluded. -> In addition custom SMART attributes can be entered to generate notifications. Be careful in this selection, -> it may cause an avalance of notifcations if inappropriate SMART attributes are chosen. -> -> This section is used to set the global settings for all disks. It is possible to adjust settings for individual disks. -:end +:disk_default_smart_attribute_help: : diff --git a/plugins/dynamix/DisplaySettings.page b/plugins/dynamix/DisplaySettings.page index 1ffe96bb1..f0dbed1dd 100644 --- a/plugins/dynamix/DisplaySettings.page +++ b/plugins/dynamix/DisplaySettings.page @@ -120,11 +120,7 @@ $(function() { }); -:help100 -> The display settings below determine how items are displayed on screen. Use these settings to tweak the visual effects to your likings. -> -> You can experiment with these settings as desired, they only affect visual properties. -:end +:display_settings_help:
@@ -150,9 +146,7 @@ _(Font size)_: -:help101 -> This is a per device setting -:end +:display_font_size_help: _(Date format)_: : -:help102 -> World Wide Name (WWN) is a unique identifier used for SAS attached devices. -> -> Select *Disabled* to suppress the appending of WWN to the device identification -> -> Select "Automatic" to append WWN to the device identification in case of SAS devices -:end +:display_wwn_device_id_help: _(Display array totals)_: : -:help103 -> Overrule the default text color in the header. This can be used to match the text color with a background image. -:end +:display_custom_text_color_help: _(Header custom background color)_: : -:help104 -> Overrule the default background color in the header. This can be used to match the background color with a custom text color. -:end +:display_custom_background_color_help: _(Show banner)_: : -:help6 -> Image will be scaled to 1920x90 pixels. The maximum image file upload size is 512 kB (524,288 bytes). -:end +:display_custom_banner_help: _(Show Dashboard apps)_: : -:help7 -> Selects the temperature unit for the disk temperature thresholds. Changing the unit will adjust the existing value in the disk temperature thresholds as appropriate. -> -> Make sure any newly entered values represent the selected temperature unit. -:end +:display_temperature_unit_help: : diff --git a/plugins/dynamix/Eth0.page b/plugins/dynamix/Eth0.page index a8774bf4a..6394a0a8a 100644 --- a/plugins/dynamix/Eth0.page +++ b/plugins/dynamix/Eth0.page @@ -452,18 +452,13 @@ _(Interface description)_: : " onchange="exitCode(this.form,true)"> -:help120 -> Use this optional field to provide addditional information about the purpose of the connection. -:end +:eth_interface_description_help: _(Desired MTU)_: : -:help143 -> This is the MTU size to use on the physical Ethernet interface. -> If left blank, the MTU will automatically be determined (by default 1500 bytes). -:end +:eth_desired_mtu_help: _(Enable VLANs)_: : -:help144 -> By default no VLANs are configured.
-> Enabling VLANs extends the number of logical connections over the same physical connection. -> -> Note: your router and switch must support VLANs too when this feature is used. -:end +:eth_enable_vlans_help:
@@ -779,18 +671,14 @@ _(Interface description)_: : " onchange="exitCode(this.form,true)"> -:help145 -> Use this optional field to provide addditional information about the purpose of the connection. -:end +:eth_interface_description_help diff --git a/plugins/dynamix/EthX.page b/plugins/dynamix/EthX.page index e8d5395b0..4544fe1e4 100644 --- a/plugins/dynamix/EthX.page +++ b/plugins/dynamix/EthX.page @@ -103,18 +103,13 @@ _(Interface description)_: -:help120 -> Use this field to give addditional information about the purpose of the connection. -:end +:eth_interface_description_help: @@ -356,18 +270,14 @@ _(Interface description)_: : " onchange="exitCode(this.form,true)"> -:help145 -> Use this field to give addditional information about the purpose of the connection. -:end +:eth_interface_description_help: diff --git a/plugins/dynamix/FTP.page b/plugins/dynamix/FTP.page index 3e2392002..240f454b5 100644 --- a/plugins/dynamix/FTP.page +++ b/plugins/dynamix/FTP.page @@ -39,30 +39,16 @@ _(FTP server)_: -:help69 -> Enable or disable the FTP server daemon. By default the FTP server is enabled. -> This setting is not saved, i.e. upon system reboot it will revert to its default setting. -:end +:ftp_server_help: _(FTP user(s))_: : -:help70 -> Enter the user names (separated by spaces) permitted to access the server using FTP. -> To disallow any user access, clear this setting. -> -> **Note:** do not enter user name `root` since this may cause problems in the future. -:end +:ftp_users_help:   :
-:help71 -> ### Overview -> -> Unraid includes the popular `vsftpd` FTP server. The configuration of `vsftp` is currently very -> simple: **All** user names entered above are permitted to access the server via FTP and will have -> *full read/write/delete access* to the entire server, so use with caution. -:end \ No newline at end of file +:ftp_overview_help: diff --git a/plugins/dynamix/FlashInfo.page b/plugins/dynamix/FlashInfo.page index c6c051c35..6f9be20d3 100644 --- a/plugins/dynamix/FlashInfo.page +++ b/plugins/dynamix/FlashInfo.page @@ -65,9 +65,7 @@ _(Flash GUID)_: -:help38 -> Use *Flash backup* to create a single zip file of the current contents of the flash device and store it locally on your computer. -:end +:flash_backup_help:   : diff --git a/plugins/dynamix/Identification.page b/plugins/dynamix/Identification.page index de4b526ca..afa0222a7 100644 --- a/plugins/dynamix/Identification.page +++ b/plugins/dynamix/Identification.page @@ -26,27 +26,17 @@ $name_warn = preg_match('/'.$name_regex.'/', $var['NAME']) ? 'none' : 'block'; _(Server name)_: : required> _(Not compatible with NetBIOS)_ -:help55 -> The network identity of your server. Also known as *hostname* or *short hostname*. Windows networking -> refers to this as the *NetBIOS name* and must be 15 characters or less in length. -> Use only alphanumeric characters (that is, "A-Z", "a-z", and "0-9"), dashes ("-"), and dots ("."); -> and, the first and last characters must be alphanumeric. -:end +:id_server_name_help: _(Description)_: : > -:help56 -> This is a text field that is seen next to a server when listed within Network or Network Neighborhood -> (Windows), or Finder (macOS). -:end +:id_description_help: _(Model)_: : > -:help57 -> This is the server model number. -:end +:id_model_help:   : *_(Array must be **Stopped** to change)_* diff --git a/plugins/dynamix/ManagementAccess.page b/plugins/dynamix/ManagementAccess.page index 5e3e8591b..04d1bf32b 100644 --- a/plugins/dynamix/ManagementAccess.page +++ b/plugins/dynamix/ManagementAccess.page @@ -139,9 +139,7 @@ _(Start page)_: -:help58 -> Select the page which is opened first when entering the GUI. By default the *Main* page is selected. -:end +:mgmt_start_page_help: