RADIUSdesk

logo
Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
technical:ppp-pppoe-rd-support [2023/11/07 07:03]
admin [Servers] 		technical:ppp-pppoe-rd-support [2023/11/07 22:44] (current)
admin
Line 1: Line 1:
-====== Acell-ppp Support in RADIUSdesk ======+====== Accel-ppp Support in RADIUSdesk ======
 ===== Introduction ===== ===== Introduction =====
   * As of November 2023, RADIUSdesk can centrally manage Accel-ppp on Ubuntu and Raspberry Pi based devices.   * As of November 2023, RADIUSdesk can centrally manage Accel-ppp on Ubuntu and Raspberry Pi based devices.
Line 15: Line 15:
         * The **New Arrivals** lists Accel-ppp servers which reported to RADIUSdesk but which require on-boarding.         * The **New Arrivals** lists Accel-ppp servers which reported to RADIUSdesk but which require on-boarding.
 ==== Profiles ==== ==== Profiles ====
 +  * We will cover Profiles first although it is the second sub-tab since it is required to have a profile ready in order to define a server.
   * Profiles are used to manage the major part of the settings which will be applied to a server.   * Profiles are used to manage the major part of the settings which will be applied to a server.
   * Settings are dynamically formulated in the reply when the RADISUdesk Accel-ppp agent contacts RADIUSdesk.   * Settings are dynamically formulated in the reply when the RADISUdesk Accel-ppp agent contacts RADIUSdesk.
-  * The settings for each Acell-ppp server can be divided into three categories.+  * The settings for each Accel-ppp server can be divided into three categories.
         * **Common** settings which hardly differ between servers. (This is the bulk of them)         * **Common** settings which hardly differ between servers. (This is the bulk of them)
         * **Unique** settings which you might want to tweak should the need arise.         * **Unique** settings which you might want to tweak should the need arise.
-        * **Specific** settings which are required to differentiate one Acell-ppp server from another.+        * **Specific** settings which are required to differentiate one Accel-ppp server from another.
 === Common Settings (Base Configs) === === Common Settings (Base Configs) ===
   * Common settings are stored inside a CakePHP config file. (///var/www/rdcore/cake4/rd_cake/config/AccelPresets.php//)   * Common settings are stored inside a CakePHP config file. (///var/www/rdcore/cake4/rd_cake/config/AccelPresets.php//)
  
   * One can define various sets of these common settings, giving each a **unique name**.   * One can define various sets of these common settings, giving each a **unique name**.
 +<code php>
 +<?php
 +//Default settings for accel-ppp
 +
 +$config['AccelPresets']['Default'] = [
 +
 +    'modules'   => [
 +        'log_file',
 +        'pppoe',
 +        'auth_pap',
 +        'radius',
 +        'ippool',
 +        'shaper',   
 +    ],  
 +    'core'      => [
 +        'log-error' => '/var/log/accel-ppp/core.log',
 +        'thread-count'  => 4,
 +    ],
 +</code>
   * We refer to them as **Base Configs**.   * We refer to them as **Base Configs**.
   * There is one already called **Default**.   * There is one already called **Default**.
Line 53: Line 73:
   * Each server has the following mandatory fields.   * Each server has the following mandatory fields.
         * **Name** A unique name to identify the server with.         * **Name** A unique name to identify the server with.
-        * **MAC Address** This has to match the MAC Address of the interface on the device running Acell-ppp and is used as a identity field.+        * **MAC Address** This has to match the MAC Address of the interface on the device running Accel-ppp and is used as a identity field.
         * **Server Profile** This was covered earlier in this document.         * **Server Profile** This was covered earlier in this document.
-        * **Interface** The name of the interface on which you plan to run the PPPoE service on (using Acell-ppp)+        * **Interface** The name of the interface on which you plan to run the PPPoE service on (using Accel-ppp)
         * **NAS Identifier** Used to identify the server when interacting with the RADIUS server.         * **NAS Identifier** Used to identify the server when interacting with the RADIUS server.
 +
 +=== Servers GUI ===
 +{{:technical:pppoe:acell-server.png|}}
 +  * The screenshot above is from the Accel-ppp server applet. 
 +  * Let's look at some key points
 +        * The Refresh button has an option to automatically refresh at fixed intervals. This is handy if you want to see when an Accel-ppp server comes online without having to hit the refresh button the whole time.
 +        * Next to it is a toggle button which allows you to see either all defined server or only those servers which are currently online.
 +        * The Add, Delete and Edit buttons should be self explanatory.
 +        * The **Restart Service** button is used to set the restart service flag on a selected server. 
 +        * If it is set (indicated visually with a gears icon prepended to the name) and the next heartbeat arrives from the RADIUSdesk Accel-ppp agent. the agent will detect the flag and restart the Accel-ppp service.
 +        * The visual indication will also be cleared.
 +        * The final button is used to launch a new tab which will list all the active sessions.
 +
 +{{:technical:pppoe:acell-sessions.png|}}
 +  * The final button on the active sessions tab in turn will allow you to terminate selected sessions.
 +  * It works is a similar way to the **Restart Service** button for the server itself where a flag is set and there is a visual indication that a session is marked for disconnect until the next heartbeat where it will be cleared and the RADIUSdesk Accel-ppp agent will terminate the user's session.
 +
 ==== New Arrivals ==== ==== New Arrivals ====
 +{{:technical:pppoe:acell-arrival.png|}}
 +  * Any of the Accel-ppp servers that still needs on-boarding will be listed under **New Arrivals**.
 +  * Simply select the one you want to on-board and provide the required information to allow it to become part of the managed servers.
 +  * Reboot the device after on-boarding and the configuration will be applied through the RADIUSdesk Accel-ppp agent.
 +
 +==== Next Steps ====
 +  * Be sure to check out the steps to follow on the Ubuntu or Raspberry Pi to install the RADIUSdesk Accel-ppp agent so it can be managed by RADIUSdesk.
  
  
Last modified: 2023/11/07 07:03