feat: add more
This commit is contained in:
Sun-ZhenXing
15
src/dockge/.env.example
Normal file
15
src/dockge/.env.example
Normal file
@@ -0,0 +1,15 @@
|
||||
# Dockge version
|
||||
DOCKGE_VERSION="1"
|
||||
|
||||
# Port override
|
||||
PORT_OVERRIDE=5001
|
||||
|
||||
# Stacks directory on host
|
||||
STACKS_DIR="./stacks"
|
||||
|
||||
# Stacks directory inside container
|
||||
DOCKGE_STACKS_DIR="/opt/stacks"
|
||||
|
||||
# User and group IDs
|
||||
PUID=1000
|
||||
PGID=1000
|
||||
52
src/dockge/README.md
Normal file
52
src/dockge/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Dockge
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
This service deploys Dockge, a fancy, easy-to-use and reactive self-hosted docker compose stack-oriented manager.
|
||||
|
||||
## Services
|
||||
|
||||
- `dockge`: The Dockge web interface for managing Docker Compose stacks.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable Name | Description | Default Value |
|
||||
| ----------------- | ------------------------------------- | ------------- |
|
||||
| DOCKGE_VERSION | Dockge image version | `1` |
|
||||
| PORT_OVERRIDE | Host port mapping | `5001` |
|
||||
| STACKS_DIR | Directory on host for storing stacks | `./stacks` |
|
||||
| DOCKGE_STACKS_DIR | Directory inside container for stacks | `/opt/stacks` |
|
||||
| PUID | User ID to run the service | `1000` |
|
||||
| PGID | Group ID to run the service | `1000` |
|
||||
|
||||
Please modify the `.env` file as needed for your use case.
|
||||
|
||||
## Volumes
|
||||
|
||||
- `dockge_data`: A volume for storing Dockge application data.
|
||||
- Docker socket: Mounted to allow Dockge to manage Docker containers.
|
||||
- Stacks directory: Where your docker-compose.yaml files are stored.
|
||||
|
||||
## Features
|
||||
|
||||
- 🧑💼 Manage your `compose.yaml` files
|
||||
- ⌨️ Interactive Editor for `compose.yaml`
|
||||
- 🦦 Interactive Web Terminal
|
||||
- 🏪 Convert `docker run ...` commands into `compose.yaml`
|
||||
- 📙 File based structure - doesn't kidnap your compose files
|
||||
- 🚄 Reactive - Everything is just responsive
|
||||
|
||||
## Security Notes
|
||||
|
||||
- Dockge requires access to the Docker socket, which grants it full control over Docker.
|
||||
- Only run Dockge on trusted networks.
|
||||
- Consider using authentication if exposing to the internet.
|
||||
- The default setup stores data in a named volume for persistence.
|
||||
|
||||
## First Run
|
||||
|
||||
On first run, you will be prompted to create an admin account. Make sure to use a strong password.
|
||||
|
||||
## License
|
||||
|
||||
Dockge is licensed under the MIT License.
|
||||
52
src/dockge/README.zh.md
Normal file
52
src/dockge/README.zh.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Dockge
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
此服务用于部署 Dockge，一个精美、易用且响应式的自托管 Docker Compose 堆栈管理器。
|
||||
|
||||
## 服务
|
||||
|
||||
- `dockge`: Dockge Web 界面，用于管理 Docker Compose 堆栈。
|
||||
|
||||
## 环境变量
|
||||
|
||||
| 变量名 | 说明 | 默认值 |
|
||||
| ----------------- | -------------------- | ------------- |
|
||||
| DOCKGE_VERSION | Dockge 镜像版本 | `1` |
|
||||
| PORT_OVERRIDE | 主机端口映射 | `5001` |
|
||||
| STACKS_DIR | 主机上存储堆栈的目录 | `./stacks` |
|
||||
| DOCKGE_STACKS_DIR | 容器内堆栈目录 | `/opt/stacks` |
|
||||
| PUID | 运行服务的用户 ID | `1000` |
|
||||
| PGID | 运行服务的组 ID | `1000` |
|
||||
|
||||
请根据实际需求修改 `.env` 文件。
|
||||
|
||||
## 卷
|
||||
|
||||
- `dockge_data`: 用于存储 Dockge 应用程序数据的卷。
|
||||
- Docker socket: 挂载以允许 Dockge 管理 Docker 容器。
|
||||
- Stacks 目录: 存储 docker-compose.yaml 文件的位置。
|
||||
|
||||
## 功能
|
||||
|
||||
- 🧑💼 管理你的 `compose.yaml` 文件
|
||||
- ⌨️ `compose.yaml` 交互式编辑器
|
||||
- 🦦 交互式 Web 终端
|
||||
- 🏪 将 `docker run ...` 命令转换为 `compose.yaml`
|
||||
- 📙 基于文件的结构 - 不会劫持你的 compose 文件
|
||||
- 🚄 响应式 - 一切都是实时响应的
|
||||
|
||||
## 安全说明
|
||||
|
||||
- Dockge 需要访问 Docker socket，这将授予它对 Docker 的完全控制权。
|
||||
- 仅在受信任的网络上运行 Dockge。
|
||||
- 如果暴露到互联网，请考虑使用身份验证。
|
||||
- 默认设置将数据存储在命名卷中以保持持久性。
|
||||
|
||||
## 首次运行
|
||||
|
||||
首次运行时，系统会提示你创建管理员帐户。请确保使用强密码。
|
||||
|
||||
## 许可证
|
||||
|
||||
Dockge 使用 MIT 许可证授权。
|
||||
38
src/dockge/docker-compose.yaml
Normal file
38
src/dockge/docker-compose.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
x-default: &default
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- &localtime /etc/localtime:/etc/localtime:ro
|
||||
- &timezone /etc/timezone:/etc/timezone:ro
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: 100m
|
||||
|
||||
services:
|
||||
dockge:
|
||||
<<: *default
|
||||
image: louislam/dockge:${DOCKGE_VERSION:-1}
|
||||
container_name: dockge
|
||||
ports:
|
||||
- "${PORT_OVERRIDE:-5001}:5001"
|
||||
volumes:
|
||||
- *localtime
|
||||
- *timezone
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- dockge_data:/app/data
|
||||
- ${STACKS_DIR:-./stacks}:/opt/stacks
|
||||
environment:
|
||||
- DOCKGE_STACKS_DIR=${DOCKGE_STACKS_DIR:-/opt/stacks}
|
||||
- PUID=${PUID:-1000}
|
||||
- PGID=${PGID:-1000}
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: '1.0'
|
||||
memory: 512M
|
||||
reservations:
|
||||
cpus: '0.25'
|
||||
memory: 256M
|
||||
|
||||
volumes:
|
||||
dockge_data:
|
||||
Reference in New Issue
Block a user