PBXware 4.1.2 Site Settings

From Bicom Systems Wiki

Site Settings

snap4.1.png

Site settings set options such as site users, user groups, backup, updates and upgrades option.



Site Users

Site Users

Site users are allowed to login to the system interface in order to perform a specific function according to granted permissions. Each user belongs to a user group. Each group's permissions are pre-set in order to allow unified access and permission control.

The user can have access to any application or part of that application depending on permissions granted. It highly recommended to add/edit groups before adding new users.

Add/Edit Users

User fields are standard fields required to be entered in order for the system to allow users access to various applications. In addition users' status can be changed to "suspended" by ticking the check box and pressing "save"

Groups

snap0083.png

Groups allow for a unified permission system, enabling users access to various applications or part of the applications. The system is pre set with "common" groups: Sales, Support, Accounts and Billing, Management.

Each site can edit existing or add new groups as per their requirements by clicking on the appropriate action buttons. During add/edit, permissions and group name are available for edit.

Add new Group

Show Advanced

If this box is checked, all users belonging to this group will be able to view and edit all of the advanced options fields within the system.


Server

If this box is checked, all users belonging to this group will have administration access to the server. This allows the network administrator to delegate the administration across the organization. Reload/Start/Restart/Stop PBXware buttons are options that control PBXware actions. If enabled, these controls will be shown on the right side of the browser interface.

Sessions

After a user logs into the system, all data sent between the user and the system can be in plain text or encrypted by industry standard SSL (secure layer socket). It is worth mentioning that SSL uses much more resources hence slower browser responses.


Sessions
  • Session Type:
Session type
Example:
Available options:
  • HTTPS only - Complete data flow between the system and the GUI user is secured using SSL
  • HTTP with HTTPS authentication - Authentication is done using SSL while normal data flow between GUI user and system is plain text
  • HTTP only (including authentication) - Complete data flow between system and GUI user is plain text
(Option buttons)

Date/Time Settings

Date/Time Settings
  • Date Format:
Set the proper date format shown throughout the systems interface
(ex. 04 Oct 2006)
(Select box)
  • Time Format:
Set the proper time format shown throughout the systems interface
(ex. Select between 12/24 hour format)
(Select box)

Language

Language

Here you can choose which language you want your Site Manager to display.

Updates

Updates

This section allows a shortcut to the licensing screen. It is useful if a license upgrade needs to be performed.

  • Username:
Username used for update.
(ex. This is always pbxware, do not change this).
([a-z][0-9])
  • Password:
Password used by user for update.
(ex. This is always update, do not change this).
([a-z][0-9])
  • Version:
If you are using an older version of PBXware, this is the option where you upgrade it to newer one

Licensing

Read Getting Started->Setup Wizard->Licensing chapter.

API Key

API Key

Here you can generate a random key which is used to interface with PBXware using PBXware API. Additional info on API can be obtained by clicking on the Documentation button.

About

About

About shows Site Manager current release date present on the system.




SM Settings

SM Settings gives you the ability to add/edit system administrators and control access to GUI with IP restrictions.

Network Administrators

In this menu you can add a new GUI administrator or edit existing one.

Network Administrators
  • Name:
Name of the new admin user
(ex. John)
([a-z])
  • Email:
Email address used for admin login
(ex. john@domain.com)
([a-z] [0-9] [@_.-])
  • Password:
Password used for logging in
(ex. fjhoe5!4fh8o%e54fg_vh8)
([0-9][a-z])
  • Verify Password:
Verify given password
(ex. fjhoe5!4fh8o%e54fg_vh8)
([0-9][a-z])

IP Restrictions

The IP restrictions menu is used to set whether some IP ranges have access or are banned, which depends on selection of the Blacklist/Whitelist in the Settings menu.

Policies

Add/Edit IP restrictions policies which dictate which IP ranges can/cannot access GUI of PBXware.

Policies

When adding/editing, you will provide name and IP range for the current policy.

Policies
  • Policy Name:
Name that describes this policy
(ex. admin)
([a-z][0-9])
  • Policy Range:
IP range on which admin will or will not have access to GUI
(ex. 10.1.0.0/24)
([0-9])

Settings

Settings

Select whether set policies will be whitelisted or blacklisted which means they will be either allowed to access GUI or they will not.

Branding

Branding

