docs: initial commit with license and README files
- Added MIT LICENSE - Added README.md (RU) - Added README.en.md (EN)
This commit is contained in:
parent
e581b81a1a
commit
efb628fba0
9
LICENSE
Normal file
9
LICENSE
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 Stepan Kasatkin
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
114
README.en.md
Normal file
114
README.en.md
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
# 🐳 Rootless Docker + Docker Compose Installer
|
||||||
|
|
||||||
|
[](https://www.gnu.org/software/bash/)
|
||||||
|
[](https://docs.docker.com/engine/security/rootless/)
|
||||||
|
[](./LICENSE)
|
||||||
|
[](#)
|
||||||
|
|
||||||
|
An interactive Bash installer for quick installation of **Rootless Docker**, **Docker Compose**, and full environment cleanup.
|
||||||
|
|
||||||
|
[🇷🇺 Читать на русском](./README.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📁 Repository Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── version
|
||||||
|
│ # self-update file
|
||||||
|
└── scripts/
|
||||||
|
├── docker-install.sh # main installer
|
||||||
|
└── docker-installer-init.sh # loader placed in /etc/profile.d
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Dependencies
|
||||||
|
|
||||||
|
| Utility | Purpose |
|
||||||
|
|-------------|------------------------------------|
|
||||||
|
| `curl` | Downloading files over HTTP(S) |
|
||||||
|
| `bash` | Script interpreter |
|
||||||
|
| `tput` | Terminal color output |
|
||||||
|
| `whiptail` | Terminal-based dialog menus |
|
||||||
|
| `ncurses` | Cursor and color control |
|
||||||
|
|
||||||
|
### Install dependencies:
|
||||||
|
|
||||||
|
#### Ubuntu / Debian:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install -y curl bash whiptail ncurses-bin
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Installation via `curl`
|
||||||
|
|
||||||
|
### One-time execution (current user):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/docker-install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Persistent installation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/docker-install.sh -o ./docker-install.sh
|
||||||
|
sudo chmod +x ./docker-install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Run the installer:
|
||||||
|
```bash
|
||||||
|
./docker-install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
After launch, a menu will appear:
|
||||||
|
<!-- table -->
|
||||||
|
|
||||||
|
| Menu |
|
||||||
|
|-----------------------------|
|
||||||
|
| 1. Install Docker (rootless) |
|
||||||
|
| 2. Install Docker Compose |
|
||||||
|
| 3. Install everything |
|
||||||
|
| 4. ⚠️ Remove Docker and all related data |
|
||||||
|
|
||||||
|
Use the last option with caution!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧩 Global Installation (via `/etc/profile.d`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/scripts/docker-installer-init.sh \
|
||||||
|
-o /etc/profile.d/docker-installer-init.sh
|
||||||
|
sudo chmod +x /etc/profile.d/docker-installer-init.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
After that, every user upon terminal login will:
|
||||||
|
|
||||||
|
- Get a copy of the installer script in `~/scripts/docker-install.sh`
|
||||||
|
- See a welcome dialog
|
||||||
|
- Be able to run the installer
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔄 Auto-update
|
||||||
|
|
||||||
|
The script checks the remote `version` file and updates itself automatically if a newer version is available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧨 Uninstallation
|
||||||
|
|
||||||
|
The menu includes an option **"Remove Docker and ALL data"**, which deletes:
|
||||||
|
|
||||||
|
- Containers
|
||||||
|
- Images
|
||||||
|
- Volumes
|
||||||
|
- Rootless Docker configs
|
||||||
|
- Docker and Compose binaries
|
||||||
|
|
||||||
|
⚠️ Use with caution!
|
||||||
113
README.md
Normal file
113
README.md
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
# 🐳 Установщик Rootless Docker + Docker Compose
|
||||||
|
|
||||||
|
[](https://www.gnu.org/software/bash/)
|
||||||
|
[](https://docs.docker.com/engine/security/rootless/)
|
||||||
|
[](./LICENSE)
|
||||||
|
[](#)
|
||||||
|
|
||||||
|
Интерактивный Bash-установщик для быстрой установки **Docker в режиме Rootless**, **Docker Compose**, а также удаления всего установленного окружения.
|
||||||
|
|
||||||
|
[🇬🇧 Read in English](./README.en.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📁 Структура репозитория
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── version
|
||||||
|
│ # self-update file
|
||||||
|
└── scripts/
|
||||||
|
├── docker-install.sh # основной установщик
|
||||||
|
└── docker-installer-init.sh # загрузчик установщика (размещается в /etc/profile.d)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Зависимости
|
||||||
|
|
||||||
|
| Утилита | Назначение |
|
||||||
|
|-------------|--------------------------------|
|
||||||
|
| `curl` | Загрузка файлов по HTTP(S) |
|
||||||
|
| `bash` | Интерпретация скриптов |
|
||||||
|
| `tput` | Цветной вывод в терминале |
|
||||||
|
| `whiptail` | Диалоговое меню в терминале |
|
||||||
|
| `ncurses` | Управление курсором/цветами |
|
||||||
|
|
||||||
|
### Установка зависимостей:
|
||||||
|
|
||||||
|
#### Ubuntu / Debian:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install -y curl bash whiptail ncurses-bin
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Установка через `curl`
|
||||||
|
|
||||||
|
### Одноразовый запуск (текущий пользователь):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/docker-install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Постоянная установка:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/docker-install.sh -o ./docker-install.sh
|
||||||
|
sudo chmod +x ./docker-install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Запуск:
|
||||||
|
```bash
|
||||||
|
./docker-install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
После запуска появится меню с выбором:
|
||||||
|
<!-- table -->
|
||||||
|
|
||||||
|
| Menu |
|
||||||
|
|-------------|
|
||||||
|
| 1. Установить Docker (rootless) |
|
||||||
|
| 2. Установить Docker Compose |
|
||||||
|
| 3. Установить всё сразу |
|
||||||
|
| 4. ⚠️ Удалить Docker и все связанные данные |
|
||||||
|
Последний пункт использовать с осторожностью!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧩 Глобальная установка (через `/etc/profile.d`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo curl -fsSL https://gitea.wssk.ru/sk/docker-rootless-install/raw/branch/master/scripts/docker-installer-init.sh \
|
||||||
|
-o /etc/profile.d/docker-installer-init.sh
|
||||||
|
sudo chmod +x /etc/profile.d/docker-installer-init.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
После этого каждый пользователь при входе в терминал:
|
||||||
|
|
||||||
|
- Получит копию скрипта в `~/scripts/docker-install.sh`
|
||||||
|
- Увидит приветственное окно
|
||||||
|
- Сможет запустить установку
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔄 Автообновление
|
||||||
|
|
||||||
|
Скрипт автоматически сверяет локальную и удалённую версию (`version`) и обновляет себя при необходимости.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧨 Удаление
|
||||||
|
|
||||||
|
В меню скрипта есть опция **"Удалить Docker и ВСЕ данные"**, которая удаляет:
|
||||||
|
|
||||||
|
- Контейнеры
|
||||||
|
- Образы
|
||||||
|
- Тома
|
||||||
|
- Конфиги Docker Rootless
|
||||||
|
- Бинарники Docker и Compose
|
||||||
|
|
||||||
|
⚠️ Используйте с осторожностью!
|
||||||
Loading…
x
Reference in New Issue
Block a user