Differences

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

Link to this comparison view

install_accel_rd [2024/02/07 22:00] – created systeminstall_accel_rd [2024/02/08 08:18] (current) – system
Line 1: Line 1:
 ====== RADIUSdesk Accel-ppp Agent ====== ====== RADIUSdesk Accel-ppp Agent ======
 ===== Overview ===== ===== Overview =====
-  * The **RADIUSdesk Accel-ppp Agent** is a lightweight add-on to Ubuntu or Raspberry Pi devices that serves as a broker between Accel-ppp and RADIUSdesk. +  * The **RADIUSdesk Accel-ppp Agent** is a lightweight add-on for Ubuntu or Raspberry Pi devices that serves as an intermediary between Accel-ppp and RADIUSdesk. 
-  * It uses a couple of Lua based libraries and scripts to fulfill its mandate.+  * It uses a set of Lua-based libraries and scripts to accomplish its task.
  
  
 ===== Installation ===== ===== Installation =====
-==== Please double check ==== +==== Please check ==== 
-  * Make sure the iptables package is installed. (It was not installed on my Raspberry Pi OS image)+  * Make sure that the iptables package is installed. (It was not installed on my Raspberry Pi OS image)
 <code bash> <code bash>
 sudo apt-get install iptables sudo apt-get install iptables
 </code> </code>
-        * Make sure packet forwarding for IPv4 is enabled. Edit the **/etc/sysctl.conf**. +        * Make sure that packet forwarding for IPv4 is enabled. Edit the file **/etc/sysctl.conf**. 
-        * Find and uncomment **net.ipv4.ip_forward=1** line.+        *  Find the line **net.ipv4.ip_forward=1** and comment it out.
  
-==== The Rest ====+==== The rest ====
  
-  * We assume you already have a device that has Accel-ppp installed as per instructions elsewhere on this Wiki.+  * We assume that you already have a device with Accel-ppp installed as per the instructions elsewhere in this wiki.
   * Install the following packages.   * Install the following packages.
 <code bash> <code bash>
Line 32: Line 32:
 ===== Configuration ===== ===== Configuration =====
  
-==== Startup and config reference files ====+==== Reference files for startup and configuration ====
   * Copy the following reference files:   * Copy the following reference files:
 <code bash> <code bash>
-#config file for the agent+#Configuration file for the agent
 sudo cp /etc/MESHdesk/files/accel-ppp-rd.conf /etc/ sudo cp /etc/MESHdesk/files/accel-ppp-rd.conf /etc/
-#startup file. We make a backup first of the original one (of there were one)+#Startup file. We first create a backup copy of the original file (if there is one)
 cp /etc/rc.local /etc/rd.local.bak cp /etc/rc.local /etc/rd.local.bak
 sudo cp /etc/MESHdesk/files/rc.local /etc/ sudo cp /etc/MESHdesk/files/rc.local /etc/
 </code> </code>
  
-=== Config File ===+=== Config file ===
  
-  * Configuration is done by tweaking the ///etc/accel-ppp-rd.conf// file. +  * The configuration is done by adapting the file ///etc/accel-ppp-rd.conf// file. 
-  * Refer to the sample below+  * Take a look at the following example
 <code bash> <code bash>
 [internet] [internet]
Line 58: Line 58:
 interface=eth0 interface=eth0
 </code> </code>
-  * In our setup we have a RADIUSdesk server which has a FQDN of cloud.radiusdesk.com+  * In our setup we have a RADIUSdesk server with the FQDN cloud.radiusdesk.com
   * We also specify the fallback ip as 164.160.89.129 in the event when DNS does not resolve.   * We also specify the fallback ip as 164.160.89.129 in the event when DNS does not resolve.
