Correction #9381

FreeRadius 2.X package documentation and CaptivePortal associated documentation are mostly outdated

Added by Jared Dillard 3 months ago. Updated 3 months ago.

Target version:
Start date:
Due date:
% Done:


Estimated time:
Affected Documentation:
pfSense Documentation site (Wiki)


Github user:


The FreeRadius 2.X documentation,, and its related page Captive Portal RADIUS configuration, are outdated and are giving misleading/bizzare information.

I would quote the "disconnect after Amount of Time/ Amount of Traffic" method,, which still indicate to use the controversial Stop/Start accounting method, or the full FreeRadius MySQL page, which does not give any information on how to use MySQL with the FreeRADIUS package...

FreeRadius 2.X also don't exist anymore, it has been replaced by FreeRadius3 in pfSense Packages as FreeRADIUS 2.X end of life was in 2015,

Since authentication has been recently updated on the Captive Portal, it would be nice to update the corresponding documentation pages.

I drop here some note about the stop/start accounting it may be usefull for re-write FreeRADIUS doc.

I made some research, this option has been introduced 14 years ago at m0n0wall time,, at the very begining of RADIUS accounting.

This accounting method caused many,, various,, issues since it does not correspond to the way a RADIUS server expect to recieve accounting updates. These various issues even lead to the creation of a new setting, stop/start (FreeRadius). I could not find any good usage of this accounting method. (All examples written in the documentation can now be done in a better/cleaner way)

I spent many time to understand the reason why this method had ever been implemented. The only reason i found was about to overcome the bugs of a (now deprecated) FreeRADIUS module (rlm_counter) that was not supporting accounting updates at all :

Quoting from

The rlm_counter module is just counting on accounting stop packets.
This module is used for time based accounting.
It does not work with interim-updates.

Given that :
- The counter module is now deprecated (replaced by rlm_sqlcounter) and will be removed in the next version of FreeRADIUS,
- rlm_sqlcounter does handle Accounting updates correctly
- In general, pfSense should not implement bizzare workaround to overcome bugs of another software

I would vote for completley remove this accounting method from pfSense in the future. The first step would be to stop mentioning it in the official documentation.


#1 Updated by Jared Dillard 3 months ago

  • Description updated (diff)

#2 Updated by Jared Dillard 3 months ago

Jimp commented:

I think we've had some discussion about this in the past on the forum. Since we don't support having an SQL server on the firewall, requiring the user to use SQL server counters was a problem. The current counter and scripts worked fine last time I tested them using the start/stop FreeRADIUS option I added a couple years ago.

If we can determine a way to make it all work on the current code without relying on an SQL server (sqlite maybe?) or the freeradius-specific start/stop option then I'm all for updating the docs to follow.

Keep in mind that when doing time/data limits the user will also have to have the option enabled to reauthenticate users every minute, so that when they go over the time or data limit their access can be rejected and they get kicked off.

#3 Updated by Jared Dillard 3 months ago

Github User,, commented:

Also perhaps see
I have had bugs with this for a long time now, trying all methods available.

Also available in: Atom PDF