add server settings hints

2025-12-19 13:36:09 +05:00 · 2023-03-28 23:07:02 +03:00
parent f817d98b2c
commit 6e57e9e4b4
6 changed files with 98 additions and 52 deletions
--- a/web/src/components/Settings/MobileAppSettings.jsx
+++ b/web/src/components/Settings/MobileAppSettings.jsx
@@ -1,4 +1,4 @@
-import { FormControlLabel, Switch } from '@material-ui/core'
+import { FormControlLabel, FormGroup, FormHelperText, Switch } from '@material-ui/core'
 import { useTranslation } from 'react-i18next'

 import { SecondarySettingsContent, SettingSectionLabel } from './style'
@@ -9,12 +9,14 @@ export default function MobileAppSettings({ isVlcUsed, setIsVlcUsed }) {
  return (
    <SecondarySettingsContent>
      <SettingSectionLabel>{t('SettingsDialog.MobileAppSettings')}</SettingSectionLabel>
-
-      <FormControlLabel
-        control={<Switch checked={isVlcUsed} onChange={() => setIsVlcUsed(prev => !prev)} color='secondary' />}
-        label={t('SettingsDialog.UseVLC')}
-        labelPlacement='start'
-      />
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={isVlcUsed} onChange={() => setIsVlcUsed(prev => !prev)} color='secondary' />}
+          label={t('SettingsDialog.UseVLC')}
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.UseVLCHint')}</FormHelperText>
+      </FormGroup>
    </SecondarySettingsContent>
  )
 }
--- a/web/src/components/Settings/SecondarySettingsComponent.jsx
+++ b/web/src/components/Settings/SecondarySettingsComponent.jsx
@@ -39,32 +39,46 @@ export default function SecondarySettingsComponent({ settings, inputForm }) {
  return (
    <SecondarySettingsContent>
      <SettingSectionLabel>{t('SettingsDialog.AdditionalSettings')}</SettingSectionLabel>
-
-      <FormControlLabel
-        control={<Switch checked={EnableIPv6} onChange={inputForm} id='EnableIPv6' color='secondary' />}
-        label='IPv6'
-        labelPlacement='start'
-      />
-      <FormControlLabel
-        control={<Switch checked={!DisableTCP} onChange={inputForm} id='DisableTCP' color='secondary' />}
-        label='TCP (Transmission Control Protocol)'
-        labelPlacement='start'
-      />
-      <FormControlLabel
-        control={<Switch checked={!DisableUTP} onChange={inputForm} id='DisableUTP' color='secondary' />}
-        label='μTP (Micro Transport Protocol)'
-        labelPlacement='start'
-      />
-      <FormControlLabel
-        control={<Switch checked={!DisablePEX} onChange={inputForm} id='DisablePEX' color='secondary' />}
-        label='PEX (Peer Exchange)'
-        labelPlacement='start'
-      />
-      <FormControlLabel
-        control={<Switch checked={ForceEncrypt} onChange={inputForm} id='ForceEncrypt' color='secondary' />}
-        label={t('SettingsDialog.ForceEncrypt')}
-        labelPlacement='start'
-      />
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={EnableIPv6} onChange={inputForm} id='EnableIPv6' color='secondary' />}
+          label='IPv6'
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.EnableIPv6Hint')}</FormHelperText>
+      </FormGroup>
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={!DisableTCP} onChange={inputForm} id='DisableTCP' color='secondary' />}
+          label='TCP (Transmission Control Protocol)'
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.DisableTCPHint')}</FormHelperText>
+      </FormGroup>
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={!DisableUTP} onChange={inputForm} id='DisableUTP' color='secondary' />}
+          label='μTP (Micro Transport Protocol)'
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.DisableUTPHint')}</FormHelperText>
+      </FormGroup>
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={!DisablePEX} onChange={inputForm} id='DisablePEX' color='secondary' />}
+          label='PEX (Peer Exchange)'
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.DisablePEXHint')}</FormHelperText>
+      </FormGroup>
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={ForceEncrypt} onChange={inputForm} id='ForceEncrypt' color='secondary' />}
+          label={t('SettingsDialog.ForceEncrypt')}
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.ForceEncryptHint')}</FormHelperText>
+      </FormGroup>
      <TextField
        onChange={inputForm}
        margin='normal'
