Changing the Appearance
From Pbxnsip Wiki
Contents |
Motivation
Many users of the pbxnsip PBX would like to change the view of the PBX in such a way, that their company logo and name is used on the web interface and the SIP messaging of the PBX.
In order to address this problem, the PBX has a web page where several customization settings can be set. By default, this page is invisible. By performing some special steps, this page can be unlocked, so that the necessary changes can be made from the web interface.
Please note that pbxnsip does not waive any copyrights on the product by providing this mechanism.
Unlocking the web page
The web page is locked when the setting "oem_lock" in the Global Configuration File is set to true. After a fresh installation this is the default. In order to unlock the web page, you need to stop the PBX, manually change the value to "false" and then restart the PBX.
Changing the Appearance
After unlocking the page, you need to log in as administrator and go to the settings/appearance web page. On this page you will see the following settings:
- Web Page Width ("web_width"): This setting controls the default width of a web page. 780 is a reasonable value, but depending on the customers PC equipment you might want to make it smaller or larger.
- Login Text ("app_login_text"): This text is displayed
- Footer Message ("app_footer"): This text is displayed on the bottom of every web page as a copyright hint. It is followed by the text "All rights reserved. See the license agreement for more information".
- Web Link ("app_link"): This link is inserted in several places of the web page. It should point to your company's web site.
- Help Link ("help_link"): This link is used for the "help" texts in the PBX. It should contain the full path to the help web page (e.g. http://help.mycompany.com/help.htm).
- Logo Link ("app_logo"): This is the relative link to the logo image on the top left of the menu navigation bar. The size of this image must be 120x30 pixels. If you want to create your own logo, create the directory "img" in the working directory of your PBX and put your logo there. Then put the path to the logo there (e.g. if you put the logo at img/my_logo.gif then the setting would be img/my_logo.gif). A template image is available right here
(use the "save as" function of the web browser to save the picture without loosing quality).
- User-Agent String ("app_user_agent"): This string is used when creating SIP messages.
When changing the settings, those settings should take effect immediately. You might have to invalidate the browser cache by pushing the reload button on the web browser. You can continue changing the settings until you are confident with the result. Then you can lock the page by changing the radio button to locked state and saving the web page.
Providing your own content
You can put your own content into the html directory. That directory does not exist in the beginning; you must create it first in the working directory of the PBX (where other directories like users, trunks, etc are). Within that directory, you may create another directory img, and in that directory you may put the images that are used. Regarding the content, the best way is to save a page (including the referenced images) and see what images and files are being loaded. If you are interested in a complete customization, you need to contact pbxnsip.
