diff options
Diffstat (limited to '_sources/installation')
| -rw-r--r-- | _sources/installation/centos.rst.txt | 104 | ||||
| -rw-r--r-- | _sources/installation/debian.rst.txt | 88 | ||||
| -rw-r--r-- | _sources/installation/elrepo_kernel_inst.rst.txt | 46 | ||||
| -rw-r--r-- | _sources/installation/generic_inst.rst.txt | 75 | ||||
| -rw-r--r-- | _sources/installation/install.rst.txt | 15 | ||||
| -rw-r--r-- | _sources/installation/ubuntu.rst.txt | 84 |
6 files changed, 412 insertions, 0 deletions
diff --git a/_sources/installation/centos.rst.txt b/_sources/installation/centos.rst.txt new file mode 100644 index 0000000..92d11c9 --- /dev/null +++ b/_sources/installation/centos.rst.txt @@ -0,0 +1,104 @@ +.. _install_centos: + +Install on Centos +----------------- + +For compile with modules **vlan_mon** and **ipoe** on centos need install vanilla linux kernel or :ref:`elrepo_kernel_inst` . If that not needed, just set **-DBUILD_IPOE_DRIVER=FALSE** and **-DBUILD_VLAN_MON_DRIVER=FALSE** on cmake. + +**Preparation** + +Before compile and build package need satisfy some dependencies + +* **rpm-build** - open-source system that manages the build process +* **cmake** - open-source system that manages the build process +* **gcc** - GNU Compiler Collection (GCC) is a compiler system +* **git** - version-control system for tracking changes, (need for downloading source code) +* **pcre-devel** - source code of pcre lib, accel-ppp need it for use reg expression +* **openssl-devel** - source code of lib ssl, accel-ppp need it for use regular expression +* **lua-devel** - this need for create custom username (IPoE) from packet. Script write on lua language + +.. code-block:: sh + + yum -y install rpm-build make cmake gcc git pcre-devel openssl-devel lua-devel + +After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release. + +.. code-block:: sh + + git clone https://github.com/accel-ppp/accel-ppp.git /opt/accel-ppp-code + +Create directory for build source code and go to this directory. + +.. code-block:: sh + + mkdir /opt/accel-ppp-code/build + cd /opt/accel-ppp-code/build/ + +For building code need we can set next params: + +* **-DBUILD_IPOE_DRIVER=TRUE** include IPoE module.This module need if you want use accel-ppp as shared interface. +* **-DBUILD_VLAN_MON_DRIVER=TRUE** include vlan monitoring module. If you want create vlan automatically on analyse IP headers with regular expression set on accel-ppp config file. (Available for IPoE and PPPoE) +* **-DKDIR=/usr/src/kernels/`uname -r`** sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON. +* **-DCMAKE_INSTALL_PREFIX=/usr** path for install executable code. If you build DEB package, not recommended change this. +* **-DCPACK_TYPE=Centos7** this arguments for building RPM package. If used centos other version, set it. + +.. code-block:: sh + + cmake -DBUILD_IPOE_DRIVER=TRUE -DBUILD_VLAN_MON_DRIVER=TRUE -DCMAKE_INSTALL_PREFIX=/usr -DKDIR=/usr/src/kernels/`uname -r` -DLUA=TRUE -DCPACK_TYPE=Centos7 .. + +.. admonition:: Notice: + + ended symbols **..** sets path to accel-ppp source code, not delete this! Or you can replace it full path to accel-ppp-code like /opt/accel-ppp-code/ + +Compile: + +.. code-block:: sh + + make + +Create RPM package: + +.. code-block:: sh + + cpack -G RPM + +Install package: + +.. code-block:: sh + + rpm -ivh accel-ppp.rpm + +If accel-ppp was build with modules **ipoe** and **vlan_mon**, need next: + +.. code-block:: sh + + cp ./drivers/ipoe/driver/ipoe.ko /lib/modules/`uname -r`/kernel/net + cp ./drivers/vlan_mon/driver/vlan_mon.ko /lib/modules/`uname -r`/kernel/net + depmod -a + +If you have success packet install, rename config file to accel-ppp.conf + +.. code-block:: sh + + mv /etc/accel-ppp.conf.dist /etc/accel-ppp.conf + +Edit accel-ppp.conf for you schemas and run accel-ppp + +**Run as systemd unit:** + +.. code-block:: sh + + systemctl start accel-ppp + +or run manual (not recommended) + +.. code-block:: sh + + accel-pppd -d -c /etc/accel-ppp.conf -p /var/run/accel-ppp.pid + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :includehidden: + + elrepo_kernel_inst.rst
\ No newline at end of file diff --git a/_sources/installation/debian.rst.txt b/_sources/installation/debian.rst.txt new file mode 100644 index 0000000..877b153 --- /dev/null +++ b/_sources/installation/debian.rst.txt @@ -0,0 +1,88 @@ +Install on Debian +----------------- +**Preparation** + +Before compile and build package need satisfy some dependencies + +* **cmake** - open-source system that manages the build process +* **gcc** - GNU Compiler Collection (GCC) is a compiler system +* **linux-headers-`uname -r`** - source code of current installing linux kernel, need for build ipoe and vlan_mon modules. If you don`t need these modules, you may don`t install this +* **git** - version-control system for tracking changes, (need for downloading source code) +* **libpcre3-dev** - source code of pcre lib, accel-ppp need it for use reg expression +* **libssl-dev** - source code of pcre lib, accel-ppp need it for use regular expression +* **liblua5.1-0-dev** - this need for create custom username (IPoE) from packet. Script write on lua language + +.. code-block:: sh + + apt-get install -y build-essential cmake gcc linux-headers-`uname -r` git libpcre3-dev libssl-dev liblua5.1-0-dev + +After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release. + +.. code-block:: sh + + git clone https://github.com/accel-ppp/accel-ppp.git /opt/accel-ppp-code + +Create directory for build source code and go to this directory. + +.. code-block:: sh + + mkdir /opt/accel-ppp-code/build + cd /opt/accel-ppp-code/build/ + +For building code need we can set next params: + +* **-DBUILD_IPOE_DRIVER=TRUE** include IPoE module.This module need if you want use accel-ppp as shared interface. +* **-DBUILD_VLAN_MON_DRIVER=TRUE** include vlan monitoring module. If you want create vlan automatically on analyse IP headers with regular expression set on accel-ppp config file. (Available for IPoE and PPPoE) +* **-DKDIR=/usr/src/linux-headers-`uname -r`** sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON. +* **-DCMAKE_INSTALL_PREFIX=/usr** path for install executable code. If you build DEB package, not recommended change this. +* **-DCPACK_TYPE=Debian10** this arguments for building DEB package. If used debian other version, set it. For example, if used debian 9 set **-DCPACK_TYPE=Debian9** + +.. code-block:: sh + + cmake -DBUILD_IPOE_DRIVER=TRUE -DBUILD_VLAN_MON_DRIVER=TRUE -DCMAKE_INSTALL_PREFIX=/usr -DKDIR=/usr/src/linux-headers-`uname -r` -DLUA=TRUE -DCPACK_TYPE=Debian10 .. + +.. admonition:: Notice: + + ended symbols **..** sets path to accel-ppp source code, not delete this! Or you can replace it full path to accel-ppp-code like /opt/accel-ppp-code/ + +Compile: + +.. code-block:: sh + + make + +Create DEB package: + +.. code-block:: sh + + cpack -G DEB + +Install package: + +.. code-block:: sh + + dpkg -i accel-ppp.deb + +If you have success packet install, rename config file to accel-ppp.conf + +.. code-block:: sh + + mv /etc/accel-ppp.conf.dist /etc/accel-ppp.conf + +Edit accel-ppp.conf for you schemas and run accel-ppp + +**Run as systemd unit:** + +.. code-block:: sh + + systemctl start accel-ppp + +or run manual (not recommended) + +.. code-block:: sh + + accel-pppd -d -c /etc/accel-ppp.conf -p /var/run/accel-ppp.pid + + +Update procedure +^^^^^^^^^^^^^^^^^ diff --git a/_sources/installation/elrepo_kernel_inst.rst.txt b/_sources/installation/elrepo_kernel_inst.rst.txt new file mode 100644 index 0000000..a2c3501 --- /dev/null +++ b/_sources/installation/elrepo_kernel_inst.rst.txt @@ -0,0 +1,46 @@ +.. _elrepo_kernel_inst: + +Install kernel from elrepo +========================== + +At first need enable ELRepo Repository. To set up ELRepo repository, you need to import its official GPG key and then install ELRepo RPM as follows. Also you can follow original http://elrepo.org/tiki/tiki-index.php instalation guide. + +For Centos 7 + +.. code-block:: sh + + rpm --import https://www.elrepo.org/RPM-GPG-KEY-elrepo.org + rpm -Uvh https://www.elrepo.org/elrepo-release-7.0-3.el7.elrepo.noarch.rpm + +For Centos 8 + +.. code-block:: sh + + rpm --import https://www.elrepo.org/RPM-GPG-KEY-elrepo.org + yum install https://www.elrepo.org/elrepo-release-8.0-2.el8.elrepo.noarch.rpm + +Install kernel-ml and kernel-ml-devel + +.. code-block:: sh + + yum --enablerepo=elrepo-kernel install -y kernel-ml kernel-ml-devel + +To show installed kernels run command: + +.. code-block:: sh + + awk -F\' '$1=="menuentry " {print $2}' /etc/grub2.cfg + +Set installed kernel as default for grub2 bootloader: + +.. code-block:: sh + + grub2-set-default 0 + +Reboot system and check kernel version + +.. code-block:: sh + + uname -r + +Now you can continue :ref:`install_centos` with modules **vlan_mon** and **ipoe** diff --git a/_sources/installation/generic_inst.rst.txt b/_sources/installation/generic_inst.rst.txt new file mode 100644 index 0000000..ec8b87f --- /dev/null +++ b/_sources/installation/generic_inst.rst.txt @@ -0,0 +1,75 @@ +Generic Installation +-------------------- + +Requirment +^^^^^^^^^^ + +* modern linux distribution +* kernel-2.6.25 or later +* cmake-2.6 or later +* libnl-2.0 or probably later (optional, required for builtin shaper) +* libcrypto-0.9.8 or probably later (openssl-0.9.8) +* libpcre +* net-snmp-5.x (optional, required for snmp) +* libssl-0.9.8 or probably later (openssl-0.9.8) +* liblua5.1 probably later (optional, required for create username fundamental on packet header information) + +Compilation and instalation +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Make sure you have configured kernel headers in /usr/src/linux, or specify other location via KDIR. + +Download accel-ppp source code with git client, tree master . Master tree contain actual patches last release. + +.. code-block:: sh + + git clone https://github.com/accel-ppp/accel-ppp.git accel-ppp-code + +Create directory for build source code and go to this directory. + +.. code-block:: sh + + mkdir /opt/accel-ppp-code/build + cd /opt/accel-ppp-code/build/ + + +.. code-block:: sh + + cmake [-DBUILD_DRIVER=FALSE] [-DKDIR=/usr/src/linux] [-DCMAKE_INSTALL_PREFIX=/usr/local] [-DCMAKE_BUILD_TYPE=Release] [-DLOG_PGSQL=FALSE] [-DSHAPER=FALSE] [-DRADIUS=TRUE] [-DNETSNMP=FALSE] .. + +.. admonition:: Notice: + + Please note that the double dot record in the end of the command is essential. + You'll probably get error or misconfigured sources if you miss it. + +BUILD_DRIVER, KDIR, CMAKE_INSTALL_PREFIX, CMAKE_BUILD_TYPE, LOG_PGSQL, SHAPER, RADIUS are optional, +but while pptp is not present in mainline kernel you probably need BUILD_DRIVER. + +.. code-block:: sh + + make + make install + +Run +^^^ + +.. code-block:: sh + + accel-pppd -d -p /var/run/accel-ppp.pid -c /etc/accel-ppp.conf + +.. code-block:: sh + + usage: accel-pppd [-d] [-p <file>] -c <file> + where: + -d - daemon mode + -p - write pid to <file> + -c - config file + +Control +^^^^^^^ +Accel-ppp support next features for control daemon and sessions + +* **accel-cmd** +* **telnet** +* **radius CoA** +* **snmp** diff --git a/_sources/installation/install.rst.txt b/_sources/installation/install.rst.txt new file mode 100644 index 0000000..3c1fe60 --- /dev/null +++ b/_sources/installation/install.rst.txt @@ -0,0 +1,15 @@ +.. _install: + +Installation +============ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :includehidden: + + generic_inst.rst + debian.rst + ubuntu.rst + centos.rst + diff --git a/_sources/installation/ubuntu.rst.txt b/_sources/installation/ubuntu.rst.txt new file mode 100644 index 0000000..eb98ca5 --- /dev/null +++ b/_sources/installation/ubuntu.rst.txt @@ -0,0 +1,84 @@ +Install on Ubuntu +----------------- +**Preparation** + +Before compile and build package need satisfy some dependencies + +* **cmake** - open-source system that manages the build process +* **gcc** - GNU Compiler Collection (GCC) is a compiler system +* **linux-headers-`uname -r`** - source code of current installing linux kernel, need for build ipoe and vlan_mon modules. If you don`t need these modules, you may don`t install this +* **git** - version-control system for tracking changes, (need for downloading source code) +* **libpcre3-dev** - source code of pcre lib, accel-ppp need it for use reg expression +* **libssl-dev** - source code of pcre lib, accel-ppp need it for use regular expression +* **liblua5.1-0-dev** - this need for create custom username (IPoE) from packet. Script write on lua language + +.. code-block:: sh + + apt-get install -y build-essential cmake gcc linux-headers-`uname -r` git libpcre3-dev libssl-dev liblua5.1-0-dev + +After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release. + +.. code-block:: sh + + git clone https://github.com/accel-ppp/accel-ppp.git /opt/accel-ppp-code + +Create directory for build source code and go to this directory. + +.. code-block:: sh + + mkdir /opt/accel-ppp-code/build + cd /opt/accel-ppp-code/build/ + +For building code need we can set next params: + +* **-DBUILD_IPOE_DRIVER=TRUE** include IPoE module.This module need if you want use accel-ppp as shared interface. +* **-DBUILD_VLAN_MON_DRIVER=TRUE** include vlan monitoring module. If you want create vlan automatically on analyse IP headers with regular expression set on accel-ppp config file. (Available for IPoE and PPPoE) +* **-DKDIR=/usr/src/linux-headers-`uname -r`** sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON. +* **-DCMAKE_INSTALL_PREFIX=/usr** path for install executable code. If you build DEB package, not recommended change this. +* **-DCPACK_TYPE=Ubuntu18** this arguments for building DEB package. If used Ubuntu other version, set it. For example, if used Ubuntu 16 set **-DCPACK_TYPE=Ubuntu16** + +.. code-block:: sh + + cmake -DBUILD_IPOE_DRIVER=TRUE -DBUILD_VLAN_MON_DRIVER=TRUE -DCMAKE_INSTALL_PREFIX=/usr -DKDIR=/usr/src/linux-headers-`uname -r` -DLUA=TRUE -DCPACK_TYPE=Ubuntu18 .. + +.. admonition:: Notice: + + ended symbols **..** sets path to accel-ppp source code, not delete this! Or you can replace it full path to accel-ppp-code like /opt/accel-ppp-code/ + +Compile: + +.. code-block:: sh + + make + +Create DEB package: + +.. code-block:: sh + + cpack -G DEB + +Install package: + +.. code-block:: sh + + dpkg -i accel-ppp.deb + +If you have success packet install, rename config file to accel-ppp.conf + +.. code-block:: sh + + mv /etc/accel-ppp.conf.dist /etc/accel-ppp.conf + +Edit accel-ppp.conf for you schemas and run accel-ppp + +**Run as systemd unit:** + +.. code-block:: sh + + systemctl start accel-ppp + +or run manual (not recommended) + +.. code-block:: sh + + accel-pppd -d -c /etc/accel-ppp.conf -p /var/run/accel-ppp.pid |