@@ -91,11 +105,14 @@ export default function SecondarySettingsComponent({ settings, inputForm }) {
        fullWidth
      />
      <br />
-      <FormControlLabel
-        control={<Switch checked={!DisableDHT} onChange={inputForm} id='DisableDHT' color='secondary' />}
-        label={t('SettingsDialog.DHT')}
-        labelPlacement='start'
-      />
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={!DisableDHT} onChange={inputForm} id='DisableDHT' color='secondary' />}
+          label={t('SettingsDialog.DHT')}
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.DisableDHTHint')}</FormHelperText>
+      </FormGroup>
      <TextField
        onChange={inputForm}
        margin='normal'
@@ -143,11 +160,14 @@ export default function SecondarySettingsComponent({ settings, inputForm }) {
        variant='outlined'
        fullWidth
      />
-      <FormControlLabel
-        control={<Switch checked={!DisableUPNP} onChange={inputForm} id='DisableUPNP' color='secondary' />}
-        label='UPnP (Universal Plug and Play)'
-        labelPlacement='start'
-      />
+      <FormGroup>
+        <FormControlLabel
+          control={<Switch checked={!DisableUPNP} onChange={inputForm} id='DisableUPNP' color='secondary' />}
+          label='UPnP (Universal Plug and Play)'
+          labelPlacement='start'
+        />
+        <FormHelperText margin='none'>{t('SettingsDialog.DisableUPNPHint')}</FormHelperText>
+      </FormGroup>
      <FormControlLabel
        control={<Switch checked={EnableDLNA} onChange={inputForm} id='EnableDLNA' color='secondary' />}
        label={t('SettingsDialog.DLNA')}
@@ -164,11 +184,6 @@ export default function SecondarySettingsComponent({ settings, inputForm }) {
        variant='outlined'
        fullWidth
      />
-      <FormControlLabel
-        control={<Switch checked={EnableDebug} onChange={inputForm} id='EnableDebug' color='secondary' />}
-        label={t('SettingsDialog.EnableDebug')}
-        labelPlacement='start'
-      />
      <FormGroup>
        <FormControlLabel
          control={<Switch checked={EnableRutorSearch} onChange={inputForm} id='EnableRutorSearch' color='secondary' />}
@@ -177,6 +192,11 @@ export default function SecondarySettingsComponent({ settings, inputForm }) {
        />
        <FormHelperText margin='none'>{t('SettingsDialog.EnableRutorSearchHint')}</FormHelperText>
      </FormGroup>
+      <FormControlLabel
+        control={<Switch checked={EnableDebug} onChange={inputForm} id='EnableDebug' color='secondary' />}
+        label={t('SettingsDialog.EnableDebug')}
+        labelPlacement='start'
+      />
      <br />
      <InputLabel htmlFor='RetrackersMode'>{t('SettingsDialog.RetrackersMode')}</InputLabel>
      <Select
--- a/web/src/locales/en/translation.json
+++ b/web/src/locales/en/translation.json
@@ -108,12 +108,19 @@
    "ConnectionsLimit": "Connections Limit",
    "ConnectionsLimitHint": "20-25 recommended",
    "DHT": "DHT (Distributed Hash Table)",
+    "DisableDHTHint": "Disable if there is no network after starting the server",
+    "DisablePEXHint": "Better leave enabled",
+    "DisableTCPHint": "Don't disable without μTP enabled",
+    "DisableUPNPHint": "Auto-open port on router",
+    "DisableUTPHint": "Not recommended to enable on weak devices",
    "Disk": "Disk",
    "DLNA": "DLNA Media Server",
    "DontAddRetrackers": "Don`t add retrackers",
    "DownloadRateLimit": "Download Rate Limit",
    "EnableDebug": "Enable Debug Server Log",
+    "EnableIPv6Hint": "Enable only if supported by ISP",
    "ForceEncrypt": "Force Encrypt Headers",
+    "ForceEncryptHint": "Can help with torrent blocking providers",
    "FriendlyName": "DLNA Server Name",
    "FriendlyNameHint": "Leave blank to use default",
    "EnableRutorSearch": "Turn on torrents search by RuTor",
@@ -143,7 +150,8 @@
      "AdditionalDisabled": "(enable PRO mode)",
      "App": "App"
    },
-    "UseVLC": "Prompt to open video in VLC"
+    "UseVLC": "Prompt to open video in VLC",
+    "UseVLCHint": "Add VLC player button to torrent content list"
  },
  "Size": "Size",
  "SpecialThanks": "Special Thanks",
--- a/web/src/locales/ru/translation.json
+++ b/web/src/locales/ru/translation.json
@@ -108,12 +108,19 @@
    "ConnectionsLimit": "Торрент-соединения",
    "ConnectionsLimitHint": "рекомендуется 20-25",
    "DHT": "DHT (Distributed Hash Table)",
+    "DisableDHTHint": "Распределенная хэш-таблица - отключите при отсутствии сети после запуска сервера",
+    "DisablePEXHint": "Обмен списками участников - не рекомендуется отключать",
+    "DisableTCPHint": "Не отключайте без включенного μTP",
+    "DisableUPNPHint": "Автоматическая настройка порта на роутере",
+    "DisableUTPHint": "Не рекомендуется включать на слабых устройствах",
    "Disk": "ПЗУ / Накопитель",
    "DLNA": "DLNA-медиасервер",
    "DontAddRetrackers": "Ничего не делать",
    "DownloadRateLimit": "Ограничение скорости загрузки",
    "EnableDebug": "Подробный журнал сервера",
+    "EnableIPv6Hint": "Включите только если поддерживается",
    "ForceEncrypt": "Шифрование заголовков",
+    "ForceEncryptHint": "Может помочь с блокирующими торрент провайдерами",
    "FriendlyName": "Имя сервера DLNA",
    "FriendlyNameHint": "Оставьте пустым, чтобы использовать значение по умолчанию.",
    "EnableRutorSearch": "Включить поиск по RuTor",
@@ -143,7 +150,8 @@
      "AdditionalDisabled": "(включите ПРО-режим)",
      "App": "Приложение"
    },
