Добавлены новые документы и инструкции по настройке, использованию и тестированию SSL сертификатов Let's Encrypt с использованием API reg.ru. Обновлены зависимости в requirements.txt для поддержки новых функций. Включены подробные шаги по автоматизации, созданию и продлению сертификатов, а также интеграции с Nginx Proxy Manager.
This commit is contained in:
174
docs/en/DOCS_INDEX_EN.md
Normal file
174
docs/en/DOCS_INDEX_EN.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# 📚 Documentation Index
|
||||
|
||||
## 🇬🇧 English Documentation
|
||||
|
||||
### Main Guides
|
||||
- **[DESCRIPTION_EN.md](DESCRIPTION_EN.md)** - Project Description & Overview
|
||||
- **[BUILD_GUIDE_EN.md](BUILD_GUIDE_EN.md)** - Complete Build Guide
|
||||
- **[QUICKSTART_BUILD_EN.md](QUICKSTART_BUILD_EN.md)** - Quick Build Start (5 minutes)
|
||||
- **[RELEASE_GUIDE_EN.md](RELEASE_GUIDE_EN.md)** - Automated Release Guide
|
||||
- **[INSTALL_GUIDE_EN.md](INSTALL_GUIDE_EN.md)** - Installation Guide
|
||||
- **[TESTING_GUIDE_EN.md](TESTING_GUIDE_EN.md)** - Testing Guide
|
||||
|
||||
### Reference Materials
|
||||
- **[MAKEFILE_COMMANDS_EN.md](MAKEFILE_COMMANDS_EN.md)** - Makefile Commands Reference
|
||||
- **[CHEATSHEET_EN.md](CHEATSHEET_EN.md)** - Quick Reference
|
||||
- **[CHANGELOG_EN.md](CHANGELOG_EN.md)** - Change History
|
||||
|
||||
### Developer Guides
|
||||
- **[PROJECT_STRUCTURE_EN.md](PROJECT_STRUCTURE_EN.md)** - Project Structure
|
||||
- **[GITEA_SYNC_EN.md](GITEA_SYNC_EN.md)** - Gitea → GitHub Synchronization
|
||||
|
||||
### SSL & Certificates
|
||||
- **[SSL_SCRIPTS_README_EN.md](SSL_SCRIPTS_README_EN.md)** - SSL Scripts Documentation
|
||||
- **[SSL_Certificate_Creation_and_Renewal_EN.md](SSL_Certificate_Creation_and_Renewal_EN.md)** - SSL Certificate Guide
|
||||
- **[Add_Lets_Encrypt_Certificate_for_regru_Provider_EN.md](Add_Lets_Encrypt_Certificate_for_regru_Provider_EN.md)** - Let's Encrypt + reg.ru
|
||||
|
||||
### Nginx Integration
|
||||
- **[Nginx_Manager_SSL_Configuration_EN.md](Nginx_Manager_SSL_Configuration_EN.md)** - Nginx Manager SSL Setup
|
||||
|
||||
---
|
||||
|
||||
## 🇷🇺 Russian Documentation / Русская документация
|
||||
|
||||
### Основные руководства / Main Guides
|
||||
- **[DESCRIPTION.md](../ru/DESCRIPTION.md)** - Описание проекта
|
||||
- **[BUILD_GUIDE.md](../ru/BUILD_GUIDE.md)** - Полное руководство по сборке
|
||||
- **[QUICKSTART_BUILD.md](../ru/QUICKSTART_BUILD.md)** - Быстрый старт сборки (5 минут)
|
||||
- **[RELEASE_GUIDE.md](../ru/RELEASE_GUIDE.md)** - Руководство по автоматическим релизам
|
||||
- **[INSTALL_GUIDE.md](../ru/INSTALL_GUIDE.md)** - Руководство по установке
|
||||
- **[TESTING_GUIDE.md](../ru/TESTING_GUIDE.md)** - Руководство по тестированию
|
||||
|
||||
### Справочная информация / Reference Materials
|
||||
- **[MAKEFILE_COMMANDS.md](../ru/MAKEFILE_COMMANDS.md)** - Справочник команд Makefile
|
||||
- **[CHEATSHEET.md](../ru/CHEATSHEET.md)** - Быстрая шпаргалка
|
||||
- **[CHANGELOG.md](../ru/CHANGELOG.md)** - История изменений
|
||||
|
||||
### Руководства для разработчиков / Developer Guides
|
||||
- **[PROJECT_STRUCTURE.md](../ru/PROJECT_STRUCTURE.md)** - Структура проекта
|
||||
- **[GITEA_SYNC.md](../ru/GITEA_SYNC.md)** - Синхронизация Gitea → GitHub
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start / Быстрый старт
|
||||
|
||||
### For End Users / Для конечных пользователей
|
||||
|
||||
**English:**
|
||||
1. Start here: [DESCRIPTION_EN.md](DESCRIPTION_EN.md)
|
||||
2. Install: [INSTALL_GUIDE_EN.md](INSTALL_GUIDE_EN.md)
|
||||
3. Test: [TESTING_GUIDE_EN.md](TESTING_GUIDE_EN.md)
|
||||
4. Quick reference: [CHEATSHEET_EN.md](CHEATSHEET_EN.md)
|
||||
|
||||
**Russian / Русский:**
|
||||
1. Начните здесь: [DESCRIPTION.md](../ru/DESCRIPTION.md)
|
||||
2. Установка: [INSTALL_GUIDE.md](../ru/INSTALL_GUIDE.md)
|
||||
3. Тестирование: [TESTING_GUIDE.md](../ru/TESTING_GUIDE.md)
|
||||
4. Шпаргалка: [CHEATSHEET.md](../ru/CHEATSHEET.md)
|
||||
|
||||
### For Developers / Для разработчиков
|
||||
|
||||
**English:**
|
||||
1. Build guide: [BUILD_GUIDE_EN.md](BUILD_GUIDE_EN.md)
|
||||
2. Quick build: [QUICKSTART_BUILD_EN.md](QUICKSTART_BUILD_EN.md)
|
||||
3. Create release: [RELEASE_GUIDE_EN.md](RELEASE_GUIDE_EN.md)
|
||||
4. Commands: [MAKEFILE_COMMANDS_EN.md](MAKEFILE_COMMANDS_EN.md)
|
||||
|
||||
**Russian / Русский:**
|
||||
1. Руководство по сборке: [BUILD_GUIDE.md](../ru/BUILD_GUIDE.md)
|
||||
2. Быстрая сборка: [QUICKSTART_BUILD.md](../ru/QUICKSTART_BUILD.md)
|
||||
3. Создание релиза: [RELEASE_GUIDE.md](../ru/RELEASE_GUIDE.md)
|
||||
4. Команды: [MAKEFILE_COMMANDS.md](../ru/MAKEFILE_COMMANDS.md)
|
||||
|
||||
---
|
||||
|
||||
## 📖 Documentation by Topic / Документация по темам
|
||||
|
||||
### Installation / Установка
|
||||
| Topic | English | Russian |
|
||||
|-------|---------|---------|
|
||||
| Installation Guide | [INSTALL_GUIDE_EN.md](INSTALL_GUIDE_EN.md) | [INSTALL_GUIDE.md](../ru/INSTALL_GUIDE.md) |
|
||||
| Quick Start | [DESCRIPTION_EN.md](DESCRIPTION_EN.md) | [DESCRIPTION.md](../ru/DESCRIPTION.md) |
|
||||
|
||||
### Building / Сборка
|
||||
| Topic | English | Russian |
|
||||
|-------|---------|---------|
|
||||
| Complete Build Guide | [BUILD_GUIDE_EN.md](BUILD_GUIDE_EN.md) | [BUILD_GUIDE.md](../ru/BUILD_GUIDE.md) |
|
||||
| Quick Build (5 min) | [QUICKSTART_BUILD_EN.md](QUICKSTART_BUILD_EN.md) | [QUICKSTART_BUILD.md](../ru/QUICKSTART_BUILD.md) |
|
||||
| Makefile Commands | [MAKEFILE_COMMANDS_EN.md](MAKEFILE_COMMANDS_EN.md) | [MAKEFILE_COMMANDS.md](../ru/MAKEFILE_COMMANDS.md) |
|
||||
|
||||
### Releases / Релизы
|
||||
| Topic | English | Russian |
|
||||
|-------|---------|---------|
|
||||
| Automated Releases | [RELEASE_GUIDE_EN.md](RELEASE_GUIDE_EN.md) | [RELEASE_GUIDE.md](../ru/RELEASE_GUIDE.md) |
|
||||
| Changelog | [CHANGELOG_EN.md](CHANGELOG_EN.md) | [CHANGELOG.md](../ru/CHANGELOG.md) |
|
||||
|
||||
### Testing / Тестирование
|
||||
| Topic | English | Russian |
|
||||
|-------|---------|---------|
|
||||
| Testing Guide | [TESTING_GUIDE_EN.md](TESTING_GUIDE_EN.md) | [TESTING_GUIDE.md](../ru/TESTING_GUIDE.md) |
|
||||
|
||||
### Reference / Справка
|
||||
| Topic | English | Russian |
|
||||
|-------|---------|---------|
|
||||
| Quick Reference | [CHEATSHEET_EN.md](CHEATSHEET_EN.md) | [CHEATSHEET.md](../ru/CHEATSHEET.md) |
|
||||
| Project Structure | [PROJECT_STRUCTURE_EN.md](PROJECT_STRUCTURE_EN.md) | [PROJECT_STRUCTURE.md](../ru/PROJECT_STRUCTURE.md) |
|
||||
|
||||
---
|
||||
|
||||
## 📊 Documentation Status / Статус документации
|
||||
|
||||
| Document | English | Russian | Status |
|
||||
|----------|---------|---------|--------|
|
||||
| Description | ✅ | ✅ | Complete |
|
||||
| Build Guide | ✅ | ✅ | Complete |
|
||||
| Quick Build | ✅ | ✅ | Complete |
|
||||
| Release Guide | ✅ | ✅ | Complete |
|
||||
| Install Guide | ✅ | ✅ | Complete |
|
||||
| Makefile Commands | ✅ | ✅ | Complete |
|
||||
| Testing Guide | ✅ | ✅ | Complete |
|
||||
| Cheatsheet | ✅ | ✅ | Complete |
|
||||
| Project Structure | ✅ | ✅ | Complete |
|
||||
| Gitea Sync | ✅ | ✅ | Complete |
|
||||
| Changelog | ✅ | ✅ | Complete |
|
||||
|
||||
**Legend:**
|
||||
- ✅ Complete / Готово
|
||||
- 🔄 In Progress / В разработке
|
||||
- ❌ Not Started / Не начато
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Choose Your Language / Выберите язык
|
||||
|
||||
### 🇬🇧 Prefer English?
|
||||
👉 Start with [DESCRIPTION_EN.md](DESCRIPTION_EN.md)
|
||||
|
||||
### 🇷🇺 Предпочитаете русский?
|
||||
👉 Начните с [DESCRIPTION.md](../ru/DESCRIPTION.md)
|
||||
|
||||
---
|
||||
|
||||
## 💡 Contributing / Вклад
|
||||
|
||||
Help improve documentation / Помогите улучшить документацию:
|
||||
- Report issues / Сообщайте об ошибках
|
||||
- Suggest improvements / Предлагайте улучшения
|
||||
- Fix typos / Исправляйте опечатки
|
||||
- Translate / Переводите
|
||||
|
||||
---
|
||||
|
||||
## 🔗 External Resources / Внешние ресурсы
|
||||
|
||||
- **reg.ru API**: https://www.reg.ru/support/api
|
||||
- **Let's Encrypt**: https://letsencrypt.org/
|
||||
- **Nginx Proxy Manager**: https://nginxproxymanager.com/
|
||||
- **PyInstaller**: https://pyinstaller.org/
|
||||
- **GitHub Actions**: https://docs.github.com/actions
|
||||
- **Gitea Actions**: https://docs.gitea.com/usage/actions/overview
|
||||
|
||||
---
|
||||
|
||||
**Last Updated / Обновлено**: October 28, 2025
|
||||
**Maintained by / Поддерживает**: Dmitry Fofanov
|
||||
Reference in New Issue
Block a user