Updated README and CHANGELOG
Connect-redis needed to be rolled back from dependabots pull request.
This commit is contained in:
lllllllillllllillll 2023-11-24 00:52:49 -08:00 committed by GitHub
parent b05b82fca8
commit 1bc322fa79
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 136 additions and 137 deletions

View file

@ -1,35 +1,43 @@
## v0.05 ( Nov 17th 2023 ) ## v0.06 ( Nov 24th 2023 )
* Environment Variables and Labels are now unchecked by default. * Multi-platform image (amd64/arm64).
* Support for Docker volumes. * Removed Caddy from compose file.
* Fixed app uninstall. * Proxy Manager UI can be enabled from environment variable.
* Fixed Proxy Manager. * Removed hardcoded redis passwords.
* Updated functions to ignore the three DweebUI containers: DweebUI, DweebCache(redis), and DweebProxy(caddy). * Repo change: Implemented image build-and-publish and dependabot (Thank you, gaby).
* Visual updates: Tabs for networks, images, and volumes. Added 'update' option in container drop-down. * Updated dependencies.
* Updated main.js to prevent javascript errors.
* Fix for templates using 'set' instead of 'default' in environment variables. ## v0.05 ( Nov 17th 2023 )
* Fixes for templates with no volumes or no labels. * Environment Variables and Labels are now unchecked by default.
* New README.md. * Support for Docker volumes.
* New screenshots. * Fixed app uninstall.
* Automatically persists data in docker volumes if there is no bind mount. * Fixed Proxy Manager.
* Updated functions to ignore the three DweebUI containers: DweebUI, DweebCache(redis), and DweebProxy(caddy).
## v0.04 (Nov 11th 2023) * Visual updates: Tabs for networks, images, and volumes. Added 'update' option in container drop-down.
* Docker Image and Compose file available. * Updated main.js to prevent javascript errors.
* The containers DweebUI and DweebCache are hidden from the dashboard. * Fix for templates using 'set' instead of 'default' in environment variables.
* Default icon for containers. * Fixes for templates with no volumes or no labels.
* Fixed missing information in container details/edit modals (Ports, Env, Volumes, Labels). * New README.md.
* New screenshots.
## v0.03 (Nov 5th 2023) * Automatically persists data in docker volumes if there is no bind mount.
* Container graphs now load instantly on refresh
* Working net data for server dashboard ## v0.04 (Nov 11th 2023)
* Redis is now installed as a docker container. * Docker Image and Compose file available.
* The containers DweebUI and DweebCache are hidden from the dashboard.
* Default icon for containers.
## v0.02 (Nov 1st 2023) * Fixed missing information in container details/edit modals (Ports, Env, Volumes, Labels).
* Significant code clean-up and improvements
* CPU and RAM graphs for each container ## v0.03 (Nov 5th 2023)
* Updated Templates.json * Container graphs now load instantly on refresh
* Fixed text color of VPN and VNC buttons * Working net data for server dashboard
* Redis is now installed as a docker container.
## v0.01 (Oct 15th 2023)
* First release. Not much working. ## v0.02 (Nov 1st 2023)
* Significant code clean-up and improvements
* CPU and RAM graphs for each container
* Updated Templates.json
* Fixed text color of VPN and VNC buttons
## v0.01 (Oct 15th 2023)
* First release. Not much working.

180
README.md
View file

