RouterOS allows slight system customization with the help of a branding package (modify default configuration, LCD logo, WebFig homepage, etc.).
This is a special system package, which you can generate from within your mikrotik.com account, in the account section "Branding maker". The resulting file will have a .dpk extension and can be installed by all the same means as an .npk package. The generated package can be installed in any RouterOS version.
To install the package in a device you simply need on a router, branding package has to upload to it and then a router has to reboot the router, you can also use Netinstall tool can be used for the same effect.
The generated package can be installed in any RouterOS version.
| Info |
|---|
Note that specific branding features are available starting from specific RouterOS versions. |
...
ASCII logo
...
Options
Options that can be configured using a branding package:
- Router name - branding package name, device identity and platform name in RouterOS, can only be one word, don't use spaces or special characters;
- Company URL - value that appears in the console when you connect to RouterOS device;
- Manual URL - documentation link, which opens with a button in WebFig;
- ASCII Logo - a text logo that is shown when logging into the command line interface, i.e. Telnet, SSH,
...
- WinBox Terminal.
...
- A logo
...
- can
...
- be created right
...
- here in the
...
- branding maker, or
...
- copied from any other plaintext editor
...
Default webpage
...
- ;
- Hide "Mikrotik" from SNMP information - MikroTik name will be hidden in SNMP information;
- Do not run script on install - do not run Default configuration script on branding package install;
- Disable "/system reset-configuration no-defaults=yes" - allows only to reset to default configuration, and it will not be possible to reset a router without configuration or in CAPs mode;
- Hide Default configuration prompt - hide Default configuration prompt after configuration reset (available starting from RouterOS 7.15)
- Hide default caps-mode-script - hide default caps-mode-script (available starting from RouterOS 7.15)
Custom files
A custom files like custom default configuration, skins, WebFig login page, etc., can be added in branding package.
- WebFig login page - customized a default RouterOS information page, which shows up when accessing the router IP address
...
- . When making the HTML file, you can use these variables:
- %version% will change to the router's current version;
- %host% will change to the router's IP address
. Use these variables in the Telnet link, or in the header - .
The file must be named "index2.html". Make sure you use properly nested HTML to make your page compatible with all browsers. You can also upload images or JavaScript files, they must reference to the same path as the index file, no custom folder names can be used
...
;
...
- WebFig logo - Router WEB page logo,
- will overwrite the original.
...
- It should be named "mikrotik_logo.png";
- \hotspot - Hotspot login page logo, the file must be named "logobottom.png";
- \skins - a skin file with name
Other values
...
- Router name: this is the Identity value in RouterOS, it can only be one word, don't use spaces or special characters there.
- Company URL: this is the value that appears in the console when you connect to your MikroTik device.
- Manual URL: documentation link which opens with a button in Webfig in the web interface.
- LCD logo: this will be displayed on devices equipped with LCD screen. Requirements for logo: no more than 160px width and no more than 72px height. CCR series have white (0xffffff) background, 2011 series have black (0x000000) background.
- Default configuration: Note that when utilizing the default configuration file, the configuration is appended during the package installation. However, after performing a system reset, only the configuration in your file will be applied. All other standard default configurations will not be used during the reset process.
The file must be in either *.txt or *.rsc format, with one RouterOS command per line. While you can use an export file from the console as a starting point, it is recommended to include only the exact commands you intend to execute.Note It is possible to reapply the factory passwords by utilizing the read-only variables $defconfPassword and $defconfWifiPassword. This configuration will be kept even after the RouterOS reset. Skins: For skins, a file - your_file_name.json must be uploaded into the "skins" directory.
...
- . To apply a particular skin to a specific user group, you don't need to log into the router to do that. You can do it with branding by uploading a Default configuration file;
- Default configuration - a RouterOS default configuration file
...
- that will override RouterOS default configuration. This configuration will be kept even after RouterOS reset. It is possible to reapply the factory passwords by utilizing the read-only variables $defconfPassword and $defconfWifiPassword (access to factory passwords is available starting RouterOS 7.10);
LCD logo - LCD logo will be displayed on devices equipped with LCD screen. A Logo size cannot be larger than 160px width and 72px height. CCR1xxx series has white (0xffffff) background, 2011 series have black (0x000000) background;
- Custom files - custom files Custom files: RouterOS also supports uploading of custom files, they
- will be simply copied into a folder named "branding" and will be accessible from within RouterOS.
- CAPs mode script - a RouterOS CAPs mode script that will override RouterOS default CAPs mode script. It is possible to reapply the factory passwords by utilizing the read-only variables $defconfPassword and $defconfWifiPassword (available starting from RouterOS 7.15).