Interface customization
HoyoShip currently has limited capabilities for customizing the user interface.
Configurations and UI settings
Section titled “Configurations and UI settings”Some settings are provided to customize the look and feel of the HoyoShip user interface.
This includes the default theme, the name of your HoyoShip instance, as well as the description that appears in HoyoShip’s homepage. A complete list of those settings can be found in the config cheat sheet:
- In the UI section and below.
- The
APP_NAMEsetting in the Overall section.
They are documented and supported to be backward compatible between versions.
Serving custom resources, logos and pages
Section titled “Serving custom resources, logos and pages”A word of warning (Here be dragons!)
Section titled “A word of warning (Here be dragons!)”Setting a custom logo for your instance, serving custom public files or modifying pages shown by HoyoShip (such as the homepage) is possible. However, they impose an additional maintenance burden on administrators and, most importantly, are unsupported.
Unsupported means that future updates are likely to break your changes without any warning.
Templates
Section titled “Templates”The most dangerous types of modifications are the ones concerning template files (.tmpl) served by HoyoShip, as HoyoShip issues backward incompatible updates to its templates very regularly.
Before deploying your changes to production or upgrading a modified HoyoShip instance, we urge that you test your custom modifications in a testing environment first.
Instructions
Section titled “Instructions”It is possible to customize HoyoShip by extracting and modifying the files of your choice using the command hoyoship embedded extract. However, this method is, for the same reasons as mentioned above, unsupported.