@ -1,93 +1,87 @@
# DweebUI # DweebUI
DweebUI is a simple Docker web interface created with javascript and node.js DweebUI is a simple Docker web interface created with javascript and node.js
Pre-Pre-Pre-Pre-Pre Alpha v0.05 ( :fire: Experimental. Don't install on any servers you care about :fire: ) Pre-Pre-Pre-Pre-Pre Alpha v0.06 ( :fire: Experimental. Don't install on any servers you care about :fire: )
[![GitHub Stars](https://img.shields.io/github/stars/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll) [![GitHub Stars](https://img.shields.io/github/stars/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll)
[![GitHub License](https://img.shields.io/github/license/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll/DweebUI/blob/main/LICENSE) [![GitHub License](https://img.shields.io/github/license/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll/DweebUI/blob/main/LICENSE)
[![GitHub Activity](https://img.shields.io/github/commit-activity/y/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll) [![GitHub Activity](https://img.shields.io/github/commit-activity/y/lllllllillllllillll/DweebUI)](https://github.com/lllllllillllllillll)
* I haven't used Github very much and I'm still new to javascript. * I haven't used Github very much and I'm still new to javascript.
* This is the first project I've ever released and I'm sure it's full of plenty of bugs and mistakes. * This is the first project I've ever released and I'm sure it's full of plenty of bugs and mistakes.
* I probably should have waited a lot longer to share this :| * I probably should have waited a lot longer to share this :|
<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/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> <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 ## Features
* [x] Dashboard provides server metrics (cpu, ram, network, disk) and container controls on a single page. * [x] Dashboard provides server metrics (cpu, ram, network, disk) and container controls on a single page.
* [x] Light/Dark Mode. * [x] Light/Dark Mode.
* [x] Easy to install app templates. * [x] Easy to install app templates.
* [x] Automatically persists data in docker volumes if bind mount isn't used. * [x] Automatically persists data in docker volumes if bind mount isn't used.
* [x] Proxy manager for Caddy. * [x] Proxy manager for Caddy. (Optional)
* [x] Partial Portainer Template Support (Network Mode, Ports, Volumes, Enviroment Variables, Labels, Commands, Restart Policy, Nvidia Hardware Acceleration). * [x] Partial Portainer Template Support (Network Mode, Ports, Volumes, Enviroment Variables, Labels, Commands, Restart Policy, Nvidia Hardware Acceleration).
* [x] Multi-User built-in. * [x] Multi-User built-in.
* [ ] User pages: Shortcuts, Requests, Support. (planned) * [ ] User pages: Shortcuts, Requests, Support. (planned)
* [x] Support for Windows, Linux, and MacOS. * [x] Support for Windows, Linux, and MacOS.
* [ ] Import compose files. (planned) * [ ] Import compose files. (planned)
* [x] Pure javascript. No frameworks or typescript. * [x] Pure javascript. No frameworks or typescript.
* [x] Templates.json maintains compatability with Portainer, allowing you to use the template without needing to use DweebUI. * [x] Templates.json maintains compatability with Portainer, allowing you to use the template without needing to use DweebUI.
* [ ] Manage your Docker networks, images, and volumes. (planned) * [ ] Manage your Docker networks, images, and volumes. (planned)
* [ ] Preset variables. (planned) * [ ] Preset variables. (planned)
* [ ] VPN, VPS, and Firewall Toggles. (planned) * [ ] VPN, VPS, and Firewall Toggles. (planned)
* [ ] Offline Mode. (planned) * [ ] Offline Mode. (planned)
## Setup ## Setup
* Docker compose.yaml: * Docker compose.yaml:
``` ```
services: services:
  dweebui: dweebui:
    container_name: DweebUI container_name: DweebUI
    image: lllllllillllllillll/dweebui:v0.05 image: lllllllillllllillll/dweebui:v0.06
    restart: unless-stopped environment:
    ports: NODE_ENV: production
      - 8000:8000 REDIS_PASS: replace_with_password_for_redis
    depends_on: # Proxy_Manager: enabled
      - cache restart: unless-stopped
    links: ports:
      - cache - 8000:8000
    volumes: depends_on:
      - dweebui:/app - cache
      - caddy:/app/caddyfiles links:
      - /var/run/docker.sock:/var/run/docker.sock - cache
  cache: volumes:
    container_name: DweebCache - dweebui:/app
    image: redis:6.2-alpine - caddyfiles:/app/caddyfiles
    restart: always - /var/run/docker.sock:/var/run/docker.sock
    command: redis-server --save 20 1 --loglevel warning --requirepass eYVX7EwVmmxKPCDmwMtyKVge8oLd2t81 cache:
    volumes: container_name: DweebCache
      - cache:/data image: redis:6.2-alpine
  proxy: restart: always
    container_name: DweebProxy command: redis-server --save 20 1 --loglevel warning --requirepass replace_with_password_for_redis
    image: caddy:2.4.5-alpine volumes:
    depends_on: - cache:/data
      - dweebui
    restart: unless-stopped volumes:
    network_mode: host dweebui:
    volumes: cache:
      - caddy:/data caddyfiles:
      - caddy:/config ```
      - caddy:/etc/caddy
volumes: * Using setup.sh:
  dweebui: ```
  cache: Extract DweebUI.zip and navigate to /DweebUI
  caddy: cd DweebUI
``` chmod +x setup.sh
sudo ./setup.sh
* Using setup.sh: ```
```
Extract DweebUI.zip and navigate to /DweebUI
cd DweebUI ## Credit
chmod +x setup.sh
sudo ./setup.sh * UI was built using HTML and CSS elements from https://tabler.io/
``` * Apps template based on Portainer template provided by Lissy93 here: https://github.com/Lissy93/portainer-templates
* Most of the app icons were sourced from Walkxcode's dashboard icons here: https://github.com/walkxcode/dashboard-icons
## Credit
* UI was built using HTML and CSS elements from https://tabler.io/
* Apps template based on Portainer template provided by Lissy93 here: https://github.com/Lissy93/portainer-templates
* Most of the app icons were sourced from Walkxcode's dashboard icons here: https://github.com/walkxcode/dashboard-icons

13
package-lock.json generated
View file

@ -11,7 +11,7 @@
"dependencies": { "dependencies": {
"bcrypt": "^5.1.0", "bcrypt": "^5.1.0",
"child_process": "^1.0.2", "child_process": "^1.0.2",
"connect-redis": "^7.1.0", "connect-redis": "^6.1.3",
"dockerode": "^4.0.0", "dockerode": "^4.0.0",
"dockerode-compose": "^1.4.0", "dockerode-compose": "^1.4.0",
"ejs": "^3.1.9", "ejs": "^3.1.9",
@ -565,14 +565,11 @@
"integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
}, },
"node_modules/connect-redis": { "node_modules/connect-redis": {
"version": "7.1.0", "version": "6.1.3",
"resolved": "https://registry.npmjs.org/connect-redis/-/connect-redis-7.1.0.tgz", "resolved": "https://registry.npmjs.org/connect-redis/-/connect-redis-6.1.3.tgz",
"integrity": "sha512-UaqO1EirWjON2ENsyau7N5lbkrdYBpS6mYlXSeff/OYXsd6EGZ+SXSmNPoljL2PSua8fgjAEaldSA73PMZQ9Eg==", "integrity": "sha512-aaNluLlAn/3JPxRwdzw7lhvEoU6Enb+d83xnokUNhC9dktqBoawKWL+WuxinxvBLTz6q9vReTnUDnUslaz74aw==",
"engines": { "engines": {
"node": ">=16" "node": ">=12"
},
"peerDependencies": {
"express-session": ">=1"
} }
}, },
"node_modules/console-control-strings": { "node_modules/console-control-strings": {

View file

@ -8,7 +8,7 @@
"dependencies": { "dependencies": {
"bcrypt": "^5.1.0", "bcrypt": "^5.1.0",
"child_process": "^1.0.2", "child_process": "^1.0.2",
"connect-redis": "^7.1.0", "connect-redis": "^6.1.3",
"dockerode": "^4.0.0", "dockerode": "^4.0.0",
"dockerode-compose": "^1.4.0", "dockerode-compose": "^1.4.0",
"ejs": "^3.1.9", "ejs": "^3.1.9",