Browse Source

Update README.md

pull/23/head
Weilbyte 5 years ago
committed by GitHub
parent
commit
b1593d3f39
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 59
      README.md

59
README.md

@ -1,44 +1,27 @@
![](https://i.imgur.com/poWmLtK.png)
## PVEDiscordDark
PVEDiscordDark is a CSS 'theme' for the Proxmox Web UI. It was made with Discord's color scheme. Although ~99.8% (Psst, totally not a random percentage) of the Web UI has been darkened. There are some graphs that are still white because their background colors are defined in javascript, there is an experimental [feature](https://github.com/Weilbyte/PVEDiscordDark/tree/master/serverside/jsmod) to change these.
You can check the 'previews' folder in the repo to check out how some stuff look (without the JS modification)
![](https://i.imgur.com/SnlCyHF.png)
<p align="center">A dark theme for the Proxmox Web UI,<br/> *inspired by Discord's color scheme.*</p>
<p align="center">Everything is dark, including the graphs, context menus and all in between! Eyes need not be fried.</p>
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
*Can be installed two ways*:
* Server-side
* Browser Extension
**Server-side Installation:**
1. Enter your PVE **node** shell..
2. ```wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/serverside/ddInstall.sh```
3. Run ```ddInstall.sh``` with root/sudo.
4. Follow instructions given.
5. Done!
**If you want the charts/gauges and other elements to be dark mode too please look [here.](https://github.com/Weilbyte/PVEDiscordDark/tree/master/serverside/jsmod)**
**Browser Extension Installation:**
1. Download a browser extension (such as Stylish) that allows you to change CSS styles
2. Follow extension-specific instructions to add custom style. For the style content paste in the contents of this file: ```https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/discordDark.css```
3. Save style and enable it - and youre done.
## Uninstall
*Depending on how you installed it..*
**Server-side Uninstallation:**
1. Enter your PVE **node** (the one you installed the theme on) shell...
2. ```wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/serverside/ddRemove.sh```
3. Run ```ddRemove.sh``` with root/sudo.
4. Follow whatever instructions are given.
5. Done! Its gone!
**Browser Extension Uninstallation:**
*Just remove the style from the extension?*
### Disclaimers
**If youre using the installation script..**
*Make a backup of ```/usr/share/pve-manager/index.html.tpl```. The script makes one anyways but make another one just to be sure*
The installation is very simple thanks to the utility. Run the following commands on the PVE node serving the Web UI and follow the on-screen instructions!
```
~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.py
~# python3 PVEDiscordDark.py
```
## Uninstallation
To uninstall the theme, simply run the utility, and if it detects the theme installed it will give you an option to remove it.
### Updating from the old version
You will need to completely remove the old version (and revert JSMod changes). You can find the uninstall scripts and guides in the `old` branch.
*Awoo'ing on this repo is allowed.*

Loading…
Cancel
Save