/PVEDiscordDark

A Discord-like dark theme for the Proxmox Web UI.

Primary LanguageSassMIT LicenseMIT

A dark theme for the Proxmox Web UI,
inspired by Discord's color scheme.

Everything is dark, including the graphs, context menus and all in between! Eyes need not be fried.

The theme now runs its own JavaScript code which patches the colors for certain components (and charts). This approach is much better, and safer than what was used previously.

Installation

The installation is done via the CLI utility. Run the following commands on the PVE node serving the Web UI: Clearing browser cache is necessary to see the changes.

~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh
~# bash PVEDiscordDark.sh install

Or this oneliner

bash <(curl -s https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh ) install

Note that you will need to run the install command every time pve-manager is updated (i.e. after every Proxmox update)

Uninstallation

To uninstall the theme, simply run the utility with the uninstall command. Clearing browser cache is necessary to see the changes.

Installer & Security

The new installer relies on the /meta/supported and /meta/imagelist files being present in the repository. It also includes a silent mode. Run bash PVEDiscordDark.sh -h for usage instructions.

Furthermore, you will be able to provide the environment variables REPO and TAG to specify from what repository and from what commit tag to install the theme from.
REPO is in format Username/Repository and defaults to Weilbyte/PVEDiscordDark (this repository).
TAG defaults to master, but it is strongly recommended to use the SHA-1 commit hash for security.

Offline bundle

If desired, the installation utility can be run offline. Upon detecting a folder called offline in the current working directory, the script will enter offline mode and use the resources within that folder instead of retrieving them from GitHub.

The offline folder must have the following files: meta/[imagelist, supported], PVEDiscordDark/images/*, PVEDiscordDark/js/PVEDiscordDark.js, PVEDiscordDark/sass/PVEDiscordDark.css

You can find a zip containing the installer and offline folder under the artifact section of the GitHub Actions under this repository or as an asset attached to releases.

Contributors

Thanks to everybody who contributed to this project, and additional thanks to Crinisus for catching bugs for the rewrite!

Awoo'ing on this repo is encouraged.