An open API service indexing awesome lists of open source software.

https://github.com/bangertech/webdock

🐳 A modern web UI for managing Docker containers and services on Debian-based systems. Features SSH terminal, SFTP explorer, and automated system management.
https://github.com/bangertech/webdock

container-management docker-compose docker-gui docker-management-tool iot self-hosted smart-home system system-monitoring web-ui

Last synced: 25 days ago
JSON representation

🐳 A modern web UI for managing Docker containers and services on Debian-based systems. Features SSH terminal, SFTP explorer, and automated system management.

Awesome Lists containing this project

README

          

# webDock

![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge&logo=flask&logoColor=white)
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
[![License](https://img.shields.io/github/license/BangerTech/webDock?style=for-the-badge)](LICENSE)

![weDock Logo](images/webdock-logo.png)

> 🐳 A modern web interface for managing Docker containers and services on Debian-based systems

## Screenshots

## Table of Contents
- [What is webDock?](#what-is-webdock)
- [Setup & Requirements](#setup--requirements)
- [Usage](#usage)
- [Support / Feedback](#support--feedback)
- [Contributing](#contributing)
- [Sponsorship](#sponsorship)

## What is webDock?
webDock is a powerful tool for managing and installing software on Debian-based systems. It provides a user-friendly interface for managing Docker containers and other software solutions.

### Features
- 🚀 One-click container deployment
- 🔄 Automatic container updates
- 📊 System monitoring and statistics
- 🌙 Dark/Light theme support
- 🔧 Easy configuration management
- 📱 Responsive design
- 🖥️ SSH Terminal access
- 📁 SFTP File Explorer
- ⏰ Cron Job Editor for automated system shutdown/wakeup

### Supported Containers
1. **openHAB** - Open Home Automation Bus
2. **Home Assistant** - Open-source home automation platform
3. **HomeBridge** - HomeKit support for non-native devices
4. **RaspberryMatic** - Homematic central control unit
5. **Zigbee2MQTT** - Zigbee devices to MQTT bridge
6. **MQTT Broker** - Message broker for IoT communication
7. **Dockge** - Docker compose stack manager
8. **Portainer** - Container management UI
9. **Grafana** - Analytics and monitoring platform
10. **InfluxDB** - Time series database
11. **Code Server** - VS Code in the browser
12. **File Browser** - Web-based file manager
13. **WatchYourLAN** - Network device monitoring
14. **WhatsUpDocker** - Docker container monitoring
15. **Frontail** - Web-based log viewer
16. **Node Exporter** - Hardware and OS metrics exporter
17. **Prometheus** - Monitoring and alerting toolkit

## Technologies
- Python 3.9+
- Flask web framework
- Docker & Docker Compose
- JavaScript (ES6+)
- YAML for configuration

## Setup & Requirements
- **sudo** should be installed
- **$USER** needs to be a member of the _sudo_ group
- Add **%sudo ALL=(ALL) NOPASSWD:ALL** with _visudo_
- Docker + Docker-Compose are **required** for all container-based programs

## Usage

### For X86 Systems:
1. Navigate to your home directory:
```bash
cd $HOME
```
2. Download the setup script:
```bash
sudo wget https://raw.githubusercontent.com/BangerTech/webDock/main/setup_webui.sh
```
3. Make the script executable:
```bash
sudo chmod +x setup_webui.sh
```
4. Run the setup script:
```bash
sh setup_webui.sh
```
5. Pick a program and follow the steps presented by the tool.

## Quick Start Installation

1. Create a new directory and navigate into it:
```bash
mkdir webdock && cd webdock
```

2. Create a docker-compose.yml file with the following content:
```yaml
version: '3'
services:
webdock-ui:
image: bangertech/webdock:latest
container_name: webdock-ui
ports:
- "8585:80"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- ./data:/app/data
- ./config:/app/config
environment:
- CONFIG_DIR=/app/config
restart: unless-stopped
```

3. Start webDock:
```bash
docker compose up -d
```

4. Access webDock at http://localhost:8585

The necessary directories and configurations will be automatically created on first start.

## Support / Feedback
Any bugs or feature requests? Contact me [here](https://github.com/bangertech) or click on the "Issues" tab in the GitHub repository!

## Contributing
Fork the repository and create pull requests.

## Sponsorship

SUPPORT

## Keywords
`docker-management` `container-management` `web-ui` `docker-compose` `system-monitoring`
`home-automation` `iot` `smart-home` `monitoring` `dashboard` `debian` `raspberry-pi`
`docker-gui` `container-deployment` `devops` `self-hosted` `open-source`