-    "UseVLC": "Предлагать открыть видео в VLC"
+    "UseVLC": "Предлагать открыть видео в VLC",
+    "UseVLCHint": "Добавить кнопку проигрывателя VLC в список торрент-контента"
  },
  "Size": "Размер",
  "SpecialThanks": "Отдельное спасибо",
--- a/web/src/locales/ua/translation.json
+++ b/web/src/locales/ua/translation.json
@@ -108,12 +108,19 @@
    "ConnectionsLimit": "Обмеження з'єдань",
    "ConnectionsLimitHint": "рекомендовано 20-25",
    "DHT": "DHT (Distributed Hash Table)",
+    "DisableDHTHint": "Відключіть при відсутності мережі після запуску сервера",
+    "DisablePEXHint": "Не рекомендується відключати",
+    "DisableTCPHint": "Не вимикайте без включеного μTP",
+    "DisableUPNPHint": "Автовідкриття порту на роутері",
+    "DisableUTPHint": "Не рекомендується на слабких пристроях",
    "Disk": "ПЗП / Носій",
    "DLNA": "DLNA-медиасервер",
    "DontAddRetrackers": "Нічого не робити",
    "DownloadRateLimit": "Обмеження швидкості завантаження",
    "EnableDebug": "Журнал налагодження сервера",
+    "EnableIPv6Hint": "Включите якщо підтримується",
    "ForceEncrypt": "Примусово шифрувати заголовки",
+    "ForceEncryptHint": "Може допомогти з блокуючими торрент провайдерами",
    "FriendlyName": "Ім'я сервера DLNA",
    "FriendlyNameHint": "Залиште порожнім, щоб використовувати значення за промовчанням.",
    "EnableRutorSearch": "Увімкніть пошук RuTor",
@@ -143,7 +150,8 @@
      "AdditionalDisabled": "(включіть ПРО-режим)",
      "App": "Додаток"
    },
-    "UseVLC": "Пропонувати відкрити відео у VLC"
+    "UseVLC": "Пропонувати відкрити відео у VLC",
+    "UseVLCHint": "Додати кнопку програвача VLC до списку торрент-контенту"
  },
  "Size": "Розмір",
  "SpecialThanks": "Окрема подяка",
--- a/web/src/style/materialUISetup.js
+++ b/web/src/style/materialUISetup.js
@@ -85,7 +85,7 @@ export const useMaterialUITheme = () => {
          MuiFormGroup: {
            root: {
              '& .MuiFormHelperText-root': {
-                marginTop: -10,
+                marginTop: -8,
              },
            },
          },