Dma Radius Manager
Dma Radius Manager
Dma Radius Manager
RADIUS MANAGER
BILLING SYSTEM
USER MANUAL
version 4.1
RADIUS MANAGER
VERSION 4.1
TABLE OF CONTENTS
FOREWORD..................................................................................................................................7
GENERAL DESCRIPTION............................................................................................................9
ADMINISTRATION CONTROL PANEL (ACP)............................................................................11
Getting started..........................................................................................................................11
RADIUS authentication and accounting................................................................................12
Managers...............................................................................................................................14
Service plans.........................................................................................................................14
Example services..................................................................................................................18
Prepaid card system.................................................................................................................21
Before You begin...................................................................................................................21
Setting up the card services..................................................................................................21
Generating cards...................................................................................................................21
USER CONTROL PANEL (UCP).................................................................................................25
Getting started..........................................................................................................................25
Editing personal data.............................................................................................................26
Examining the traffic report....................................................................................................26
Listing the invoices................................................................................................................26
Using the refill cards..............................................................................................................26
Selecting services..................................................................................................................26
Purchasing prepaid credits....................................................................................................27
Account activation.................................................................................................................27
Hints for setting up the UCP..................................................................................................27
ADDITIONAL FUNCTIONS.........................................................................................................29
Instant Access Services (IAS)...................................................................................................29
Self registration.........................................................................................................................32
Account verification...............................................................................................................33
Password recovery...................................................................................................................34
REFERENCE...............................................................................................................................35
ADMINISTRATION CONTROL PANEL (ACP)............................................................................37
Overview...................................................................................................................................37
Description of menus................................................................................................................37
System / Home......................................................................................................................37
System / System settings......................................................................................................37
System / Logout.....................................................................................................................40
Users / List users...................................................................................................................40
Users / List users / Edit user..................................................................................................40
Users / List users / Edit user / Traffic report..........................................................................42
Users / List users / Edit user / Connection report..................................................................42
Users / List users / Edit user / Add credits.............................................................................43
Users / List users / Edit user / Add deposit............................................................................43
Users / List users / Edit user / Postpaid billing......................................................................43
DMA Softlab LLC
Page 3
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Page 5
VERSION 4.1
RADIUS MANAGER
SMS templates..........................................................................................................................82
LEGAL NOTE..............................................................................................................................83
Page 6
RADIUS MANAGER
VERSION 4.1
FOREWORD
DMA Radius Manager is an easy to use RADIUS and DOCSIS provisioning system. It is suitable
for ISPs, Internet cafes, airports and other places where public Internet access is available. The
system is running on Linux OS, utilizing a very stable FreeRadius 2.x RADIUS server with MySQL
database backend. The integrated software components ensure high stability and reliability.
Basic features:
1.
2.
3.
4.
5.
6.
7.
8.
9.
1.
2.
3.
4.
5.
PayPal Express Checkout and Website Payments Standard work with premier and business
accounts, but PayPal Website Payments Pro requires US / UK Pro account or better.
NAS compatibility:
1. Mikrotik 2.8+. Use final releases only, RC versions are not recommended. The supported
main features are: PPPoE, PPtP, L2tP, Hotspot and Wireless Access List authentication and
accounting.
2. Chillispot running on Linux or on a DD-WRT device. You can download the tested Linux
version from our download portal.
3. StarOS v2 or v3 server. Supported features: full PPPoE and partial RADIUS Wireless Access
List support.
4. Cisco NAS. Correct IOS version is required. VPDN, BBA GROUP and Virtual template
support is necessary to accept RADIUS authenticated PPPoE, PPtP and L2tP calls.
5. pfSense Hotspot server.
Page 7
VERSION 4.1
RADIUS MANAGER
CMTS compatibility:
Both routing and bridge mode CMTS devices are supported. A partial list of supported CMTS
models:
Routing mode: Motorola BSR series, Cisco UBR series etc.
Bridge mode: Arris series etc.
Please note this is not a CMTS user manual. You can find the configuration details for your CMTS
in the manual which has been shipped with your device.
This manual consists of two main parts:
1. General description
2. Reference manual
To achieve the best results with DMA Radius Manager billing system we strongly recommend to
learn this user manual entirely.
Page 8
RADIUS MANAGER
VERSION 4.1
GENERAL DESCRIPTION
Radius Manager consists of the following main WEB interfaces:
1. ACP Administration Control Panel
2. UCP User Control Panel
There are some more WEB interfaces available in the system:
1. New user registration (self registration)
2. Purchase Instant Access Service (IAS)
3. Password recovery
The ACP is available for system administrators and resellers, while the UCP is designed for regular
users. In the UCP users can check their statistics, payments, refill the balance etc.
In the following chapters You will find detailed information about both Control Panels (CP) and extra
functions.
Page 9
VERSION 4.1
Page 10
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
You can access all system functions using the drop down menus.
Page 11
VERSION 4.1
RADIUS MANAGER
Entering correct NAS parameters is required to accept RADIUS requests from a certain NAS. Access
the NAS / New NAS menu to begin this operation.
1. Enter the NAS name, IP address, NAS type, shared secret and NAS password (only for
StarOS). Radius Manager automatically updates raddb/clients.conf. Radius Manager restarts
FreeRadius automatically upon updating any NAS in ACP. FreeRadius restart also can be forced
from Linux shell or from ACP / Tools menu.
Click the Add NAS button to store the newly defined NAS.
2. The next step is to define the service plan. Select Services / New service. Enter the name of
the service. For the most simple service enter the following parameters:
Enable service: checked
Type of the service: Prepaid regular
Data rate: 512 / 128
This defines a simple prepaid service with 512 / 128 kbps data rate (download / upload) and unlimited
traffic and time.
Click the Store service button to save the service data.
3. To register a new account select Users / New user. The required data are:
Finally press the Add user button to store the account data.
Now if You select Users / List users, You can see the newly registered account in green color. This
color code represents an active account. You will also see the name of the service assigned to user
and the current limits. In our example there are no limits set for the user.
Now configure the PPP or Hotspot service in your Mikrotik NAS and try to authenticate (PPPoE /
PPtP / Hotspot) the newly registered user. If this operation fails, You can try the default username
and password combination (user / 1111). The default user is available in every new DMA Radius
Manager installation.
If You still cant get logged in, debug the RADIUS communication enabling the FreeRadius debug
Page 12
RADIUS MANAGER
VERSION 4.1
Page 13
VERSION 4.1
RADIUS MANAGER
pfSense, it uses reauthentication instead of POD). If it is not working,You cannot enable the auto
disconnection function which will have impact on many Radius Manager features.
Managers
The system supports multiple resellers (managers). There is only one super user available in
the system (admin) while unlimited number of regular managers can be registered. The super user
cannot be deleted, while You can add, edit and delete regular managers freely.
When You add a new manager with function Managers / New manager, the following parameters
are definable: manager name, password, personal data and permissions.
Multiple resellers are useful in many situations. An example is explained below:
You have multiple NAS devices on multiple locations (different regions etc.) with one reseller in each
region. The local manager can register new account and refill account balance, but he cant delete
users and cant modify the user data. When a local manager refills an account, the action will be
logged and the super user can track the sold credits and the collected money.
Precise accounting is available for resellers: every credit and debit is trackable (in ACP / List invoices).
You can credit or debit a any manager in ACP / Manager / Edit manager form.
Service plans
One of the most complicated part of Radius Manager is the service plan system. In the service
editor You can set various properties of users. You can assign one service to multiple accounts.
You need to completely understand the structure of service plans before You can configure them
properly. Please read the following part carefully for a detailed explanation.
To define a new service select Services / New service.
Enter the name of the service.
Select the service type. The following service types are supported:
Prepaid regular Used by prepaid regular users.
Prepaid card or IAS Used by Classic Prepaid Cards and Instant Access Services (IAS). Refill
cards dont have services.
Postpaid Used by postpaid users. The billing period is freely definable, but monthly billing is
strongly recommended.
Email only When this is assigned to user, authentication is not possible (PPP / Hotspot), only a
new Linux account is created (if enabled in ACP / System settings) for storing emails, personal WEB
presentation etc.
Access list entry Special account type supporting Mikrotik and StarOS wireless access lists.
Select the correct capping type if the account requires capping:
Limit download Limits the available download Bytes.
Page 14
RADIUS MANAGER
VERSION 4.1
Download quota per day Defines the daily available download traffic.
Upload quota per day Defines the daily available upload traffic.
Total quota per day Defines the daily available total traffic.
Time quota per day Defines the daily available online time.
In service definition You can also enable the burst mode (Mikrotik only). The parameters are:
Burst limit (DL / UL) Sets the burst limit for download and upload. This is the peak traffic the
user can achieve. Burst limit is always greater or equal than the nominal data rate.
Burst threshold (DL / UL) Sets the threshold for download and upload. If the account uses
higher data rate than this value, after a predefined time the data rate will be reduced to the nominal
level.
Burst time (DL / UL) Defines the timeout after the data rate will drop if the client uses higher
data rate than the nominal. Experiment with this value. Some Mikrotik versions dont interpret the
value properly. Measure the time more times and add correction factor to it.
Priority Sets the priority for simple dynamic queue.
In the service You can also enter the IP pool name from which the user gets the IP address. Enter
the pool name which already exists in NAS (Mikrotik, Cisco). If the pool doesnt exist in NAS, the user
will not be able to authenticate (no IP address will be assigned).
Next disabled service gets activated if the account has been disabled.
Next expired service gets activated once the current service limits have been reached.
Next daily service gets activated once the daily quota has been exceeded.
The next service is useful in many situations. An example:
The user has a combined monthly service (1 GB / month) and You dont want to disable the
user in a middle of the month if he reaches the traffic limits. If You enable the Next expired service
the user can authenticate even if he has no more traffic available. The Next expired service can
force lower bandwidth or anything else You need.
Ignore static IP is used to ignore the static IP address defined in user details. Useful in next services
DMA Softlab LLC
Page 15
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Reset online time or expiration date The time will be added to the current time. It is useful for
monthly accounts where You add 1 month to the current date.
Prolong online time or expiration date It is mainly used by dialup services where a user
purchases hours. The hours will be added to the remaining hours. For example he has bought 10
hours and left him 2 hours. When he buys again 10 hours he will have totally 12 hours available.
Prolong expiration date with correction Additional mode, with exception: if the date is in the
past the new expiry will be added to the current date instead of the original date.
Define the traffic addition mode:
Reset traffic counters When You add credits the system will reset the currently available
Bytes. It is useful for monthly, traffic limited accounts. For example the user has 1 GB / month
combined plan and the account has already expired (only the date, but he has 100 MB remaining
traffic). When he next time refills his account, the 100 MB will be lost and a new 1GB / month will be
activated.
Additive New traffic will be added to the remaining traffic.
Now define the credit addition units:
Expiration date unit Date unit for adding days or months.
Online time unit Time unit for adding minutes or hours.
Download traffic unit How many MBs to add at once. For MB based services enter value 1,
while for monthly combined services enter the available monthly traffic amount. For example, if You
offer 1 GB / month, enter 1024 here.
Upload traffic unit This is the same as the download traffic unit but it defines the upload.
Total traffic unit This is the same as the download traffic unit but it defines the total traffic.
Minimal base amount The minimal base traffic what user can purchase in UCP.
Minimal additional amount Define the minimal amount of additional traffic the user can
purchase in UCP at once.
The initial fields are used to set the initial data / time for self registered users. They are also used
by the account auto renewal function.
You can select the NAS devices where the current service is available. Managers who are allowed
to use the current service are also selectable here.
The Special accounting editor is accessible from ACP / Edit service screen. In special accounting
editor You can define the accounting rate for any period. Connections are also controllable.
The Dynamic data rate editor can be invoked from ACP / edit service. It is used to change the data
rate of online session on the fly. Only Mikrotik is currently supported.
Once You have defined the new service click the Store service to save it.
Page 17
VERSION 4.1
RADIUS MANAGER
Example services
In this chapter You can find details about the most commonly used services included in the
default system installation.
Prepaid MB download A standard prepaid service. The user pays for the Internet service in
advance and he can use the Internet while he has enough MegaBytes available. When the user
consumes all the available download traffic, the online session will be terminated and cant reconnect
while he the account is not refilled. You can also combine the traffic limitats (download, upload or total
traffic).
In this service the Traffic addition mode is Additive and the Combined traffic unit is 1 MB. You
can also set the Minimal amount of MegaBytes the users can purchase at once. In this example it is
1 MB. You can increase the Minimal amount to 10 MB or enter any other value You like.
Prepaid online time This service limits the available online time. It is a classic prepaid dialup
tariff plan: the user pays in advance for the available online time. Limit online time is checked in the
service definition. When the user has no more time available he will get disconnected automatically
and cant reconnect while he hasnt purchased more time. The Time addition mode is set to Prolong
online time. The Online time unit is 1 hour. The Minimal amount is 1 hour.
Prepaid monthly This plan defines a monthly prepaid flat service. Only date capping is
enabled.
Prepaid monthly 1 GB download It is a 1 GB / month capped service. The user purchases a
monthly Internet service and gets one month and 1 GB available traffic (calculated form the date of
the purchase).
The Limit download Bytes checkbox is set. The Monthly account checkbox selects monthly
account type. In this example the Additional credits are also enabled. When a user has no more
available traffic (initially he has got 1 GB) but the account date has not expired yet, the user can
purchase additional MegaBytes while the expiration date remains unchanged.
In UCP the system handles additional credits automatically. If additional credits are enabled and the
user selects the Purchase service option in the UCP, the system will notify him about the additional
credits mode.
Managers have to select the credit addition mode manually: normal or additional mode. New
combined month can added only if the current month has expired.
Prepaid monthly plans can begin on any day in the month. Example: The client purchases a monthly
service on september 13. He has to purchase a new monthly subscription again on october 13. The
old subscription will expire at 00:00 hours on october 13.
Only one combined month can be added at once. Why? If You offer a 1 GB / month combined
service and if You set amount = 2 when You refill an account, the account will get expired after 2
months and will have 2 GB traffic. This isnt limited anymore by the end of the month. If You need
to add multiple months at once turn off the Monthly account checkbox and set Limit expiration
checkbox. Set the Time addition mode to Additive. Now You can add (prolong) the subscription
by any number of months. The Time unit should be set to 1 month. With this setup You can add
multiple months at once. If You combine this service with traffic limits depending on the setup the
traffic will be added to the remaining value or to zero.
Page 18
RADIUS MANAGER
VERSION 4.1
Usual problem is when a user forgets to refill a monthly subscription and his service expires. In the
example managers cannot add a new monthly combines service before october 13. But what to do
in the period from 00:00 to normal business hours when the office is open and users can purchase
again a new monthly service?
The solution is the Money deposit system. Managers can enter deposit for any account. Users
can purchase additional credits in UCP any time, using their internal balance. They can renew their
monthly service when the current monthly service has expired. In our example the new monthly
service can be bought after 00:00 hours on october 13.
Automatic renewal is also available for prepaid accounts. The account should has enough deposit
which covers the monthly service fee. The system handles the renewals automatically and notifies
users by email / SMS.
In our example service a separate price is defined for the base unit (the price of the monthly service)
and for the additional MegaBytes. The Time unit is 1 month, the Download traffic unit is 1000 MB.
Time addition mode is Reset time, Traffic addition mode is set to Reset traffic counters. The
Minimal amount is 1 month.
Prepaid monthly flat + quotas This is a monthly service without traffic limitation. It has 1
month validity with limited daily usage (100 MB).
Postpaid traffic A standard postpaid service. The user can use the Internet service in the
whole month. The administrator will generate bill for the previous month the first period of the currentt
month. For instance, on december 1. the administrator will generate invoices for all postpaid users
for the past period (november month). You can print the generated invoices in the WEB browser and
deliver them to customers.
Postpaid users have a grace period (ACP / System settings) to pay their invoices. The system
administrator should check the banking account every day for the realised payments and enter the
payment date into Radius Manager. To accomplish this access the List invoices / Edit invoice
function. The system checks the generated postpaid invoices every day. If the grace period has
expired and the user still hasnt paid the service, the account will be disabled.
To create a postpaid service select Postpaid mode, disable traffic and time limitations. Set the
bandwidth freely.
Set the correct Price calculation method to fit your needs. In our example it is Download traffic.
When generating invoices the system will add the price of the downloaded MegaBytes to the total
price. You can also add the price of the uploaded traffic, the used hours or combine them (e.g. 100
MB download $10,00 + 10 MB upload $1,00 = $11,00 total).
Every started MegaByte (0.1 MB etc.) is calculated as one whole MegaByte.
It is important to define the postpaid service price precisely otherwise You will generate invoices with
incorrect sums.
Postpaid online time Postpaid hours are similar to postpaid MegaBytes, but the consumed
online time is used to calculate the total price. If the user has spent 30 hours online, he will get an
invoice with total price for 30 hours. The gross price of one hour is $1,18, thus the total price for the
30 hours will be: 30 x $1,18 = $35,40. Every started hour counts as one whole hour.
Page 19
VERSION 4.1
RADIUS MANAGER
Postpaid monthly flat A standard flat service. The user can use the Internet in the whole
month without limitations. He will get the invoice with a fixed fee. You need to enable the Monthly
service checkbox.
Postpaid monthly flat + quotas It is the same flat service as the previous, but it has 100 MB
daily download limit. Dont forget to enable the Monthly service checkbox.
You can create invoices for postpaid accounts based on used traffic and online time for any period,
not only for the past month (but monthly billing is strongly recommended).
Page 20
RADIUS MANAGER
VERSION 4.1
Generating cards
Select Card system / Generate cards in the ACP to generate card series. The available
parameters are:
Card type Classic prepaid or Refill card.
DMA Softlab LLC
Page 21
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Press the Generate cards button after You have entered the required parameters. On the next page
You will see the overview of parameters. If everything is correct, press Generate cards button again.
You can list the new card serie by accessing the Card system / List card series menu.
Click the CSV link in the table to export the card codes. The output will be similar to this:
id;pin;password
000000000006; 22839965; 5264
000000000007; 49422662; 8575
DMA Softlab LLC
Page 23
VERSION 4.1
RADIUS MANAGER
Page 24
RADIUS MANAGER
VERSION 4.1
Page 25
VERSION 4.1
RADIUS MANAGER
A valid user name and password is required to log into UCP. In new installation the default user
name and password combination is: user / 1111. If the login was successful the UCP home screen
will appear.
You can find the account overview on the home screen. The data are grouped in the following
categories:
1.
2.
3.
4.
5.
General information
Personal data
Service data
Limits and quotas
WiFi details
Using the menu options the user can examine the invoices, check the traffic details, enter refill card
codes, purchase services and change the current service plan.
Selecting services
Page 26
RADIUS MANAGER
VERSION 4.1
In Radius Manager UCP the user can select a prepaid service he would like to use (if service
selection is enabled in ACP / System settings).
Click the Change service link in the menu. It will list the available prepaid services. Select the
desired service and click the Change service. On the next screen the selection should be confirmed.
If the current service is not a monthly combined service, the service change will be completed
immediately, otherwise it will be scheduled to a date when a current service expires.
Account activation
Self registered and card accounts can be forced to verify their identity with entering a secret code
in UCP, sent by in SMS to a mobile phone. The function is configurable in ACP / System settings
and in prepaid card generator module.
If an unverified user logs into UCP, a verification link will appear beside the account status. Click on
this link to initiate the account verification procedure.
Page 27
VERSION 4.1
RADIUS MANAGER
1. In ACP register an account which will never expire (username info, password info).
2. Register an info service with predefined IP pool (pool name pool-info), without capping.
3. Assign the info service to info account.
4. For pool-info define a firewall rule in your router to permit access to Radius Manager server and
block all other Internet traffic.
You can also select the info service as next master service (in all capped services) to automatically
shift the expired users to pool-info.
Page 28
RADIUS MANAGER
VERSION 4.1
ADDITIONAL FUNCTIONS
Instant Access Services (IAS)
Instant Access Services (IAS) are ideal for customers who need instant Internet access, but
dont want to register a regular account. IAS accounts are similar to prepaid cards: they have a PIN
code as username. The main advantage of IAS over the prepaid card is the simplicity: they can be
purchased online (CC, PayPal etc.), directly on the Hotspot login page.
The system currently supports the following payment gateways:
1.
2.
3.
4.
5.
6.
7.
8.
Page 29
VERSION 4.1
RADIUS MANAGER
On Mikrotik v2.9 enter the following walled garden entries for PayPal and Radius Manager server
access.
/ip hotspot walled-garden add dst-host=:^www\\.paypal\\.com\$ dst-port=443 action=allow
/ip hotspot walled-garden add dst-host=:^content\\.paypalobjects\\.com\$ dst-port=443
action=allow
/ip hotspot walled-garden add dst-host=*.akamaiedge.net action=allow
On Mikrotik v3+ the following walled garden entries are required:
/ip hotspot walled-garden add dst-host=:^www\\.paypal\\.com\$ dst-port=443 action=allow
/ip hotspot walled-garden add dst-host=:^content\\.paypalobjects\\.com\$ dst-port=443
action=allow
/ip hotspot walled-garden add dst-host=*.akamaiedge.net action=allow
The described setup is country dependent, PayPal uses different servers in different countries. For
detailed PayPal walled garden setup please visit the following page:
Page 30
RADIUS MANAGER
VERSION 4.1
https://cms.paypal.com/au/cgi-bin/?cmd=_render-content&content_ID=developer/howto_api_
golivechecklist
The URL of IAS purchase page is:
http://yourhost/radiusmanager/buyias.php
Please consult the appropriate part of the reference manual for setting up the IAS templates.
WARNING!
It is recommended to run Credit Card processing on a HTTPS layer. Install Radius Manager
system on a SSL enabled WEB server if You want to accept payments online.
Page 31
VERSION 4.1
RADIUS MANAGER
Self registration
The self registration system helps You to create a fully automated Internet Service Provider
management system. With this feature the customers can register themselves in a fully automated
way. After a successful registration they can select services and purchase credits, like regular
(manager registered) users.
The self registration link is accessible from the Hotspot login page. An example screenshot of user
name self registration is available below.
When a user enters all the required information and accepted by the system, he will get redirected to
Page 32
RADIUS MANAGER
VERSION 4.1
Account verification
Radius Manager self registration system has an advanced security measurement: email and
SMS account activation.
Radius Manager calls a HTTP / SMS gateway to send a verification code to mobile phone. PPP /
Hotspot login is disabled while user doesnt confirm the verification code.
The activation options (SMS, email) are configurable in ACP / system settings.
Page 33
VERSION 4.1
RADIUS MANAGER
Password recovery
DMA Radius Manager includes an automatized password recovery function: it delivers a password
verification code by email or SMS.
The URL of the password recovery is:
http://yourhost/radiusmanager/passwd.php
Any registered user can access the URL above. The parameters are:
User name The name of account.
New password activation method (email / SMS) Select the activation code sending method.
Email address Enter the registered email address if email verification mode has been selected.
Mobile number Enter the registered mobile number if SMS verification mode has been selected.
The number of sent SMS messages is limited.
Once the verification code has been delivered to the registered email address, the user has to click
the received URL to request a new password. In a next step the system emails the new password to
the same email address.
If SMS mode is selected and the verification code has been received, the user has to enter the
activation code on the following screen. If the entered code is valid, the system will generate and
send a new password to the same mobile number.
Page 34
RADIUS MANAGER
VERSION 4.1
REFERENCE
Page 35
VERSION 4.1
Page 36
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Description of menus
System / Home
Navigates to home page.
Page 37
VERSION 4.1
RADIUS MANAGER
Zero credits upon service change The counters will reset when a scheduled service change
occurs or the user selects a new service in UCP.
Hide limits in user list view (performance) Hide the traffic details in user list view to speed
up the listing.
Add new NAS to all services Enable all available NASs in new service.
Add new manager to all services Make the new service available for all managers.
Billing and payments:
Currency Set the default system currency.
VAT percent Define the global VAT percent.
Day to renew postpaid accounts Select a day to renew all postpaid accounts.
Beginning day of the billing period The beginning day of the monthly postpaid invoice.
Grace period Grace period for postpaid accounts. The deadline is calculated using the
following formula: invoice payment option = current date + grace period. The account will be
disabled automatically if the invoice has not been paid within the grace period.
Disable accounts due to unpaid invoices Disable RADIUS and UNIX accounts if the money
transfer has not been realized until the deadline.
Disable accounts due to expired contract Disable RADIUS and UNIX accounts if the
contract has expired.
Available payment gateways (internal / PayPal Website Payments Standard / PayPal Website
Payments Pro / PayPal Express Checkout / Netcash (Sage Pay) / Payfast / Authorize.net / DPS
Payment Express / 2Checkout) Enable the selected payment gateways.
Account settings:
Enable self registration Enable account self registration.
Name self registration requires (SMS activation / Email activation) Select the activation
method for name based self registered accounts.
Mobile self registration requires (SMS activation) Select the activation method for mobile
number based self registered accounts.
Self registration mandatory fields (first name / last name / address / city / ZIP / country / state
or province / phone / mobile / email / VAT ID) Required fields to complete the self registration.
Self registration allows (duplicate email address / duplicate mobile number) Enable duplicate
email addresses and / or mobile numbers for self registered accounts.
IAS mandatory fields (email / mobile) Select the mandatory fields for IAS pruchase.
Page 38
RADIUS MANAGER
VERSION 4.1
IAS registration allows (duplicate email address / duplicate mobile number) Enable duplicate
email addresses and / or mobile numbers for IAS accounts.
Self registration default sim-use Default sim-use value for self registered accounts.
IAS accounts require SMS verification Force SMS verification for IAS users.
Lock first seen MAC address The first detected MAC address will be locked to accounts.
Enable user data edit (UCP) Allow editing the personal details in UCP.
Enable service change (UCP) (never / only when expired / any time) Controls the service
selection in User Control Panel.
Enable password change (UCP) Enable changing the password in UCP.
Enable voucher redemption (UCP) Enable the Redeem voucher option in UCP.
Enable credit purchase (UCP) Enable the Purchase credits option in UCP.
Account synchronization
Synchronize Linux accounts If checked, the system will create / edit / delete regular Linux
accounts in sync with RADIUS users. This feature is useful if You want to synchronize a Linux
account based email server (sendmail, postfix etc.) with Radius Manager.
Disk quota management If checked, the disk quota will be set automatically for newly
registered Linux users (prerequisites are to enable the disk quotas and create the disk quota
template Linux user).
Disk quota template user The name of the Linux disk quota template user.
Synchronize account on (Localhost / Remote host using RSH) Remote Linux host
synchronization method.
Remote Linux host IP address or DNS name of remote host.
Notifications:
Notify manager upon self registration (email) New user registration notifications are sent
to system administrator.
Welcome message (email) Send welcome email to new users.
Welcome message (SMS) Send welcome SMS to new users.
New service activated (email) Send email when a new service has been activated.
Account renewal notification (email) Sending email when an account has been renewed.
Account expiry (email) Sending email alert to user when the account is going to expire.
Account expiry (SMS) Sending SMS alert to user when the account is going to expire.
DMA Softlab LLC
Page 39
VERSION 4.1
RADIUS MANAGER
System / Logout
Log out the current user.
Page 40
RADIUS MANAGER
VERSION 4.1
Page 41
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Page 43
VERSION 4.1
RADIUS MANAGER
C Cash payment
T Bank transfer
O Online payment
I Internal transfer
P - Prepaid card
You can also view the internal balance, the remaining traffic and time. The total transactions are
calculated using the following formula:
TOTAL TRANSACTIONS = COMPLETED TRANSACTIONS + PENDING TRANSACTIONS
Internal transactions are not included in the sum. Credit refills with cards are not included in the
sum.
RADIUS MANAGER
VERSION 4.1
Page 45
VERSION 4.1
RADIUS MANAGER
Page 46
RADIUS MANAGER
VERSION 4.1
Some WLAN devices (depending on the configuration see MAC cloning) will not emit the real MAC
address of the WLAN card. You have to configure the CPE properly in order to use this feature.
Allow this MAC only Enable MAC address checking.
IP address mode CPE (NAS pool or DHCP / IP pool / static IP) CPE IP address mode. The
address will be determined automatically if NAS pool or DHCP is selected. In IP pool mode RADIUS
server assigns the IP address to CPE, using the RADIUS IP pools. When Static IP is selected the
predefined static IP address will be assigned to CPE.
The MAC address should be set in order to use the DOCSIS CPE static IP mode.
Simultaneous use How many concurrent sessions are allowed for the current user (simultaneous
logins with a same user name). Leave this field empty or enter 0 for unlimited number of concurrent
sessions.
First name First name of the user.
Last (family) name Last (family) name of the user.
Company name Company name.
Address Postal address of the user.
City City of the user.
ZIP ZIP code of the user.
Country Country of the user.
State State of the user.
Phone number Phone number of the user.
Mobile number Mobile number of the user.
Email address Email address for notifications. If You dont specify the email address, the system
will construct it automatically: [username]@[domain], where domain is defined in system_cfg.php
and in radiusmanager.cfg.
VAT ID VAT number.
Service Associated service name.
Download limit The available download Bytes.
Upload limit The available upload Bytes.
Total limit The available total Bytes (DL + UL).
Account expiry Account expiration date (YYYY-MM-DD).
Available online time Available online time (HH:MM:SS).
DMA Softlab LLC
Page 47
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Disable Disable the selected services. Disabled services are not listed in service selectors.
Delete Delete the selected services. The default service cannot be deleted. If an already assigned
service has been deleted, the default service will be assigned instead of it.
Page 49
VERSION 4.1
RADIUS MANAGER
Enable burst mode Check this option to enable the burst mode.
Burst limit (DL / UL) Burst limit for download and upload. This is the peak data rate the user
can achieve. Burst limit is always greater or equal than the nominal data rate.
Burst threshold (DL / UL) Threshold for download and upload. If the user exceeds this limit for
a predefined time, the data rate will be reduced to the nominal value (as set in Data rate). Enter
higher burst limit than the nominal data rate.
Burst time (DL / UL) Timeout after the limitation will begin if the client exceeds the threshold.
Priority Priority of packets.
IP pool name Select a specified IP pool via Framed-Pool RADIUS attribute. It is a Mikrotik
and Cisco specific feature.
Next disabled service Next service to use with disabled accounts.
Next expired service Selector for next expired service. It is activated if the master service
has expired.
It is very useful if a user account has expired, but You want to grant Internet access on reduced
data rate. Register a new, uncapped service with reduced data rate and select it from this
dropdown list.
Next daily service Selector for next daily service. Exceeding the daily quota activates the next
daily service.
Ignore static IP Ignore the static CPE IP assigned in Edit user form.
Custom RADIUS attributes User definable RADIUS attributes. The system sends custom
attributes in Access-accept message.
Generate TFTP boot file Generate DOCSIS compliant TFTP boot file. The TFTP file template
is located in config directory.
Advanced CM configuration Custom TFTP boot file.
Allowed NASs The service is available on the select NAS devices only.
Available for managers The service is available for the selected managers only.
Price definitions:
Postpaid price calculation (downloaded traffic / uploaded traffic / online time) Select the
traffic and / or time used in price calculation.
Monthly account Enable monthly account mode. It is required for auto renewal.
Automatic renewal Enable automatic account renewal (required by both prepaid and postpaid
mode).
Page 50
RADIUS MANAGER
VERSION 4.1
Postpaid monthly accounts are renewed on a specific day. The day is selectable in ACP /
System settings.
Prepaid monthly accounts are checked every day at midnight and renewed if:
1. The account is expired
2. The account has enough deposit to cover the service renewal fee
Carry over remaining MBs Do not reset the the traffic counters upon auto renewal.
Reset counters if date has expired Add new credits to zero balance if an account has been
expired (date) .
Enable additional credits Enables additional credit mode for monthly accounts.
Net unit price The price of one unit without VAT.
Gross unit price The price of one unit with VAT.
Net additional unit price This filed is used by monthly accounts. Users can purchase
additional credits if the date is expired, but the account has no more available traffic left. VAT is
not included.
Gross additional unit price Same as Net additional price, but with added VAT.
Date addition mode (reset expiration date / prolong expiration date / prolong expiration date
with correction) Determines how to add days to an account. Reset expiration date always
adds new days or months to the current date. It is used mainly by combined packages (1 month
+ x MB). Prolong expiration date adds days to the current expiration date. Prolong expiration
date with correction adds days to the current expiration date as available in the user profile, but
it will use the current date if expiration date is in the past.
Time addition mode (reset online time / prolong online time) Select how to add online time for
an account: always add to zero or add to remaining value.
Traffic addition mode (reset traffic counters / additive) Select how to add traffic for an account:
always add to zero or add to remaining value.
Expiration date unit (days / months) Defines the amount of one date unit (days or months).
Online time unit (minutes / hours) Defines the amount of one time unit.
Download traffic unit Defines the amount of one download traffic unit.
Upload traffic unit Defines the amount of one upload traffic unit.
Total traffic unit Defines the amount of one total traffic unit (download + upload).
Initial expiration date Defines the initial expiration. Used by self registration and auto
renewal.
Initial online time amount Defines the initial online time. Used by self registration and auto
renewal.
DMA Softlab LLC
Page 51
VERSION 4.1
RADIUS MANAGER
Initial download traffic amount Defines the initial download traffic. Used by self registration
and auto renewal.
Initial upload traffic amount Defines the initial upload traffic users. Used by self registration
and auto renewal.
Initial total traffic amount Defines the initial total traffic.Used by self registration and auto
renewal.
Minimal base amount Defines the minimal base amount what users can purchase.
Additional traffic unit Defines the additional traffic unit in MB.
Minimal additional amount Defines the minimal additional amount what users can
purchase.
Special accounting and dynamic data rates are also available in the service plan. You can
click the Edit link to invoke the appropriate editor.
Use the Delete service to delete the current service.
Page 52
RADIUS MANAGER
VERSION 4.1
Here You can define the start and end time of the interval, the data rate (download, upload) and the
burst mode. You can also select days of week for the current interval.
Click the update button to store the changes.
In the next paragraph You will find detailed description how to configure the Mikrotik API in order to
use the special data rate system.
Configuring the Mikrotik API
Use Winbox to configure the API service in Mikrotik.
Enable the API service in Mikrotik (IP / Services, port 8728).
Register the API user in Mikrotik (user name api is recommended) . Radius Manager will use
this user to log into Mikrotik to change the data rate on the fly.
Enter the same user name and password in ACP / Edit NAS and enable the API.
If API is enabled and configured properly, You will see in the Winbox log how the API user logs in and
out in every 1-5 minutes (depending on radiusmanager.cfg).
API is available in Mikrotik v 3 or newer versions. Older versions are not capable of controlling the
data rate on the fly.
Page 53
VERSION 4.1
RADIUS MANAGER
Page 54
RADIUS MANAGER
VERSION 4.1
Next daily service Selector for next daily service. Exceeding the daily quota activates the next
daily service.
Ignore static IP Ignore the static CPE IP assigned in Edit user form.
Custom RADIUS attributes User definable RADIUS attributes. The system sends custom
attributes in Access-accept message.
Generate TFTP boot file Generate DOCSIS compliant TFTP boot file. The TFTP file template
is located in config directory.
Advanced CM configuration Custom TFTP boot file.
Allowed NASs The service is available on the select NAS devices only.
Available for managers The service is available for the selected managers only.
Price definitions:
Postpaid price calculation (downloaded traffic / uploaded traffic / online time) Select the
traffic and / or time used in price calculation.
Monthly account Enable monthly account mode. It is required for auto renewal.
Automatic renewal Enable automatic account renewal (required by both prepaid and postpaid
mode).
Postpaid monthly accounts are renewed on a specific day. The day is selectable in ACP /
System settings.
Prepaid monthly accounts are checked every day at midnight and renewed if:
1. The account is expired
2. The account has enough deposit to cover the service renewal fee
Carry over remaining MBs Do not reset the the traffic counters upon auto renewal.
Reset counters if date has expired Add new credits to zero balance if an account has been
expired (date) .
Enable additional credits Enables additional credit mode for monthly accounts.
Net unit price The price of one unit without VAT.
Gross unit price The price of one unit with VAT.
Net additional unit price This filed is used by monthly accounts. Users can purchase
additional credits if the date is expired, but the account has no more available traffic left. VAT is
not included.
Gross additional unit price Same as Net additional price, but with added VAT.
Page 55
VERSION 4.1
RADIUS MANAGER
Date addition mode (reset expiration date / prolong expiration date / prolong expiration date
with correction) Determines how to add days to an account. Reset expiration date always
adds new days or months to the current date. It is used mainly by combined packages (1 month
+ x MB). Prolong expiration date adds days to the current expiration date. Prolong expiration
date with correction adds days to the current expiration date as available in the user profile, but
it will use the current date if expiration date is in the past.
Time addition mode (reset online time / prolong online time) Select how to add online time for
an account: always add to zero or add to remaining value.
Traffic addition mode (reset traffic counters / additive) Select how to add traffic for an account:
always add to zero or add to remaining value.
Expiration date unit (days / months) Defines the amount of one date unit (days or months).
Online time unit (minutes / hours) Defines the amount of one time unit.
Download traffic unit Defines the amount of one download traffic unit.
Upload traffic unit Defines the amount of one upload traffic unit.
Total traffic unit Defines the amount of one total traffic unit (download + upload).
Initial expiration date Defines the initial expiration. Used by self registration and auto
renewal.
Initial online time amount Defines the initial online time. Used by self registration and auto
renewal.
Initial download traffic amount Defines the initial download traffic. Used by self registration
and auto renewal.
Initial upload traffic amount Defines the initial upload traffic users. Used by self registration
and auto renewal.
Initial total traffic amount Defines the initial total traffic.Used by self registration and auto
renewal.
Minimal base amount Defines the minimal base amount what users can purchase.
Additional traffic unit Defines the additional traffic unit in MB.
Minimal additional amount Defines the minimal additional amount what users can
purchase.
Page 56
RADIUS MANAGER
VERSION 4.1
Page 57
VERSION 4.1
RADIUS MANAGER
Card system and IAS Can access prepaid card and IAS system.
Connection report Can access CTS functions.
Overall traffic report Can access traffic report.
Maintain APs Can access AP functions.
RADIUS MANAGER
VERSION 4.1
Available balance The balance of current manager. This field is read only.
Amount Enter the amount to credit or debit the manager.
Payment type (cash / bank transfer) Select the payment type.
Page 59
VERSION 4.1
RADIUS MANAGER
Edit privileged user data Allows editing privileged fields (credits, static IP).
Delete users Can delete users.
Card system and IAS Can access prepaid card and IAS system.
Connection report Can access CTS functions.
Overall traffic report Can access traffic report.
Maintain APs Can access AP functions.
Click the Add manager button to store the new manager data.
RADIUS MANAGER
VERSION 4.1
Page 61
VERSION 4.1
RADIUS MANAGER
Enable Enable the AP. The system reads information from an active AP only (SNMP or API).
Name Enter the name of the AP.
IP address Enter the IP address of the AP.
Access mode (SNMP / Mikrotik API) Select the access mode. SNMP supports only wireless
signal level, but the access is more stable and faster than Mikrotik API. Mikrotik API supports
wireless signal level, CCQ and SNR, but the setup is complicated. The recommended access
mode is SNMP.
SNMP community Enter the SNMP community string as defined in the AP. Required by SNMP
mode.
API username Enter the Mikrotik API user name. Required by Mikrotik API mode.
API password Enter the Mikrotik API password. Required by Mikrotik API mode.
Description Optional description.
Page 62
RADIUS MANAGER
VERSION 4.1
Page 63
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Page 65
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
User group The generated cards will belong to the selected group.
Associated service Select the service used by the generated classic prepaid cards.
Download limit Download limit for classic prepaid cards.
Upload limit Upload limit for classic prepaid cards.
Total limit Total traffic limit for classic prepaid cards.
Online time limit Online time limit for classic prepaid cards.
Expiration (Defined by valid till / Calculated from card activation) Select the account expiration
mode. If Defined by valid till is selected, the account will expire on the date specified by the Valid
till field. If You choose Calculated from card activation, the generated cards will expire after a
predefined time which is calculated from the first use of the card.
Available time from card activation Sets the time amount for Calculated from card activation
option.
Simultaneous use Defines how many concurrent connections are allowed for a certain Classic
prepaid card. For regular use enter 1. Enter 2 if You are using pfSense, otherwise the reauthentication
function will not work.
Page 67
VERSION 4.1
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
account. For regular use enter 1. Enter 2 if You are using pfSense, otherwise the reauthentication
function will not work.
Page 69
VERSION 4.1
RADIUS MANAGER
Page 70
RADIUS MANAGER
VERSION 4.1
Page 71
VERSION 4.1
RADIUS MANAGER
Page 72
RADIUS MANAGER
VERSION 4.1
Page 73
VERSION 4.1
Page 74
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Description of menus
Home
Navigate to home page. An account overview is available here.
Traffic report
Users can check their traffic details in a well organized form.
List invoices
Users can examine the invoices.
Change password
With this function users can change the password (both UCP and Internet access). They have to
enter the old password and the new password two times to complete the operation.
Redeem voucher
Users can enter the refill card PIN code to increase the internal balance. After three unsuccessful
attempts the system disables the function.
Purchase credits
Users can purchase credits with internal balance or any available online payment gateway. Clicking
the Purchase service the system will show the current service details. The users have to enter the
amount of units and click the Next button.
After selecting the payment mode and completing the order the system updates the account balance
DMA Softlab LLC
Page 75
VERSION 4.1
RADIUS MANAGER
immediately. The new credit data will be available on the home page.
Monthly combined accounts are special case: only one combined month can be purchased at
once. If a monthly combined account has not expired yet (date), users can purchase additional
MegaBytes only.
Change service
Users can choose which prepaid service to use. They can select a new service form the list. After
confirmation the system will change the service immediately.
Edit account
With this function users can edit their personal details (if enabled in ACP / System settings). The
available fields are:
First name First name of the user.
Last (family) name Last name of the user.
Address Address of the user.
City City of the user.
ZIP ZIP code of the user.
Country Country of the user.
State State of the user.
Phone Phone number.
Mobile Mobile number.
Email Email address.
Company Company name.
VAT id VAT identification number.
Language Select the used language.
Logout
Logs out the current user from the UCP.
Page 76
RADIUS MANAGER
VERSION 4.1
Page 77
VERSION 4.1
Page 78
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
APPENDICES
Page 79
VERSION 4.1
Page 80
RADIUS MANAGER
RADIUS MANAGER
VERSION 4.1
Page 81
VERSION 4.1
RADIUS MANAGER
Email templates
Radius Manager can send various email notifications for users and managers. The messages
are sent in plain text format, HTML is not supported. The following email templates are available in
lang directory:
mailaccrenewed_tpl.txt The user receives this email after his account has been renewed.
mailaccrenewfail_tpl.txt The user receives this email after an unsuccessful auto renewal.
mailaccverify_tpl.txt This template is used for account activation.
mailforgotpsw_tpl.txt Verification email for password recovery.
mailiasreg_tpl.txt Sent for managers when a new IAS account has been registered.
mailnewpsw_tpl.txt Email message containing the new password.
mailselfreg_tpl.txt Notifies managers about new self registered accounts.
mailsrvchg_tpl.txt This email is sent upon changing the current service.
mailwarnexp_tpl.txt Alert message sent when an account is going to expire (date).
mailwarntraff_tpl.txt Alert message sent when an account is going to expire (traffic, online
time).
mailwelcomeuser_tpl.txt Welcome message for new users.
You can customize the templates with any UTF-8 compatible text editor.
SMS templates
Radius Manager can send various SMS notifications for users. The messages are sent in plain
text format. The following SMS templates are available in lang directory:
smsaccverify_tpl.txt Template used for account activation.
smspsw_tpl.txt SMS message containing the new password.
smspswact_tpl.txt Verification SMS for password recovery.
smsselfregact_tpl.txt Self registered account activation code.
smswarnexp_tpl.txt Alert message sent when an account is going to expire (date).
smswarntraff_tpl.txt Alert message sent when an account is going to expire (traffic, online
time).
smswelcomeuser_tpl.txt Welcome message for new users.
You can customize the templates with any UTF-8 compatible text editor.
Page 82
RADIUS MANAGER
VERSION 4.1
LEGAL NOTE
Radius Manager software and trademark are Copyright DMA Softlab LLC. All right reserved.
ionCube is Copyright ionCube Ltd.
MikroTik is a registered trademark of MikroTikls corporation.
FreeRadius is Copyright The FreeRADIUS server project. Licensed under GPL.
Chillispot is Copyright Mondru AB. Licensed under GPL.
StarOS is a trademark of Valemount Networks Corporation.
MySql is released under the GNU General Public License.
Cisco is a trademark of Cisco Systems, Inc.
Page 83