-  * Protocol can be either https or http. We choose https which is more secure. +  * The protocol can be either https or http. We choose https because it is more secure. 
-  * We also specify the interface we want the PPPoE service to run on. +  * We also specify the interface via which the PPPoE service should run. 
-  * In our case we have a Raspberry Pi 4 with an Enternet port (eth0) where we will run the PPPoE service on. +  * In our case, we have a Raspberry Pi 4 with an Enternet port (eth0), which we will use to run the PPPoE service. 
-  * The agent will then fetch the MAC Address of this interface and forward the request for config to RADIUSdesk using this MAC Address as the unique identifier.+  * The agent then retrieves the MAC address of this interface and forwards the request to RADIUSdesk to obtain its configuration, using this MAC address as a unique identifier.
   * Make changes to this file so that it works with your environment and device.   * Make changes to this file so that it works with your environment and device.
  
-=== Startup File === +=== Startup file === 
-  * Disable automatic startup of Accel-ppp.+  * Deactivate the automatic startup of Accel-ppp.
 <code bash> <code bash>
 sudo systemctl disable accel-ppp sudo systemctl disable accel-ppp
 </code> </code>
   * The startup file is ///etc/rc.local//.   * The startup file is ///etc/rc.local//.
-  * You also have to tweak it to work on the device running the RADIUSdesk Accel-ppp Agent. +  * You must also adapt it so that it works on the device on which the RADIUSdesk Accel-ppp agent is running. 
-  * Refer to the sample below+  * Take a look at the following example
 <code bash> <code bash>
 #!/bin/bash #!/bin/bash
Line 88: Line 88:
 </code> </code>
   * The important line is the one with the iptables rule for NAT.   * The important line is the one with the iptables rule for NAT.
-  * With our setup the WAN connection / uplink is the WiFi interface, **wlan0**. +  * In our setup, the WAN connection / uplink is the WiFi interface, **wlan0**. 
-  * Make sure that your setup matches your device's configuration.+  * Make sure that your setup matches the configuration of your device.
  
 <alert type="info"> <alert type="info">
-Since PPPoE works on Layer2, you can have both the PPPoE and the WAN connection on one physical interface e.g eth0 in our case with the Pi.+Since PPPoE works on Layer2, you can have both the PPPoE and WAN connection on a physical interface, e.g. eth0 in our case with the Pi.
 </alert> </alert>
-  * On the Raspberry Pi the rc.local script was called automatically during startup.+  * On the Raspberry Pi, the rc.local script was called automatically at startup.
   * On Ubuntu you'll probably have to follow these instructions to ensure that it starts up during boot time   * On Ubuntu you'll probably have to follow these instructions to ensure that it starts up during boot time
   * http://radiusdesk.com/wiki/technical/ppp-pppoe-basic#add_masquerade_support_on_wan_enp0s3   * http://radiusdesk.com/wiki/technical/ppp-pppoe-basic#add_masquerade_support_on_wan_enp0s3
-  * Everything should now be in place and you can reboot the device and see if it is listed under **Accel-ppp Servers -> New Arrivals** +  * Now everything should be in place and you can reboot the device and see if it is listed under **Accel-ppp Servers → New Arrivals**
  
-==== RADIUS Client ==== +==== RADIUS client ==== 
-  * If your Accel-ppp server is using RADIUSdesk for its RADIUS component you have one last step to do. +  * If your Accel-ppp server uses RADIUSdesk for its RADIUS component, you need to do one last step. 
-  * You can do its RADIUS on-boarding by looking for it under RADIUS -> RADIUS Clients -> New Arrivals. +  * You can perform its RADIUS onboarding by searching for it under RADIUS → RADIUS clients → New arrivals. 
-  * After you completed the on-boarding be sure to specify the Client Type as **Accel-On-RADIUSdesk**. +  * Once you have completed the onboarding, make sure you specify the client type as **Accel-On-RADIUSdesk**. 
-  * This will allow the code to follow the correct procedure when an active session for a user needs to be terminated.+  * This will allow the code to apply the correct procedure when a user's active session needs to be terminated.
 {{:technical:pppoe:accel-type.png|}} {{:technical:pppoe:accel-type.png|}}
  
  
  • install_accel_rd.1707336017.txt.gz
  • Last modified: 2024/02/07 22:00
  • by system