Browse Source

Update README.md

Update to reflect new installer
pull/67/head
Weilbyte 4 years ago
committed by GitHub
parent
commit
51bf43deb9
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 20
      README.md

20
README.md

@ -10,18 +10,22 @@
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 very simple thanks to the utility. Run the following commands on the PVE node serving the Web UI and follow the on-screen instructions!
The installation is done via the CLI utility. Run the following commands on the PVE node serving the Web UI:
```
~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.py
~# python3 PVEDiscordDark.py
```
~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh
~# bash PVEDiscordDark.sh install
```
## 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.
To uninstall the theme, simply run the utility with the `uninstall` command.
## 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 help` 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.
## Notes
Thanks to [jonasled](https://github.com/jonasled) for helping out with the old version, and thanks to [SmallEngineMechanic](https://github.com/smallenginemechanic) for catching bugs for the rewrite!

Loading…
Cancel
Save