Добавить README.md

2025-01-30 10:13:58 +00:00 · 2025-01-30 10:13:58 +00:00 · cca9ddb00f
commit cca9ddb00f
parent a73a6494bb
1 changed files with 96 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,96 @@
+```markdown
+# VPS Auto-Setup Script
+
+Автоматический скрипт для настройки VPS с базовыми инструментами и Docker-окружением.
+
+## Что устанавливается
+
+- 🛠️ **Системные утилиты**: 
+  - `tmux` 
+  - `mc` (Midnight Commander)
+  - `net-tools` (ifconfig и другие сетевые инструменты)
+  - `git`
+- 🐋 **Docker & Docker Compose** (как плагин, без дефиса)
+- 🧩 **Dry** (интерфейс для управления Docker)
+- 🔗 **Клонирование репозитория** [opendoor-vpn-to-tor](https://git.softuniq.eu/OpenDoor/opendoor-vpn-to-tor)
+
+## Предварительные требования
+
+- Сервер на базе **Ubuntu/Debian**
+- Пользователь с правами **sudo**
+
+## Быстрый старт
+
+Запустите одной командой:
+
+```bash
+bash <(curl -s https://git.softuniq.eu/OpenDoor/opendoor-vpn-to-tor/raw/branch/main/setup_vps.sh)
+```
+
+## Ручная установка
+
+1. Скачайте скрипт:
+   ```bash
+   wget https://git.softuniq.eu/OpenDoor/opendoor-vpn-to-tor/raw/branch/main/setup_vps.sh
+   ```
+2. Сделайте исполняемым:
+   ```bash
+   chmod +x setup_vps.sh
+   ```
+3. Запустите:
+   ```bash
+   ./setup_vps.sh
+   ```
+
+## Что делает скрипт
+
+1. Обновляет систему и устанавливает пакеты:
+   ```bash
+   sudo apt-get update && sudo apt-get upgrade -y
+   ```
+2. Устанавливает Docker и Docker Compose (плагин)
+3. Настраивает права для работы с Docker без sudo
+4. Клонирует репозиторий в текущую директорию
+5. Проверяет версии всех установленных компонентов
+
+## После установки
+
+- Чтобы применить изменения группы `docker`, выполните:
+  ```bash
+  newgrp docker
+  ```
+  или перезапустите сессию.
+
+- Проверьте работу Docker:
+  ```bash
+  docker run hello-world
+  ```
+
+## Примеры использования
+
+- Запуск Docker Compose:
+  ```bash
+  docker compose up -d
+  ```
+
+- Запуск Dry (интерфейс для Docker):
+  ```bash
+  dry
+  ```
+
+## Лицензия
+
+MIT License. Подробнее в файле [LICENSE](LICENSE).
+
+---
+
+**Примечание**: Перед запуском убедитесь, что доверяете источнику скрипта.
+```
+
+## Как это будет выглядеть на GitHub:
+![Preview](https://i.imgur.com/5jXzKgq.png)
+
+## Рекомендации:
+1. Создайте файл `LICENSE` с текстом лицензии MIT.
+2. Добавьте скриншоты работы скрипта в папку `screenshots/`.
+3. Для иконок можно использовать эмодзи или SVG-иконки.