diff options
Diffstat (limited to 'doc/installation/ubuntu.rst')
-rw-r--r-- | doc/installation/ubuntu.rst | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/installation/ubuntu.rst b/doc/installation/ubuntu.rst new file mode 100644 index 0000000..eb98ca5 --- /dev/null +++ b/doc/installation/ubuntu.rst @@ -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 |