04. User manual

User manual

User manual is required read for administrator and operators that will use BlissRADIUS admin portal with everyday tasks like:

Basic terms

Admin portal

Web portal reachable at servers address at default port of 8800. Provides all administrator functionality for administrators only.

Client portal

Web portal with greatly reduced functionality, reachable at port 8801. All users can login there to check their user accounts. Does not provide any administrator functionality.

User

BlissRADIUS uses simplified model of user that embeds both client and administrator roles of the program. Depending of access level, they become administrators and receive extra portal functions.

Administrator

Operator or similar. User with extra privileges in BlissRADIUS web portal.

Account type

Package, users group or service type, is way defined set of service rules under which user can be authenticated and establish internet connection. Each user is member of single account type at given moment. As a rule, account types may require payments before they become active.

Payment

Simplified model that combines account type activation/extension record with monetary transaction involved. Simply put, record of money changing hands and users service activation. Each payment is tied to account type, so if user changes account types he needs new payment.

Usage records

History records describing when, how and how much user used internet connection. Holds data as date and time, MB uploaded/downloaded, time online, Calling ID/MAC/IP address associated with that session etc.

Portal access level

Each user in BlissRADIUS has his access level set to a integer value. Lowest level is 0 (no privilege) while highest is 5 (full privilege). Access level is not in any way related to RADIUS authentication, only to Admin and User portal usage. For login in to user portal minimum of level 1 is required. For admin portal, minimum is 2.

Basic rules apply no matter what:

Level descriptions:

Level 5 - Superuser

Superusers have unlimited access. Only they have access to Config section with system preferences. Only superusers can change access level for any user.

Level 4 - Admin

Admin extends privileges of Cashier/Technician and Manager. Admins have access to Admin section where they manipulate NAS-es, account types etc. Admins can't change users access level.

Level 3 - Manager

Manager extends Cashier/Technician privileges with deleting users and editing/deleting payments & reminders. That includes changing users authentication parameters.

Level 2 - Cashier/Technician

Cashier can create new users, search and edit existing. Also can search and add payments and reminders and search usage logs. Cashier can't delete users, edit or delete payments & reminders. He can't change authentication parameters or access levels for users. He has full access to Monitoring section.

Level 1 - User

User have access only to My account section. He has limited read access only to his own records. Only thing he can change is his password. This is access level used in user (not admin) portal for all (even higher privileged) users. There is one exceptions with WHMCS users logging in to BlissRADIUS client portal - they can't change their passwords or list their payment records. Those functions are accessible only by WHMCS portal.

Level 0 - Unprivileged

User can't login to admin or user portal at all.

Account types, payments and user state

Account types can be combined using multiple limiting factors:

All 3 factors can be combined. Payment will be usually required to activate users account.

These are common scenarios:

Keep in mind that user accounts have activation time which is time of last account type change (or users creation time). Only payments and usage records created after activation date will be accounted for (and if you are using duration limited accounts, only usage between payment start and stop time will be accounted).

You can manually change activation date, but be careful that payments account type must match users current account type. This, along with incorrectly configured activation time, is most common source of problems when user has valid payment but account is disabled.

2018-06-27
BlissRADIUS Embedded™ 1.6 is out with incremental improvements and new usability features.
2018-03-31
BlissRADIUS Embedded™ 1.5 is released with new proxy features and advanced caching for better resilience.
2018-03-04
BlissRADIUS Embedded™ 1.4 maintenance release is out! No significant changes, lot of small fixes. And we finally updated documentation on custom integration.
2017-12-02
BlissRADIUS Embedded™ 1.3 is released. It is incremental release with more fixes and tweaks than new features.
2017-06-05
BlissRADIUS Embedded™ 1.2 is out! It brings many performance and stability enhancements.
2016-11-05
BlissRADIUS Embedded™ 1.0 is out! This is important milestone that marks more than a year of successful production use. 1.0 is backward compatible with 0.x and brings incremental improvements and bug fixes.
2016-09-26
BlissRADIUS Embedded™ 0.9 brings integration with Blesta billing. There is also a new "local" standalone mode to run program without third-party billing. Manual has been updated accordingly.