Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
mod_feature_capping.pm [2016-09-20 16:50] – [SMRadius-AutoTopup-$TYPE-NotifyTemplate] wikiadmin | mod_feature_capping.pm [2017-02-03 09:22] (current) – [SMRadius-AutoTopup-$TYPE-Threshold] nkukard | ||
---|---|---|---|
Line 2: | Line 2: | ||
Implements traffic or session time based capping defined using certain attributes that can be set at a group or user level. | Implements traffic or session time based capping defined using certain attributes that can be set at a group or user level. | ||
+ | |||
+ | ====== Config File ====== | ||
+ | |||
+ | The following section is supported in the '' | ||
+ | ===== [mod_feature_capping] ===== | ||
+ | |||
+ | ==== enable_mikrotik ==== | ||
+ | |||
+ | Enable Mikrotik specific attributes to allow better control of capping and traffic control by setting session limits. | ||
+ | < | ||
+ | enable_mikrotik=yes | ||
+ | </ | ||
+ | |||
+ | ==== caveat_captrafzero ==== | ||
+ | |||
+ | <btn type=" | ||
+ | |||
+ | Enable the captrafzero caveat. This will swap the meaning of 0 and undef on traffic capping limits. There was a logic error prior to v1.0.x. | ||
+ | < | ||
+ | caveat_captrafzero=yes | ||
+ | </ | ||
====== Attributes ====== | ====== Attributes ====== | ||
Line 12: | Line 33: | ||
Defines a maximum traffic usage allowed. This value is in Mbyte. | Defines a maximum traffic usage allowed. This value is in Mbyte. | ||
- | If unset, this value is taken as undefined which translates to 0, this means prepaid. | + | If unset, this value is unlimited. |
- | If this value is set to 0 it is taken as unlimited, or uncapped. | + | If this value is set to 0, topups must be added. |
< | < | ||
Line 24: | Line 45: | ||
Defines a maximum session time allowed. This value is in minutes. | Defines a maximum session time allowed. This value is in minutes. | ||
- | If unset, this value is taken as undefined which translates to 0, this means prepaid. | + | If unset, this value is unlimited. |
- | If this value is set to 0 it is taken as unlimited, or uncapped. | + | If this value is set to 0, topups must be added. |
< | < | ||
Line 112: | Line 133: | ||
==== SMRadius-AutoTopup-$TYPE-NotifyTemplate ==== | ==== SMRadius-AutoTopup-$TYPE-NotifyTemplate ==== | ||
- | WIP | + | The template parsing is done using [[http:// |
- | NOTE: '' | + | Supported macro's include: |
+ | * user.ID | ||
+ | * user.username | ||
+ | * usage.total | ||
+ | * usage.limit | ||
+ | * autotopup.amount | ||
+ | * autotopup.limit | ||
+ | * autotopup.added | ||
+ | * autotopup.toAdd | ||
+ | * autotopup.toAddAmount | ||
+ | |||
+ | Example below... | ||
+ | < | ||
+ | To: [% notify.target %] | ||
+ | From: Test ISP < | ||
+ | Subject: [Test ISP] Your account [% user.username %] | ||
+ | |||
+ | [% IF autotopup.toAdd %] | ||
+ | Please note that you have [% usage.limit - usage.total %]Mbyte available on username [% user.username %]. We added another [% autotopup.toAdd %] automatic topup(s) totalling [% autotopup.toAddAmount %]Mbyte to your username. Your automatic topup usage is [% autotopup.added + autotopup.toAddAmount %]Mbyte of [% autotopup.limit ? autotopup.limit : '-no-limit-' | ||
+ | [% ELSE %] | ||
+ | We cannot add another [% autotopup.amount %]Mbyte to your username as you have reached your automatic | ||
+ | [% END %] | ||
+ | |||
+ | Regards | ||
+ | Your Test ISP | ||
+ | Support: +1 555 555 555 | ||
+ | </ | ||
==== SMRadius-AutoTopup-$TYPE-Threshold ==== | ==== SMRadius-AutoTopup-$TYPE-Threshold ==== | ||
+ | |||
+ | This attribute dictates when the usage falls below this amount a topup should be added. | ||
The threshold can be set to 0, which means only when the total limit has been exceeded will an auto-topup be added. | The threshold can be set to 0, which means only when the total limit has been exceeded will an auto-topup be added. |