Browse Source

Update readme with offline bundle instructions

pull/122/head
Weilbyte 3 years ago
parent
commit
4872a92e42
No known key found for this signature in database GPG Key ID: E1EB2BFCF73B5B9F
  1. 7
      README.md

7
README.md

@ -32,6 +32,13 @@ Furthermore, you will be able to provide the environment variables `REPO` and `T
`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.
## 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