Добавлено описание команд и улучшено логирование в документации. Включены команды диагностики и тестирования для проверки API и DNS, а также обновлены основные команды в руководствах.
This commit is contained in:
@@ -48,16 +48,40 @@ sudo make renew
|
||||
|
||||
## 📋 Основные команды
|
||||
|
||||
| Команда | Описание | Лимиты |
|
||||
|---------|----------|--------|
|
||||
| `make test-cert` | Тестовый сертификат | ✅ Нет |
|
||||
| `make obtain` | Let's Encrypt новый | ⚠️ 5/неделю |
|
||||
| `make renew` | Обновить существующий | ⚠️ 5/неделю |
|
||||
| `make run` | Авто-режим | ⚠️ 5/неделю |
|
||||
### Команды letsencrypt-regru
|
||||
|
||||
| Команда | Описание | Лимиты | Использование |
|
||||
|---------|----------|--------|---------------|
|
||||
| `--check` | Проверить срок действия | - | Мониторинг |
|
||||
| `--obtain` | Получить новый сертификат | ⚠️ 5/неделю | Первое создание |
|
||||
| `--renew` | Обновить существующий | ⚠️ 5/неделю | Продление |
|
||||
| `--auto` | Авто-проверка и обновление | ⚠️ 5/неделю | Cron/systemd |
|
||||
| `--test-cert` | Тестовый сертификат | ✅ Нет | Разработка |
|
||||
| `--test-api` | Проверить API reg.ru | - | Диагностика |
|
||||
| `--test-dns` | Тест создания DNS записи | - | Проверка перед SSL |
|
||||
| `--help` | Справка | - | Помощь |
|
||||
| `-v` | Подробный вывод | - | Отладка |
|
||||
|
||||
### Команды Makefile
|
||||
|
||||
| Команда | Описание | Эквивалент |
|
||||
|---------|----------|------------|
|
||||
| `make test-cert` | Тестовый сертификат | `letsencrypt-regru --test-cert` |
|
||||
| `make obtain` | Let's Encrypt новый | `letsencrypt-regru --obtain` |
|
||||
| `make renew` | Обновить существующий | `letsencrypt-regru --renew` |
|
||||
| `make run` | Авто-режим | `letsencrypt-regru --auto` |
|
||||
| `make status` | Статус системы | - |
|
||||
| `make logs` | Показать логи | - |
|
||||
| `make logs` | Показать логи | `journalctl -u letsencrypt-regru` |
|
||||
| `make check-config` | Проверить конфигурацию | - |
|
||||
|
||||
### Команды letsencrypt_regru.sh
|
||||
|
||||
| Команда | Описание |
|
||||
|---------|----------|
|
||||
| `sudo bash letsencrypt_regru.sh install` | Установить приложение |
|
||||
| `sudo bash letsencrypt_regru.sh update` | Обновить приложение |
|
||||
| `sudo bash letsencrypt_regru.sh uninstall` | Удалить приложение |
|
||||
|
||||
---
|
||||
|
||||
## 📝 Конфигурация
|
||||
|
||||
@@ -100,7 +100,9 @@ sudo ./letsencrypt_regru.sh
|
||||
|
||||
## Использование команды letsencrypt-regru
|
||||
|
||||
После установки доступна удобная команда:
|
||||
После установки доступна удобная глобальная команда с множеством функций:
|
||||
|
||||
### 🔧 Основные команды
|
||||
|
||||
```bash
|
||||
# Проверить срок действия текущего сертификата
|
||||
@@ -117,11 +119,59 @@ letsencrypt-regru --auto
|
||||
|
||||
# Создать тестовый самоподписанный сертификат
|
||||
letsencrypt-regru --test-cert
|
||||
|
||||
# Показать справку
|
||||
letsencrypt-regru --help
|
||||
```
|
||||
|
||||
### 🧪 Команды диагностики и тестирования
|
||||
|
||||
```bash
|
||||
# Проверить доступ к API reg.ru
|
||||
# - Показывает текущий IP
|
||||
# - Тестирует подключение к API
|
||||
# - Отображает баланс аккаунта
|
||||
letsencrypt-regru --test-api
|
||||
|
||||
# Тестовое создание DNS записи TXT
|
||||
# - Полная симуляция процесса SSL сертификации
|
||||
# - Создает временную TXT запись _acme-challenge
|
||||
# - Ожидает распространения DNS (60 секунд)
|
||||
# - Проверяет через публичные DNS серверы
|
||||
# - Автоматически удаляет тестовую запись
|
||||
letsencrypt-regru --test-dns
|
||||
|
||||
# Показать справку по всем командам
|
||||
letsencrypt-regru --help
|
||||
|
||||
# Включить подробный вывод (verbose mode)
|
||||
letsencrypt-regru --obtain -v
|
||||
letsencrypt-regru --check -v
|
||||
```
|
||||
|
||||
### ⚙️ Служебные команды (внутреннее использование)
|
||||
|
||||
```bash
|
||||
# Certbot authentication hook (используется certbot автоматически)
|
||||
letsencrypt-regru --auth-hook
|
||||
|
||||
# Certbot cleanup hook (используется certbot автоматически)
|
||||
letsencrypt-regru --cleanup-hook
|
||||
```
|
||||
|
||||
### 📋 Описание команд
|
||||
|
||||
| Команда | Описание | Использование |
|
||||
|---------|----------|---------------|
|
||||
| `--check` | Проверяет срок действия сертификата | Регулярная проверка |
|
||||
| `--obtain` | Получает новый сертификат от Let's Encrypt | Первое создание |
|
||||
| `--renew` | Обновляет существующий сертификат | Продление срока |
|
||||
| `--auto` | Автоматическая проверка и обновление | Для cron/systemd |
|
||||
| `--test-cert` | Создает тестовый самоподписанный сертификат | Разработка/тестирование |
|
||||
| `--test-api` | Проверяет доступ к API reg.ru | Диагностика подключения |
|
||||
| `--test-dns` | Тестирует создание DNS записи | Проверка перед SSL |
|
||||
| `--auth-hook` | Hook для certbot (создание DNS) | Внутреннее |
|
||||
| `--cleanup-hook` | Hook для certbot (удаление DNS) | Внутреннее |
|
||||
| `--help` | Показывает справку | Помощь |
|
||||
| `-v` | Подробный вывод | Отладка |
|
||||
|
||||
## Автоматическое обновление
|
||||
|
||||
Установщик настраивает systemd timer для автоматической проверки:
|
||||
|
||||
Reference in New Issue
Block a user