96 lines
4.2 KiB
Markdown
96 lines
4.2 KiB
Markdown
<h3 align="center"><img width="150" src="https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/public/img/logo.png"></h3>
|
|
<h4 align="center">DweebUI Beta v0.60 ( :fire: Experimental :fire: )</h4>
|
|
<h3 align="center">Free and Open-Source WebUI For Managing Your Containers.</h3>
|
|
<p align="center">
|
|
<a href=""><img src="https://img.shields.io/github/stars/lllllllillllllillll/DweebUI?style=flat"/></a>
|
|
<a href="https://github.com/lllllllillllllillll/DweebUI%2Fdev"><img src="https://img.shields.io/github/commit-activity/y/lllllllillllllillll/DweebUI%2Fdev"/></a>
|
|
<a href="https://github.com/lllllllillllllillll/DweebUI%2Fdev"><img src="https://img.shields.io/github/last-commit/lllllllillllllillll/DweebUI%2Fdev"/></a>
|
|
<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>
|
|
<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>
|
|
<h3 align="center"><img width="800" src="https://raw.githubusercontent.com/lllllllillllllillll/DweebUI/main/screenshots/dashboard1.png"></h3>
|
|
|
|
## Features
|
|
|
|
* [x] A dynamically updating dashboard that displays server metrics along with container metrics and container controls.
|
|
* [x] Multi-user support with permissions system.
|
|
* [x] Container actions: Start, Stop, Pause, Restart, View Details, View Logs.
|
|
* [x] Windows, Linux, and MacOS compatable.
|
|
* [x] Light/Dark Mode.
|
|
* [x] Mobile Friendly.
|
|
* [x] Manage your Docker networks, images, and volumes.
|
|
* [x] Easy to install app templates.
|
|
* [x] Docker Compose Support.
|
|
* [ ] Update containers (planned).
|
|
* [x] Templates.json maintains compatability with Portainer, allowing you to use the template without needing to use DweebUI.
|
|
* [ ] Preset variables (planned).
|
|
* [ ] Themes (planned).
|
|
|
|
## 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.
|
|
|
|
## Setup
|
|
|
|
Docker Compose:
|
|
```
|
|
version: "3.9"
|
|
services:
|
|
dweebui:
|
|
container_name: dweebui
|
|
image: lllllllillllllillll/dweebui
|
|
environment:
|
|
PORT: 8000
|
|
SECRET: MrWiskers
|
|
restart: unless-stopped
|
|
ports:
|
|
- 8000:8000
|
|
volumes:
|
|
- dweebui:/app
|
|
# Docker socket
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
# Podman socket
|
|
#- /run/podman/podman.sock:/var/run/docker.sock
|
|
|
|
networks:
|
|
- dweebui_net
|
|
|
|
volumes:
|
|
dweebui:
|
|
|
|
networks:
|
|
dweebui_net:
|
|
driver: bridge
|
|
```
|
|
|
|
[Windows and MacOS Setup](https://github.com/lllllllillllllillll/DweebUI/wiki/Setup)
|
|
|
|
Compose setup:
|
|
|
|
* 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```.
|
|
|
|
Configuration:
|
|
|
|
* `PORT` - Specifies which port the service binds to on startup. Default is `8000`.
|
|
* `SECRET` - A shared secret used by the registration page.
|
|
|
|
## Credits
|
|
|
|
* Dockerode and dockerode-compose by Apocas: https://github.com/apocas/dockerode
|
|
* UI was built using HTML and CSS elements from https://tabler.io/
|
|
* Apps template based on Portainer template provided by Lissy93: https://github.com/Lissy93/portainer-templates
|
|
* Icons from Walkxcode with some renames and additions: https://github.com/walkxcode/dashboard-icons
|
|
|
|
|
|
## Supporters
|
|
|
|
* MM (Patreon)
|
|
* PD (Buymeacoffee)
|