2023-11-24 08:52:49 +00:00
# DweebUI
2023-12-14 08:40:10 +00:00
DweebUI is a simple Docker web interface created using Javascript, Node.JS, and Express.
2023-11-24 08:52:49 +00:00
2023-12-19 09:22:24 +00:00
Alpha v0.09 ( :fire: Experimental :fire: )
2023-11-24 08:52:49 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/lllllllillllllillll/DweebUI )](https://github.com/lllllllillllllillll)
[![GitHub Activity ](https://img.shields.io/github/commit-activity/y/lllllllillllllillll/DweebUI )](https://github.com/lllllllillllllillll)
2023-12-14 05:26:42 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/lllllllillllllillll/dweebui )](https://hub.docker.com/repository/docker/lllllllillllllillll/dweebui)
2023-12-15 09:25:07 +00:00
[![GitHub License ](https://img.shields.io/github/license/lllllllillllllillll/DweebUI )](https://github.com/lllllllillllllillll/DweebUI/blob/main/LICENSE)
2023-12-14 05:26:42 +00:00
2023-11-24 08:52:49 +00:00
< a href = "https://raw.githubusercontent.com//lllllllillllllillll/DweebUI/main/screenshots/dashboard.png" > < img src = "https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/screenshots/dashboard.png" width = "50%" / > < / a >
< a href = "https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/screenshots/apps.png" > < img src = "https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/screenshots/apps.png" width = "50%" / > < / a >
## Features
2023-12-14 08:40:10 +00:00
* [x] Dashboard provides server metrics, container metrics, and container controls, on a single page.
* [x] View container logs.
* [ ] Update containers (planned).
2023-12-19 09:22:24 +00:00
* [ ] Manage your Docker networks, images, and volumes (in development).
2023-11-24 08:52:49 +00:00
* [x] Light/Dark Mode.
* [x] Easy to install app templates.
* [x] Multi-User built-in.
2023-12-19 09:22:24 +00:00
* [ ] Permissions system (in development).
2023-11-24 08:52:49 +00:00
* [x] Support for Windows, Linux, and MacOS.
2023-12-19 09:22:24 +00:00
* [ ] Docker compose import (in development).
2023-11-24 08:52:49 +00:00
* [x] Templates.json maintains compatability with Portainer, allowing you to use the template without needing to use DweebUI.
2023-12-14 08:40:10 +00:00
* [x] Automatically persists data in docker volumes if bind mount isn't used.
* [ ] Preset variables (planned).
2023-12-18 01:22:15 +00:00
* [ ] Proxy manager for Caddy (Disabled).
2023-12-14 08:40:10 +00:00
2023-11-24 08:52:49 +00:00
## Setup
2023-12-11 00:37:01 +00:00
Docker Compose:
2023-11-24 08:52:49 +00:00
```
2023-12-06 20:07:37 +00:00
version: "3.9"
2023-11-24 08:52:49 +00:00
services:
2023-12-06 20:07:37 +00:00
2023-11-24 08:52:49 +00:00
dweebui:
2023-12-06 20:07:37 +00:00
container_name: dweebui
2023-12-17 00:59:51 +00:00
image: lllllllillllllillll/dweebui:v0.09-dev
2023-12-11 00:37:01 +00:00
# build:
# context: .
2023-11-24 08:52:49 +00:00
environment:
NODE_ENV: production
2023-12-09 05:48:46 +00:00
PORT: 8000
2023-12-11 00:37:01 +00:00
SECRET: MrWiskers
2023-11-24 08:52:49 +00:00
restart: unless-stopped
ports:
- 8000:8000
volumes:
2023-12-09 20:49:50 +00:00
- dweebui:/app
- caddyfiles:/app/caddyfiles
2023-11-24 08:52:49 +00:00
- /var/run/docker.sock:/var/run/docker.sock
2023-12-11 00:37:01 +00:00
#- ./custom-templates.json:/app/custom-templates.json
#- ./composefiles:/app/composefiles
2023-12-06 20:07:37 +00:00
networks:
2023-12-09 20:49:50 +00:00
- dweeb_network
volumes:
dweebui:
caddyfiles:
2023-11-24 08:52:49 +00:00
2023-12-06 20:07:37 +00:00
networks:
2023-12-09 20:49:50 +00:00
dweeb_network:
2023-12-06 20:07:37 +00:00
driver: bridge
2023-11-24 08:52:49 +00:00
```
2023-12-11 00:37:01 +00:00
Compose setup:
2023-12-09 20:53:52 +00:00
2023-12-11 00:37:01 +00:00
* Paste the above content into a file named ```docker-compose.yml``` then place it in a folder named ```dweebui```.
* Open a terminal in the ```dweebui``` folder, then enter ```docker compose up -d```.
* You may need to use ```docker-compose up -d``` or execute the command as root with either ```sudo docker compose up -d``` or ```sudo docker-compose up -d```.
2023-12-09 20:49:50 +00:00
2023-12-06 20:07:37 +00:00
2023-12-11 00:37:01 +00:00
Using setup.sh:
2023-11-24 08:52:49 +00:00
```
Extract DweebUI.zip and navigate to /DweebUI
cd DweebUI
chmod +x setup.sh
sudo ./setup.sh
```
2023-12-14 08:40:10 +00:00
## Credits
2023-11-24 08:52:49 +00:00
2023-12-14 08:40:10 +00:00
* Dockerode and dockerode-compose by Apocas: https://github.com/apocas/dockerode
2023-11-24 08:52:49 +00:00
* UI was built using HTML and CSS elements from https://tabler.io/
2023-12-09 05:48:46 +00:00
* Apps template based on Portainer template provided by Lissy93: https://github.com/Lissy93/portainer-templates
2023-12-17 00:59:51 +00:00
* Icons from Walkxcode with some renames and additions: https://github.com/walkxcode/dashboard-icons
2023-12-17 20:28:58 +00:00
## Supporters
* MM (Patreon)