2024-06-09 21:28:05 +00:00
< h3 align = "center" > < img width = "150" src = "https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/public/img/logo.png" > < / h3 >
2024-05-04 22:47:24 +00:00
< h4 align = "center" > DweebUI Beta v0.60 ( :fire: Experimental :fire: )< / h4 >
2024-03-20 20:19:56 +00:00
< h3 align = "center" > Free and Open-Source WebUI For Managing Your Containers.< / h3 >
< p align = "center" >
2024-03-27 06:14:39 +00:00
< a href = "" > < img src = "https://img.shields.io/github/stars/lllllllillllllillll/DweebUI?style=flat" / > < / a >
2024-04-07 22:57:17 +00:00
< a href = "https://github.com/lllllllillllllillll/DweebUI%2Fdev" > < img src = "https://img.shields.io/github/commit-activity/y/lllllllillllllillll/DweebUI%2Fdev" / > < / a >
2024-03-31 21:37:00 +00:00
< a href = "https://github.com/lllllllillllllillll/DweebUI%2Fdev" > < img src = "https://img.shields.io/github/last-commit/lllllllillllllillll/DweebUI%2Fdev" / > < / a >
2024-03-24 21:09:53 +00:00
< a href = "https://hub.docker.com/r/lllllllillllllillll/dweebui" > < img src = "https://img.shields.io/docker/pulls/lllllllillllllillll/dweebui" / > < / a >
< a href = "https://github.com/lllllllillllllillll/DweebUI/blob/main/LICENSE" > < img src = "https://img.shields.io/github/license/lllllllillllllillll/DweebUI" / > < / a >
2024-03-20 20:19:56 +00:00
< a href = "https://www.reddit.com/r/dweebui" > < img src = "https://img.shields.io/badge/reddit-orange" / > < / a >
< a href = "https://www.buymeacoffee.com/lllllllillllllillll" > < img src = "https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee" / > < / a >
< / p >
2024-03-22 06:59:45 +00:00
< h3 align = "center" > < img width = "800" src = "https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/screenshots/dashboard1.png" > < / h3 >
2023-11-24 08:52:49 +00:00
## Features
2024-05-19 22:55:29 +00:00
2024-05-19 09:31:21 +00:00
* [x] A dynamically updating dashboard that displays server metrics along with container metrics and container controls.
* [x] Multi-user support with permissions system.
2024-05-19 22:55:29 +00:00
* [x] Container actions: Start, Stop, Pause, Restart, View Details, View Logs.
* [x] Windows, Linux, and MacOS compatable.
2023-11-24 08:52:49 +00:00
* [x] Light/Dark Mode.
2024-02-09 00:06:06 +00:00
* [x] Mobile Friendly.
2024-05-19 22:55:29 +00:00
* [x] Manage your Docker networks, images, and volumes.
2023-11-24 08:52:49 +00:00
* [x] Easy to install app templates.
2024-05-19 09:31:21 +00:00
* [x] Docker Compose Support.
2024-05-04 22:47:24 +00:00
* [ ] Update containers (planned).
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
* [ ] Preset variables (planned).
2024-02-24 16:55:47 +00:00
* [ ] Themes (planned).
2023-12-14 08:40:10 +00:00
2024-05-19 22:55:29 +00:00
## About
* I started this as a personal project to get more familiar with Javascript and Node.js, so there may be some rough edges and spaghetti code.
* I'm open to any contributions but you may want to wait until I reach v1.0 first.
* Please post issues and discussions so I know what bugs and features to focus on.
* DweebUI is a management interface and should not be directly exposed to the internet.
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:
dweebui:
2023-12-06 20:07:37 +00:00
container_name: dweebui
2024-05-04 22:47:24 +00:00
image: lllllllillllllillll/dweebui:v0.60
2023-11-24 08:52:49 +00:00
environment:
2023-12-09 05:48:46 +00:00
PORT: 8000
2023-12-11 00:37:01 +00:00
SECRET: MrWiskers
2024-03-20 20:19:56 +00:00
HTTPS: false
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
2024-02-26 23:30:38 +00:00
# Docker socket
2023-11-24 08:52:49 +00:00
- /var/run/docker.sock:/var/run/docker.sock
2024-02-26 23:30:38 +00:00
# Podman socket
#- /run/podman/podman.sock:/var/run/docker.sock
2023-12-06 20:07:37 +00:00
networks:
2024-01-08 02:29:56 +00:00
- dweebui_net
2023-12-09 20:49:50 +00:00
volumes:
dweebui:
2023-11-24 08:52:49 +00:00
2023-12-06 20:07:37 +00:00
networks:
2024-01-08 02:29:56 +00:00
dweebui_net:
2023-12-06 20:07:37 +00:00
driver: bridge
2023-11-24 08:52:49 +00:00
```
2024-06-09 08:24:27 +00:00
[Windows and MacOS Setup ](https://github.com/lllllllillllllillll/DweebUI/wiki/Setup )
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-11-24 08:52:49 +00:00
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
2024-02-23 08:41:54 +00:00
* MM (Patreon)
* PD (Buymeacoffee)