3.2 KiB
Customizing OpenPanel Interface (Branding and White-Label)
Everything in OpenPanel is modular and can easily be modified or disabled without breaking the rest of the functionalities.
To customize OpenPanel, you have the following options:
- Enable/disable features and pages from the OpenPanel interface.
- Set pre-installed services for user.
- Localize the interface.
- Set custom branding and logo.
- Set a custom color scheme.
- Replace How-to articles with your knowledge base.
- Customize any page.
- Customize login pages.
- Add custom CSS or JS code to the interface.
- Create custom functionality and pages in the interface.
Enable/disable features
Administrators have the ability to enable or disable each feature (page) in the OpenPanel interface. To activate a feature, navigate to OpenAdmnin > Settings > OpenPanel and select service name in the "Enable Features" section and click save.
Once enabled, the feature becomes instantly available to all users, appearing in the OpenPanel interface sidebar, search results, and dashboard icons.
Set pre-installed services for user
OpenPanel uses docker images as the base for each hosting plan. Based on the docker image, different services can be set per plan/user. For examples, we provide 2 docker iamges, one that has nginx pre-installed and another that uses apache. By creating a custom docker image, you can set in that image what to be pre-installed when you create a new user, for exmaple, set mariadb instead of mysql or install php ioncube loader extension.
To add a custom service pre-installed for users:
- Create a custom docker image
- Create a new hosting plan with that docker image
- Create a new user on that plan
Localize the interface
OpenPanel is localization ready and can easily be translated into any language.
OpenPanel is shipped with the EN locale, additional locales can be installed by the Administrator.
To install additional locales (replace de-de with your locale):
opencli locale de-de
To translate OpenPanel to another language follow these steps:
- Fork this repository.
- Copy
en_usto your locale e.g.es_es - Translate the
messages.potfile - Send a pull request
Set custom branding and logo
Custom brand name and logo can be set from OpenAdmnin > Settings > OpenPanel page.
To set a custom name visible in the OpenPanel sidebar and on login pages, enter the desired name in the "Brand name" option. Alternatively, to display a logo instead, provide the URL in the "Logo image" field and save the changes.