all docs and guides for gonets
This commit is contained in:
parent
f48486d427
commit
61865905a1
38 changed files with 1114 additions and 27 deletions
199
ПРИЛОЖЕНИЕ ГоNETS Материалы/Инструкция по пользованию.md
Normal file
199
ПРИЛОЖЕНИЕ ГоNETS Материалы/Инструкция по пользованию.md
Normal file
|
|
@ -0,0 +1,199 @@
|
|||
# Инструкция по пользованию
|
||||
|
||||
## Описание
|
||||
|
||||
**GoNets** — это приложение для удобного и эффективного управления сетями в Linux с интуитивно понятным графическим интерфейсом. Оно помогает пользователям работать с сетевыми интерфейсами и узлами через визуальные блоки, что упрощает настройку и управление сетью без необходимости использования множества команд в терминале.
|
||||
|
||||
### Основные компоненты приложения:
|
||||
|
||||
- **Клиентская часть**: веб-приложение, использующее современные подходы веб-разработки для отображения сетевых интерфейсов и их связей в виде узлов и соединений. Приложение обёрнуто в Electron, что позволяет запускать приложение как десктопное.
|
||||
- **Серверная часть**: сервис на Python, который взаимодействует с операционной системой через D-Bus и передает данные клиенту через WebSocket.
|
||||
|
||||
## Установка
|
||||
|
||||
1. **Скачивание и установка**:
|
||||
Скачайте DEB-пакет GoNets и установите его на вашу систему Linux. Установка автоматически запустит серверную часть как системный сервис на адресе https://localhost:8001.
|
||||
2. **Запуск клиента**:
|
||||
Запустите клиентскую часть через Electron, которая подключится к серверу и начнёт отображать сетевые интерфейсы.
|
||||
|
||||
## Первы запуск приложения
|
||||
|
||||
### 1\. Настройка пароля администратора
|
||||
|
||||
При первом запуске необходимо создать пароль администратора. Он будет использоваться для доступа к функциям с повышенными правами (например, изменение IP-адресов).
|
||||
|
||||
В окне создания пароля доступны также:
|
||||
|
||||
- Переключение темы интерфейса.
|
||||
- Переход на страницу «О приложении».
|
||||
- Кнопка возврата на корневой узел (если происходит регистрация подключённого узла).
|
||||
|
||||
**Что такое узел?**
|
||||
В контексте GoNets **узел** — это отдельное, подключённое к общей сети и управляемый через приложение. Узел может быть **корневым** (локальный компьютер, с которого запущено приложение) или **подключённым** (удалённая система, подключённая к корневому узлу).
|
||||
|
||||
**Особенности пароля:**
|
||||
|
||||
- У каждого узла (корневого или подключённого) — свой уникальный пароль администратора.
|
||||
- Пример для корневого узла: `securePass2025`
|
||||
- Пример для подключённого узла: \`adminNet123
|
||||
- Если на подключённом узле пароль ещё не задан, система предложит создать его при первом подключении.
|
||||
|
||||
## Интерфейс и работа с приложением
|
||||
|
||||
### 1\. Рабочее пространство
|
||||
|
||||
После успешной настройки пароля открывается стартовое приветственное окно, из которого осуществляется переход к основным модулям приложения. В текущей версии доступен один модуль — **Настройки сети**.
|
||||
|
||||
Рабочее пространство включает два постоянных элемента:
|
||||
|
||||
- **Боковая панель** — основной элемент навигации, доступен во всех разделах приложения.
|
||||
- **Рабочая область** — в ней отображаются модули и интерфейсы, связанные с выбранным разделом.
|
||||
|
||||
#### 1.1 Боковая панель
|
||||
|
||||
Боковая панель размещена слева и предоставляет быстрый доступ к следующим функциям:
|
||||
|
||||
- **Управление узлами** — кнопка с иконкой _Монитора_, открывает меню управления устройствами.
|
||||
- **Смена темы оформления** — переключение между светлой, тёмной и системной темой.
|
||||
- **Профиль пользователя** — отображает текущий уровень доступа (пользователь / администратор) с возможностью смены.
|
||||
- **О программе** — отображает информацию о версии и дате выпуска.
|
||||
|
||||
##### 1.2 Настройки сети
|
||||
|
||||
Этот модуль представляет собой интерактивный холст, на котором в графической форме отображаются сетевые интерфейсы и их связи. Такой подход обеспечивает наглядное и удобное управление сетевой конфигурацией.
|
||||
|
||||
Элементы на холсте можно перемещать для лучшего отображения. Положение элементов будет сохраняться даже при выходе из приложения. Чтобы вернуть все элементы в исходное положение, в хэдере холста нажмите на иконку сброса. Чтобы закрыть холст, нажмите на иконку закрытия и вы попадёте обратно на приветственное окно
|
||||
|
||||
На холсте отображаются следующие элементы:
|
||||
|
||||
1. **Группы интерфейсов**
|
||||
Все сетевые интерфейсы распределяются на две группы: **активные** и **неактивные**.Каждая группа оформлена в виде рамки с заголовком и кнопкой «Скрыть/Показать», позволяющей сворачивать или разворачивать список интерфейсов.
|
||||
2. **Блок сетевого интерфейса**
|
||||
Каждый интерфейс отображается в отдельном блоке, содержащем:
|
||||
- **Заголовок** — название интерфейса, его тип (например, ethernet, wifi или VPN), а также текущий статус, который представлен цветом заголовка интерфейса.
|
||||
- **Конфигурацию** — MAC-адрес и значение MTU.
|
||||
- **Блоки IP-адресов** (опционально) — один или несколько блоков с информацией о назначенных IP-адресах.
|
||||
3. **Блок IP-адреса**Каждый блок IP-адреса включает:
|
||||
- **Заголовок** — указывается метод получения адреса: `DHCP` или `Static`, а также кнопка редактирования.
|
||||
- **Параметры** — строки с IP-адресом, шлюзом и DNS-серверами.
|
||||
- При активации редактирования, строки заменяются на поля ввода. В заголовке блока при этом появляются кнопки подтверждения и отмены изменений.
|
||||
|
||||
### 2\. Управление узлами
|
||||
|
||||
Управление узлами осуществляется через **боковую панель**. Для этого нажмите на иконку _Монитора_ — откроется меню с перечнем доступных устройств.
|
||||
|
||||
В меню узлов отображаются:
|
||||
|
||||
1. **Корневой узел** — локальное устройство, на котором запущено приложение. Его имя берётся из системного `hostname`.
|
||||
2. **Список подключённых узлов** — отображаются в порядке добавления.
|
||||
3. **Кнопка добавления нового узла** — представлена в виде блока с символом "+".
|
||||
|
||||
#### 2.1 Добавление нового узла
|
||||
|
||||
При нажатии на кнопку **"+"** откроется модальное окно, в котором потребуется указать адрес подключаемого устройства.
|
||||
В текущей версии приложения поддерживается подключение только к узлам, находящимся в одной локальной сети с корневым.
|
||||
|
||||
После ввода адреса и подтверждения, приложение попытается установить соединение с выбранным узлом. Если на нём установлено приложение GoNets, соединение будет успешно установлено, и узел появится в списке. В противном случае подключение не состоится, и переключение на данный узел будет невозможно.
|
||||
|
||||
#### 2.2 Пароль администратора на узлах
|
||||
|
||||
При первом переходе на подключённый узел система проверит, задан ли на нём пароль администратора GoNets.
|
||||
Если пароль отсутствует, появится предложение создать его. Этот пароль требуется для выполнения действий с повышенными правами, таких как изменение IP-адресов или управление интерфейсами.
|
||||
|
||||
> **Важно**: проверка пароля выполняется один раз — при первом запуске GoNets на каждом устройстве. Установленный пароль сохраняется на узле и в дальнейшем используется без повторной настройки.
|
||||
|
||||
#### 2.3. Возврат к корневому узлу
|
||||
|
||||
Чтобы вернуться на корневой узел просто нажмите на него в списке узлов, он всегда будет первым.
|
||||
|
||||
### 3\. Права пользователя приложения
|
||||
|
||||
В приложении реализована двухуровневая система прав доступа:
|
||||
|
||||
- **Ограниченные права** — режим по умолчанию при входе в приложение, даже после создания пароля администратора.
|
||||
- **Администраторский доступ** — расширенные права, необходимые для изменения конфигурации сетевых параметров.
|
||||
|
||||
Даже после создания пароля администратора Пользователь попадает в приложение с ограниченными правами.
|
||||
|
||||
#### 3.1 Ограниченный режим
|
||||
|
||||
В ограниченном режиме пользователь может просматривать сетевую конфигурацию, но **не имеет доступа к редактированию IP-адресов** интерфейсов. При попытке изменить параметры IP, шлюза или DNS, будет отображено уведомление о невозможности выполнения действия без прав администратора.
|
||||
|
||||
#### 3.2 Повышение прав до администратора
|
||||
|
||||
Для получения прав администратора:
|
||||
|
||||
1. Нажмите на иконку перечёркнутого щита в **боковой панели**.
|
||||
2. В открывшемся модальном окне введите **администраторский пароль** для текущего узла.
|
||||
Важно: пароль должен соответствовать именно тому узлу, с которым Вы работаете в данный момент.
|
||||
3. После успешного ввода:
|
||||
- Появится уведомление об успешной авторизации. Оно автоматически исчезнет через 3 секунды или может быть закрыто вручную.
|
||||
- Иконка в боковой панели изменится, отображая текущий статус пользователя (администратор или ограниченный доступ).
|
||||
4.
|
||||
|
||||
#### 3.3 Возврат в ограниченный режим
|
||||
|
||||
Чтобы отключить расширенные права:
|
||||
|
||||
1. Снова нажмите на иконку доступа в боковой панели.
|
||||
2. В модальном окне нажмите кнопку **«Ограничить»**.
|
||||
3. После этого права пользователя будут понижены, и доступ к редактированию IP-адресов будет снова ограничен.
|
||||
|
||||
### 4\. Взаимодействие с IP-адресами
|
||||
|
||||
Приложение предоставляет удобный способ управления IP-адресами сетевых интерфейсов. Все изменения доступны **только при наличии административных прав доступа**.
|
||||
|
||||
#### 4.1 Переход в режим редактирования
|
||||
|
||||
Чтобы изменить параметры IP-адреса:
|
||||
|
||||
1. Убедитесь, что Вы находитесь в **режиме администратора**.
|
||||
2. Найдите нужный интерфейс в группе **активных интерфейсов**.
|
||||
3. Нажмите на кнопку с иконкой **карандаша** в заголовке блока IP-адреса.
|
||||
|
||||
После этого строки с параметрами IP-адреса преобразуются в с поля ввода для редактирования:
|
||||
|
||||
- **IP-адрес**
|
||||
- **Шлюз**
|
||||
- **DNS-серверы**
|
||||
|
||||
В заголовке блока IP-Адреса появятся две кнопки: **Подтвердить** и **Отменить изменения**.
|
||||
|
||||
#### 4.2 Требования к данным
|
||||
|
||||
Перед подтверждением убедитесь, что:
|
||||
|
||||
- Указанные IP-адрес, шлюз и DNS-серверы находятся **в одной подсети**.
|
||||
- Все поля заполнены корректно.
|
||||
|
||||
Если данные не соответствуют требованиям, появится предупреждение
|
||||
|
||||
#### 4.3 Проверка и подтверждение изменений
|
||||
|
||||
После ввода корректных данных:
|
||||
|
||||
1. Нажмите кнопку **подтверждения**.
|
||||
2. Отобразится **экран загрузки**, во время которого приложение производит сканирование локальной сети, чтобы:
|
||||
- Проверить доступность указанного IP-адреса.
|
||||
- Убедиться, что адрес **не занят другим устройством**.
|
||||
|
||||
Если IP-адрес уже используется, появится уведомление, и изменения применить не удастся, это уведомление можно будет закрыть.
|
||||
|
||||
Если адрес свободен:
|
||||
|
||||
1. Откроется **модальное окно подтверждения**, в котором отображаются:
|
||||
- **Текущие параметры** IP-адреса.
|
||||
- **Новые параметры**, введённые пользователем.
|
||||
- Здесь Вы можете либо **отменить изменения**, либо **сохранить** их.
|
||||
|
||||
> Обратите внимание: в процессе могут несколько раз отображаться **экраны загрузки** — это нормально. Сервер динамически обрабатывает изменения и проверяет доступность указанных параметров.
|
||||
|
||||
#### 4.4 Изменение адреса подключённого узла
|
||||
|
||||
Если редактирование IP-адреса выполняется **у подключённого узла**, то при успешном применении новый адрес автоматически **обновится в списке узлов** в боковой панели. Это необходимо для корректной работы приложения и исключения путаницы.
|
||||
|
||||
## Заключение
|
||||
|
||||
GoNets значительно упрощает управление сетями в Linux, предоставляя удобный графический интерфейс для работы с сетевыми интерфейсами и узлами. Вы можете легко настраивать IP-адреса, добавлять новые узлы и управлять ими, а также изменять параметры интерфейсов без необходимости использовать командную строку.
|
||||
|
||||
Для получения дополнительной информации и подробных инструкций, пожалуйста, ознакомьтесь с документацией и скриншотами, которые будут добавлены в следующей версии.
|
||||
Loading…
Add table
Add a link
Reference in a new issue