Even if we have already made the branding much easier to use for customers that do not have experience with CSS editing, new interface pushed this even further, allowing customers to use a color picker to precisely define shade of color they would like to use for each of the PBXware GUI elements.

Two branding types are available:

“simple” and “advanced”. If not set in the database, branding type will automatically be pre-set to “simple”, with PBXware default values.

Advanced branding remains exactly the same as before: in order to make any CSS changes, user must edit CSS files and upload images manually. For this type of branding check our HOWTO Custom Interface Branding.

Simple branding

Before changing any settings, make sure that folder “branding” exists in the path /opt/pbxware/pw/home/sitemanager/, otherwise an error will appear stating you don’t have the right permissions, or the above folder does not exist (please test).

All CSS files, uploaded images and well as the branding configuration file will be stored in the “branding” folder.

Separate CSS files will be created for login page (login_custom.css) and all other pages (main_custom.css).

Under “Login page” section, it is possible to customize login page title and header text. All other settings refer to the site’s visual appearance (CSS).

When uploading background and logo images, pay attention to the following:

  • Supported formats are ‘jpeg’, ‘jpg’, ‘png’ and ‘gif’
  • Images larger than 50kB are not accepted
  • A dominant color is extracted from every uploaded background image and set as a background color (will appear before loading an image). For transparent or white images, a dominant color will be empty.
  • Images get overwritten upon successful upload, regardless the image type (example login_logo.png will be overwritten with login_logo.jpg) and the latest uploaded image will always be used.

A preview style is available for all elements visible on the branding page. Make sure you test hover and active element states as well.

Saving simple branding settings

When saving simple branding settings, the following files will be created:

  • Re-generated login_custom.css and main_custom.css.
  • All images you have chosen to upload (previously uploaded images will not be deleted if you do not overwrite them).
  • Configuration file simple_branding.json containing all your settings in a JSON format.

In the database, branding type will be set to “3”. (SELECT value FROM config WHERE tag = 'SM' AND name = 'BRANDING_TYPE')

Resetting branding to defaults

When using the “Reset to defaults” button, all simple branding images will be deleted, as well as the simple_branding.json configuration file. CSS files will be empty, but not deleted. Make sure you backup your settings and files before testing.

Applying branding settings to another PBXware

Once you have created your desired style:

  • Copy all files from /opt/pbxware/pw/home/sitemanager/branding to the same path on another PBXware
  • Change permissions for all files (chown 101:1003 *)
  • Navigate to SM Settings -> branding and click “Save”. Your settings should apply immediately (please test).
  • Note: It is important to refresh (or navigate to) the branding page after the files are being copied, otherwise the default values will be saved once you click the “save” button. Please check that your custom settings are loaded to the branding page (check the color pickers) before hitting the “save” button.


LDAP Settings

LDAP Integration

LDAP Settings

In latest version we implemented LDAP integration with PBXware, allowing users with Active Directory or openLDAP account to authenticate to PBXware using their LDAP credentials.

Setting LDAP Server details in PBXware

1.Login as admin and navigate to SM Settings -> LDAP Settings

2. Provide LDAP server details:

  • Host: comma-separated list of available LDAP hosts
  • Port: defaults to 389 (ldap://) or 636 (ldaps://)
  • LDAP Secured: whether the SSL connection will be used
  • Base DN: base DN you set when configuring your LDAP server (example DC=bicomsystems,DC=com)
  • Login DN: full admin DN for login into LDAP server (example: CN=admin, DC=bicomsystems, DC=com)
  • Password: admin password for LDAP server
  • Timeout: connection timeout for LDAP server, defaults to 10 (seconds)

3. Provide LDAP attribute names:

  • Login attribute: previously chosen LDAP attribute to be used as user’s login attribute
  • Group attribute: previously chosen LDAP attribute to hold user’s group ID value

4. Provide test user account details:

  • Choose one of the previously created users and provide his login and password values. An error should occur if the credentials are wrong, or the user doesn’t have a valid group ID (please test).

5. Save the configuration and use the “Test connection” button to test connection to the LDAP server before going for a login attempt. If test user credentials are not provided, only server connection and bind with admin DN will be tested, so your login and group attributes may still be incorrect.

6. Log out and login to PBXware using LDAP user credentials. LDAP user will have permissions of a group it belongs to.

Help

A click on 'Help' button opens PBXware MT online support files

Logout

Logs user out of PBXware.


Next -> 24.End Points