diff --git a/README.md b/README.md index 5ba9692..855659d 100644 --- a/README.md +++ b/README.md @@ -8,78 +8,69 @@ glance/ ├── home.yml # Главный файл конфигурации ├── widgets/ # Отдельные виджеты (модульная структура) -│ ├── bookmarks-homelab.yml # Закладки Homelab -│ ├── qbittorrent.yml # Виджет qBittorrent -│ └── ... # Другие виджеты -├── upload-glance-config.sh # Shell скрипт для загрузки конфигурации -├── upload-glance-config.ps1 # PowerShell обертка (использует WSL) -└── README.md # Этот файл +│ ├── bookmarks-general.yml # Общие закладки (Личное) +│ ├── bookmarks-homelab.yml # Закладки Homelab (Администрирование) +│ ├── countdown.yml # Виджет обратного отсчета +│ ├── qbittorrent.yml # Виджет qBittorrent +│ └── ... # Другие виджеты +├── upload-glance-config.ps1 # PowerShell скрипт для загрузки (Windows) +├── upload-glance-config.sh # Shell скрипт для загрузки (Linux/macOS) +└── README.md # Этот файл ``` ## 🚀 Установка и настройка ### Требования +**Для Windows:** +- PowerShell 5.1+ (предустановлен в Windows 10/11) +- Установленный OpenSSH Client (обычно предустановлен в Windows 10/11) + - Проверить: `ssh -V` + **Для Linux/macOS:** - `bash` -- `ssh` и `scp` (обычно предустановлены) -- SSH доступ к серверу с Glance - -**Для Windows:** -- [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/ru-ru/windows/wsl/install) -- PowerShell 5.1+ (предустановлен в Windows 10/11) -- SSH доступ к серверу с Glance - -### Установка WSL (только для Windows) - -```powershell -# Запустите PowerShell от имени администратора -wsl --install -``` - -После установки перезагрузите компьютер. +- `ssh` и `scp` ## 📤 Загрузка конфигурации на сервер -### Linux/macOS +### Windows (PowerShell) -```bash -# С параметрами по умолчанию (./glance, root@192.168.50.114) -./upload-glance-config.sh - -# С произвольными параметрами -./upload-glance-config.sh /path/to/glance username 192.168.50.100 -``` - -### Windows +Скрипт использует нативный OpenSSH клиент в Windows. ```powershell -# С параметрами по умолчанию +# Запуск из директории репозитория (параметры по умолчанию) .\upload-glance-config.ps1 -# С произвольными параметрами -.\upload-glance-config.ps1 -LocalDir "e:\repos\glance" -User "root" -Host "192.168.50.114" +# С указанием хоста +.\upload-glance-config.ps1 -RemoteHost "192.168.50.114" -# Или в кратком виде -.\upload-glance-config.ps1 "e:\repos\glance" "root" "192.168.50.114" +# Полная версия (если запускаете из другой папки) +.\upload-glance-config.ps1 -LocalDir "e:\repos\glance" -User "root" -RemoteHost "192.168.50.114" ``` -> **Примечание:** PowerShell скрипт является оберткой, которая вызывает shell скрипт через WSL, избегая дублирования кода. +### Linux/macOS (Bash) -## ⚙️ Параметры скрипта +```bash +# Добавьте права на выполнение +chmod +x upload-glance-config.sh + +# Запуск +./upload-glance-config.sh +``` + +## ⚙️ Параметры скрипта (PowerShell) | Параметр | Описание | Значение по умолчанию | |----------|----------|----------------------| -| `LOCAL_DIR` / `-LocalDir` | Локальная директория с конфигурацией | `./glance` | -| `USER` / `-User` | Пользователь SSH | `root` | -| `HOST` / `-Host` | IP адрес или hostname сервера | `192.168.50.114` | +| `LocalDir` | Локальная директория с конфигурацией | `.` (Текущая директория) | +| `User` | Пользователь SSH | `root` | +| `RemoteHost` | IP адрес или hostname сервера | `192.168.50.114` | ## 📋 Что делает скрипт -1. **Загружает `home.yml`** → `/opt/glance/config/glance.yml` на сервере -2. **Синхронизирует директорию `widgets/`** → `/opt/glance/config/widgets/` на сервере -3. **Автоматически создает** необходимые директории на сервере -4. **Проверяет наличие** файлов и директорий перед загрузкой +1. **Загружает `home.yml`** → `/opt/glance/config/glance.yml` на сервере. +2. **Синхронизирует директорию `widgets/`** → `/opt/glance/config/widgets/` на сервере. +3. **Автоматически создает** необходимые директории на сервере. > Glance автоматически перезагружает конфигурацию при обнаружении изменений. @@ -98,64 +89,27 @@ pages: path: widgets/bookmarks-homelab.yml ``` -### Преимущества модульной структуры - -- ✅ Легче управлять и редактировать отдельные виджеты -- ✅ Переиспользование виджетов в разных страницах -- ✅ Простота версионирования и отладки -- ✅ Чище git история изменений +Это позволяет разделять конфигурацию на логические блоки (например, `bookmarks-general.yml` и `bookmarks-homelab.yml`). ## 🔧 Настройка SSH ключей (рекомендуется) -Для автоматической загрузки без ввода пароля: +Для автоматической загрузки без ввода пароля настройте SSH ключи: -```bash -# Сгенерируйте SSH ключ (если еще не создан) +```powershell +# Windows / Linux / macOS +# 1. Генерируем ключ (если нет) ssh-keygen -t ed25519 -C "glance-config" -# Скопируйте ключ на сервер +# 2. Копируем на сервер +# Windows (PowerShell): +type $env:USERPROFILE\.ssh\id_ed25519.pub | ssh root@192.168.50.114 "cat >> .ssh/authorized_keys" + +# Linux/macOS: ssh-copy-id root@192.168.50.114 ``` -## 🐛 Устранение неполадок - -### Windows: "wsl: команда не найдена" - -Убедитесь, что WSL установлен: -```powershell -wsl --version -``` - -Если WSL не установлен, выполните: -```powershell -wsl --install -``` - -### Ошибка SSH подключения - -Проверьте подключение вручную: -```bash -ssh root@192.168.50.114 -``` - -### Директория не найдена - -Убедитесь, что вы запускаете скрипт из правильной директории: -```bash -# Linux/macOS -ls -la glance/ - -# PowerShell -Get-ChildItem glance/ -``` - ## 📚 Полезные ссылки - [Glance Documentation](https://github.com/glanceapp/glance) - [Glance Configuration Examples](https://github.com/glanceapp/glance/blob/main/docs/configuration.md) -- [WSL Documentation (RU)](https://docs.microsoft.com/ru-ru/windows/wsl/) - -## 📝 Лицензия - -Этот проект следует лицензии основного проекта [Glance](https://github.com/glanceapp/glance).