diff options
Diffstat (limited to 'installation')
| -rw-r--r-- | installation/centos.html | 205 | ||||
| -rw-r--r-- | installation/debian.html | 195 | ||||
| -rw-r--r-- | installation/elrepo_kernel_inst.html | 158 | ||||
| -rw-r--r-- | installation/generic_inst.html | 196 | ||||
| -rw-r--r-- | installation/install.html | 146 | ||||
| -rw-r--r-- | installation/ubuntu.html | 189 |
6 files changed, 1089 insertions, 0 deletions
diff --git a/installation/centos.html b/installation/centos.html new file mode 100644 index 0000000..2876bb0 --- /dev/null +++ b/installation/centos.html @@ -0,0 +1,205 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Install on Centos — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Install kernel from elrepo" href="elrepo_kernel_inst.html" /> + <link rel="prev" title="Install on Ubuntu" href="ubuntu.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="install.html">Installation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html">Generic Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="debian.html">Install on Debian</a></li> +<li class="toctree-l2"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Install on Centos</a><ul> +<li class="toctree-l3"><a class="reference internal" href="elrepo_kernel_inst.html">Install kernel from elrepo</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="install.html">Installation</a></li> + <li class="breadcrumb-item active">Install on Centos</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/centos.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="install-on-centos"> +<span id="install-centos"></span><h1>Install on Centos<a class="headerlink" href="#install-on-centos" title="Link to this heading"></a></h1> +<p>For compile with modules <strong>vlan_mon</strong> and <strong>ipoe</strong> on centos need install vanilla linux kernel or <a class="reference internal" href="elrepo_kernel_inst.html#elrepo-kernel-inst"><span class="std std-ref">Install kernel from elrepo</span></a> . If that not needed, just set <strong>-DBUILD_IPOE_DRIVER=FALSE</strong> and <strong>-DBUILD_VLAN_MON_DRIVER=FALSE</strong> on cmake.</p> +<p><strong>Preparation</strong></p> +<p>Before compile and build package need satisfy some dependencies</p> +<ul class="simple"> +<li><p><strong>rpm-build</strong> - open-source system that manages the build process</p></li> +<li><p><strong>cmake</strong> - open-source system that manages the build process</p></li> +<li><p><strong>gcc</strong> - GNU Compiler Collection (GCC) is a compiler system</p></li> +<li><p><strong>git</strong> - version-control system for tracking changes, (need for downloading source code)</p></li> +<li><p><strong>pcre2-devel</strong> - source code of pcre2 lib, accel-ppp need it for use reg expression</p></li> +<li><p><strong>openssl-devel</strong> - source code of lib ssl, accel-ppp need it for use regular expression</p></li> +<li><p><strong>lua-devel</strong> - this need for create custom username (IPoE) from packet. Script write on lua language</p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>yum<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>rpm-build<span class="w"> </span>make<span class="w"> </span>cmake<span class="w"> </span>gcc<span class="w"> </span>git<span class="w"> </span>pcre2-devel<span class="w"> </span>openssl-devel<span class="w"> </span>lua-devel +</pre></div> +</div> +<p>After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/accel-ppp/accel-ppp.git<span class="w"> </span>/opt/accel-ppp-code +</pre></div> +</div> +<p>Create directory for build source code and go to this directory.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>/opt/accel-ppp-code/build +<span class="nb">cd</span><span class="w"> </span>/opt/accel-ppp-code/build/ +</pre></div> +</div> +<p>For building code need we can set next params:</p> +<ul class="simple"> +<li><p><strong>-DBUILD_IPOE_DRIVER=TRUE</strong> include IPoE module.This module need if you want use accel-ppp as shared interface.</p></li> +<li><p><strong>-DBUILD_VLAN_MON_DRIVER=TRUE</strong> 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)</p></li> +<li><p><strong>-DKDIR=/usr/src/kernels/`uname -r`</strong> sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON.</p></li> +<li><p><strong>-DCMAKE_INSTALL_PREFIX=/usr</strong> path for install executable code. If you build DEB package, not recommended change this.</p></li> +<li><p><strong>-DCPACK_TYPE=Centos7</strong> this arguments for building RPM package. If used centos other version, set it.</p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>-DBUILD_IPOE_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DBUILD_VLAN_MON_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span>/usr<span class="w"> </span>-DKDIR<span class="o">=</span>/usr/src/kernels/<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span><span class="w"> </span>-DLUA<span class="o">=</span>TRUE<span class="w"> </span>-DCPACK_TYPE<span class="o">=</span>Centos7<span class="w"> </span>.. +</pre></div> +</div> +<div class="admonition-notice admonition"> +<p class="admonition-title">Notice:</p> +<p>ended symbols <strong>..</strong> 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/</p> +</div> +<p>Compile:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make +</pre></div> +</div> +<p>Create RPM package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpack<span class="w"> </span>-G<span class="w"> </span>RPM +</pre></div> +</div> +<p>Install package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rpm<span class="w"> </span>-ivh<span class="w"> </span>accel-ppp.rpm +</pre></div> +</div> +<p>If accel-ppp was build with modules <strong>ipoe</strong> and <strong>vlan_mon</strong>, need next:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cp<span class="w"> </span>./drivers/ipoe/driver/ipoe.ko<span class="w"> </span>/lib/modules/<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span>/kernel/net +cp<span class="w"> </span>./drivers/vlan_mon/driver/vlan_mon.ko<span class="w"> </span>/lib/modules/<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span>/kernel/net +depmod<span class="w"> </span>-a +</pre></div> +</div> +<p>If you have success packet install, rename config file to accel-ppp.conf</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mv<span class="w"> </span>/etc/accel-ppp.conf.dist<span class="w"> </span>/etc/accel-ppp.conf +</pre></div> +</div> +<p>Edit accel-ppp.conf for you schemas and run accel-ppp</p> +<p><strong>Run as systemd unit:</strong></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span>start<span class="w"> </span>accel-ppp +</pre></div> +</div> +<p>or run manual (not recommended)</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>accel-pppd<span class="w"> </span>-d<span class="w"> </span>-c<span class="w"> </span>/etc/accel-ppp.conf<span class="w"> </span>-p<span class="w"> </span>/var/run/accel-ppp.pid +</pre></div> +</div> +<div class="toctree-wrapper compound"> +<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="elrepo_kernel_inst.html">Install kernel from elrepo</a></li> +</ul> +</div> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="ubuntu.html" class="btn btn-neutral float-left" title="Install on Ubuntu" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="elrepo_kernel_inst.html" class="btn btn-neutral float-right" title="Install kernel from elrepo" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/installation/debian.html b/installation/debian.html new file mode 100644 index 0000000..955d78e --- /dev/null +++ b/installation/debian.html @@ -0,0 +1,195 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Install on Debian — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Install on Ubuntu" href="ubuntu.html" /> + <link rel="prev" title="Generic Installation" href="generic_inst.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="install.html">Installation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html">Generic Installation</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Install on Debian</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#update-procedure">Update procedure</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l2"><a class="reference internal" href="centos.html">Install on Centos</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="install.html">Installation</a></li> + <li class="breadcrumb-item active">Install on Debian</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/debian.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="install-on-debian"> +<h1>Install on Debian<a class="headerlink" href="#install-on-debian" title="Link to this heading"></a></h1> +<p><strong>Preparation</strong></p> +<p>Before compile and build package need satisfy some dependencies</p> +<ul class="simple"> +<li><p><strong>cmake</strong> - open-source system that manages the build process</p></li> +<li><p><strong>gcc</strong> - GNU Compiler Collection (GCC) is a compiler system</p></li> +<li><p><strong>linux-headers-`uname -r`</strong> - 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</p></li> +<li><p><strong>git</strong> - version-control system for tracking changes, (need for downloading source code)</p></li> +<li><p><strong>libpcre2-dev</strong> - source code of pcre2 lib, accel-ppp need it for use reg expression</p></li> +<li><p><strong>libssl-dev</strong> - source code of ssl lib, accel-ppp need it for use regular expression</p></li> +<li><p><strong>liblua5.1-0-dev</strong> - this need for create custom username (IPoE) from packet. Script write on lua language</p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>build-essential<span class="w"> </span>cmake<span class="w"> </span>gcc<span class="w"> </span>linux-headers-<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span><span class="w"> </span>git<span class="w"> </span>libpcre2-dev<span class="w"> </span>libssl-dev<span class="w"> </span>liblua5.1-0-dev +</pre></div> +</div> +<p>After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/accel-ppp/accel-ppp.git<span class="w"> </span>/opt/accel-ppp-code +</pre></div> +</div> +<p>Create directory for build source code and go to this directory.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>/opt/accel-ppp-code/build +<span class="nb">cd</span><span class="w"> </span>/opt/accel-ppp-code/build/ +</pre></div> +</div> +<p>For building code need we can set next params:</p> +<ul class="simple"> +<li><p><strong>-DBUILD_IPOE_DRIVER=TRUE</strong> include IPoE module.This module need if you want use accel-ppp as shared interface.</p></li> +<li><p><strong>-DBUILD_VLAN_MON_DRIVER=TRUE</strong> 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)</p></li> +<li><p><strong>-DKDIR=/usr/src/linux-headers-`uname -r`</strong> sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON.</p></li> +<li><p><strong>-DCMAKE_INSTALL_PREFIX=/usr</strong> path for install executable code. If you build DEB package, not recommended change this.</p></li> +<li><p><strong>-DCPACK_TYPE=Debian10</strong> this arguments for building DEB package. If used debian other version, set it. For example, if used debian 9 set <strong>-DCPACK_TYPE=Debian9</strong></p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>-DBUILD_IPOE_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DBUILD_VLAN_MON_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span>/usr<span class="w"> </span>-DKDIR<span class="o">=</span>/usr/src/linux-headers-<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span><span class="w"> </span>-DLUA<span class="o">=</span>TRUE<span class="w"> </span>-DCPACK_TYPE<span class="o">=</span>Debian10<span class="w"> </span>.. +</pre></div> +</div> +<div class="admonition-notice admonition"> +<p class="admonition-title">Notice:</p> +<p>ended symbols <strong>..</strong> 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/</p> +</div> +<p>Compile:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make +</pre></div> +</div> +<p>Create DEB package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpack<span class="w"> </span>-G<span class="w"> </span>DEB +</pre></div> +</div> +<p>Install package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>dpkg<span class="w"> </span>-i<span class="w"> </span>accel-ppp.deb +</pre></div> +</div> +<p>If you have success packet install, rename config file to accel-ppp.conf</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mv<span class="w"> </span>/etc/accel-ppp.conf.dist<span class="w"> </span>/etc/accel-ppp.conf +</pre></div> +</div> +<p>Edit accel-ppp.conf for you schemas and run accel-ppp</p> +<p><strong>Run as systemd unit:</strong></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span>start<span class="w"> </span>accel-ppp +</pre></div> +</div> +<p>or run manual (not recommended)</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>accel-pppd<span class="w"> </span>-d<span class="w"> </span>-c<span class="w"> </span>/etc/accel-ppp.conf<span class="w"> </span>-p<span class="w"> </span>/var/run/accel-ppp.pid +</pre></div> +</div> +<section id="update-procedure"> +<h2>Update procedure<a class="headerlink" href="#update-procedure" title="Link to this heading"></a></h2> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="generic_inst.html" class="btn btn-neutral float-left" title="Generic Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="ubuntu.html" class="btn btn-neutral float-right" title="Install on Ubuntu" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/installation/elrepo_kernel_inst.html b/installation/elrepo_kernel_inst.html new file mode 100644 index 0000000..84912bc --- /dev/null +++ b/installation/elrepo_kernel_inst.html @@ -0,0 +1,158 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Install kernel from elrepo — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Configuration" href="../configuration/configuration.html" /> + <link rel="prev" title="Install on Centos" href="centos.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="install.html">Installation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html">Generic Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="debian.html">Install on Debian</a></li> +<li class="toctree-l2"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="centos.html">Install on Centos</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">Install kernel from elrepo</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="install.html">Installation</a></li> + <li class="breadcrumb-item"><a href="centos.html">Install on Centos</a></li> + <li class="breadcrumb-item active">Install kernel from elrepo</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/elrepo_kernel_inst.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="install-kernel-from-elrepo"> +<span id="elrepo-kernel-inst"></span><h1>Install kernel from elrepo<a class="headerlink" href="#install-kernel-from-elrepo" title="Link to this heading"></a></h1> +<p>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 <a class="reference external" href="http://elrepo.org/tiki/tiki-index.php">http://elrepo.org/tiki/tiki-index.php</a> instalation guide.</p> +<p>For Centos 7</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rpm<span class="w"> </span>--import<span class="w"> </span>https://www.elrepo.org/RPM-GPG-KEY-elrepo.org +rpm<span class="w"> </span>-Uvh<span class="w"> </span>https://www.elrepo.org/elrepo-release-7.0-3.el7.elrepo.noarch.rpm +</pre></div> +</div> +<p>For Centos 8</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rpm<span class="w"> </span>--import<span class="w"> </span>https://www.elrepo.org/RPM-GPG-KEY-elrepo.org +yum<span class="w"> </span>install<span class="w"> </span>https://www.elrepo.org/elrepo-release-8.0-2.el8.elrepo.noarch.rpm +</pre></div> +</div> +<p>Install kernel-ml and kernel-ml-devel</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>yum<span class="w"> </span>--enablerepo<span class="o">=</span>elrepo-kernel<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>kernel-ml<span class="w"> </span>kernel-ml-devel +</pre></div> +</div> +<p>To show installed kernels run command:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>awk<span class="w"> </span>-F<span class="se">\'</span><span class="w"> </span><span class="s1">'$1=="menuentry " {print $2}'</span><span class="w"> </span>/etc/grub2.cfg +</pre></div> +</div> +<p>Set installed kernel as default for grub2 bootloader:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>grub2-set-default<span class="w"> </span><span class="m">0</span> +</pre></div> +</div> +<p>Reboot system and check kernel version</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>uname<span class="w"> </span>-r +</pre></div> +</div> +<p>Now you can continue <a class="reference internal" href="centos.html#install-centos"><span class="std std-ref">Install on Centos</span></a> with modules <strong>vlan_mon</strong> and <strong>ipoe</strong></p> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="centos.html" class="btn btn-neutral float-left" title="Install on Centos" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../configuration/configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/installation/generic_inst.html b/installation/generic_inst.html new file mode 100644 index 0000000..b605656 --- /dev/null +++ b/installation/generic_inst.html @@ -0,0 +1,196 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Generic Installation — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Install on Debian" href="debian.html" /> + <link rel="prev" title="Installation" href="install.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="install.html">Installation</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Generic Installation</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#requirment">Requirment</a></li> +<li class="toctree-l3"><a class="reference internal" href="#compilation-and-instalation">Compilation and instalation</a></li> +<li class="toctree-l3"><a class="reference internal" href="#run">Run</a></li> +<li class="toctree-l3"><a class="reference internal" href="#control">Control</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="debian.html">Install on Debian</a></li> +<li class="toctree-l2"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l2"><a class="reference internal" href="centos.html">Install on Centos</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="install.html">Installation</a></li> + <li class="breadcrumb-item active">Generic Installation</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/generic_inst.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="generic-installation"> +<h1>Generic Installation<a class="headerlink" href="#generic-installation" title="Link to this heading"></a></h1> +<section id="requirment"> +<h2>Requirment<a class="headerlink" href="#requirment" title="Link to this heading"></a></h2> +<ul class="simple"> +<li><p>modern linux distribution</p></li> +<li><p>kernel-2.6.25 or later</p></li> +<li><p>cmake-2.6 or later</p></li> +<li><p>libnl-2.0 or probably later (optional, required for builtin shaper)</p></li> +<li><p>libcrypto-0.9.8 or probably later (openssl-0.9.8)</p></li> +<li><p>libpcre2</p></li> +<li><p>net-snmp-5.x (optional, required for snmp)</p></li> +<li><p>libssl-0.9.8 or probably later (openssl-0.9.8)</p></li> +<li><p>liblua5.1 probably later (optional, required for create username fundamental on packet header information)</p></li> +</ul> +</section> +<section id="compilation-and-instalation"> +<h2>Compilation and instalation<a class="headerlink" href="#compilation-and-instalation" title="Link to this heading"></a></h2> +<p>Make sure you have configured kernel headers in /usr/src/linux, or specify other location via KDIR.</p> +<p>Download accel-ppp source code with git client, tree master . Master tree contain actual patches last release.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/accel-ppp/accel-ppp.git<span class="w"> </span>accel-ppp-code +</pre></div> +</div> +<p>Create directory for build source code and go to this directory.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>/opt/accel-ppp-code/build +<span class="nb">cd</span><span class="w"> </span>/opt/accel-ppp-code/build/ +</pre></div> +</div> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span><span class="o">[</span>-DBUILD_DRIVER<span class="o">=</span>FALSE<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DKDIR<span class="o">=</span>/usr/src/linux<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span>/usr/local<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DCMAKE_BUILD_TYPE<span class="o">=</span>Release<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DLOG_PGSQL<span class="o">=</span>FALSE<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DSHAPER<span class="o">=</span>FALSE<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DRADIUS<span class="o">=</span>TRUE<span class="o">]</span><span class="w"> </span><span class="o">[</span>-DNETSNMP<span class="o">=</span>FALSE<span class="o">]</span><span class="w"> </span>.. +</pre></div> +</div> +<div class="admonition-notice admonition"> +<p class="admonition-title">Notice:</p> +<p>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.</p> +</div> +<p>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.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make +make<span class="w"> </span>install +</pre></div> +</div> +</section> +<section id="run"> +<h2>Run<a class="headerlink" href="#run" title="Link to this heading"></a></h2> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>accel-pppd<span class="w"> </span>-d<span class="w"> </span>-p<span class="w"> </span>/var/run/accel-ppp.pid<span class="w"> </span>-c<span class="w"> </span>/etc/accel-ppp.conf +</pre></div> +</div> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>usage:<span class="w"> </span>accel-pppd<span class="w"> </span><span class="o">[</span>-d<span class="o">]</span><span class="w"> </span><span class="o">[</span>-p<span class="w"> </span><file><span class="o">]</span><span class="w"> </span>-c<span class="w"> </span><file> +<span class="w"> </span>where: +<span class="w"> </span>-d<span class="w"> </span>-<span class="w"> </span>daemon<span class="w"> </span>mode +<span class="w"> </span>-p<span class="w"> </span>-<span class="w"> </span>write<span class="w"> </span>pid<span class="w"> </span>to<span class="w"> </span><file> +<span class="w"> </span>-c<span class="w"> </span>-<span class="w"> </span>config<span class="w"> </span>file +</pre></div> +</div> +</section> +<section id="control"> +<h2>Control<a class="headerlink" href="#control" title="Link to this heading"></a></h2> +<p>Accel-ppp support next features for control daemon and sessions</p> +<ul class="simple"> +<li><p><strong>accel-cmd</strong></p></li> +<li><p><strong>telnet</strong></p></li> +<li><p><strong>radius CoA</strong></p></li> +<li><p><strong>snmp</strong></p></li> +</ul> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="install.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="debian.html" class="btn btn-neutral float-right" title="Install on Debian" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/installation/install.html b/installation/install.html new file mode 100644 index 0000000..452d07b --- /dev/null +++ b/installation/install.html @@ -0,0 +1,146 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Installation — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Generic Installation" href="generic_inst.html" /> + <link rel="prev" title="Welcome to accel-ppp’s documentation!" href="../index.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html">Generic Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="debian.html">Install on Debian</a></li> +<li class="toctree-l2"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l2"><a class="reference internal" href="centos.html">Install on Centos</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Installation</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/install.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="installation"> +<span id="install"></span><h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1> +<div class="toctree-wrapper compound"> +<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="generic_inst.html">Generic Installation</a><ul> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html#requirment">Requirment</a></li> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html#compilation-and-instalation">Compilation and instalation</a></li> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html#run">Run</a></li> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html#control">Control</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="debian.html">Install on Debian</a><ul> +<li class="toctree-l2"><a class="reference internal" href="debian.html#update-procedure">Update procedure</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="ubuntu.html">Install on Ubuntu</a></li> +<li class="toctree-l1"><a class="reference internal" href="centos.html">Install on Centos</a><ul> +<li class="toctree-l2"><a class="reference internal" href="elrepo_kernel_inst.html">Install kernel from elrepo</a></li> +</ul> +</li> +</ul> +</div> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="../index.html" class="btn btn-neutral float-left" title="Welcome to accel-ppp’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="generic_inst.html" class="btn btn-neutral float-right" title="Generic Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/installation/ubuntu.html b/installation/ubuntu.html new file mode 100644 index 0000000..9e4b8c3 --- /dev/null +++ b/installation/ubuntu.html @@ -0,0 +1,189 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Install on Ubuntu — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Install on Centos" href="centos.html" /> + <link rel="prev" title="Install on Debian" href="debian.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="install.html">Installation</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="generic_inst.html">Generic Installation</a></li> +<li class="toctree-l2"><a class="reference internal" href="debian.html">Install on Debian</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Install on Ubuntu</a></li> +<li class="toctree-l2"><a class="reference internal" href="centos.html">Install on Centos</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item"><a href="install.html">Installation</a></li> + <li class="breadcrumb-item active">Install on Ubuntu</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/installation/ubuntu.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="install-on-ubuntu"> +<h1>Install on Ubuntu<a class="headerlink" href="#install-on-ubuntu" title="Link to this heading"></a></h1> +<p><strong>Preparation</strong></p> +<p>Before compile and build package need satisfy some dependencies</p> +<ul class="simple"> +<li><p><strong>cmake</strong> - open-source system that manages the build process</p></li> +<li><p><strong>gcc</strong> - GNU Compiler Collection (GCC) is a compiler system</p></li> +<li><p><strong>linux-headers-`uname -r`</strong> - 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</p></li> +<li><p><strong>git</strong> - version-control system for tracking changes, (need for downloading source code)</p></li> +<li><p><strong>libpcre2-dev</strong> - source code of pcre2 lib, accel-ppp need it for use reg expression</p></li> +<li><p><strong>libssl-dev</strong> - source code of ssl lib, accel-ppp need it for use regular expression</p></li> +<li><p><strong>liblua5.1-0-dev</strong> - this need for create custom username (IPoE) from packet. Script write on lua language</p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>build-essential<span class="w"> </span>cmake<span class="w"> </span>gcc<span class="w"> </span>linux-headers-<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span><span class="w"> </span>git<span class="w"> </span>libpcre2-dev<span class="w"> </span>libssl-dev<span class="w"> </span>liblua5.1-0-dev +</pre></div> +</div> +<p>After install dependencies, download accel-ppp source code with git client, tree master . Master tree contain actual patches last release.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/accel-ppp/accel-ppp.git<span class="w"> </span>/opt/accel-ppp-code +</pre></div> +</div> +<p>Create directory for build source code and go to this directory.</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>/opt/accel-ppp-code/build +<span class="nb">cd</span><span class="w"> </span>/opt/accel-ppp-code/build/ +</pre></div> +</div> +<p>For building code need we can set next params:</p> +<ul class="simple"> +<li><p><strong>-DBUILD_IPOE_DRIVER=TRUE</strong> include IPoE module.This module need if you want use accel-ppp as shared interface.</p></li> +<li><p><strong>-DBUILD_VLAN_MON_DRIVER=TRUE</strong> 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)</p></li> +<li><p><strong>-DKDIR=/usr/src/linux-headers-`uname -r`</strong> sets path to Linux kernel source code. Need only for build IPOE, VLAN-MON.</p></li> +<li><p><strong>-DCMAKE_INSTALL_PREFIX=/usr</strong> path for install executable code. If you build DEB package, not recommended change this.</p></li> +<li><p><strong>-DCPACK_TYPE=Ubuntu18</strong> this arguments for building DEB package. If used Ubuntu other version, set it. For example, if used Ubuntu 16 set <strong>-DCPACK_TYPE=Ubuntu16</strong></p></li> +</ul> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span>-DBUILD_IPOE_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DBUILD_VLAN_MON_DRIVER<span class="o">=</span>TRUE<span class="w"> </span>-DCMAKE_INSTALL_PREFIX<span class="o">=</span>/usr<span class="w"> </span>-DKDIR<span class="o">=</span>/usr/src/linux-headers-<span class="sb">`</span>uname<span class="w"> </span>-r<span class="sb">`</span><span class="w"> </span>-DLUA<span class="o">=</span>TRUE<span class="w"> </span>-DCPACK_TYPE<span class="o">=</span>Ubuntu18<span class="w"> </span>.. +</pre></div> +</div> +<div class="admonition-notice admonition"> +<p class="admonition-title">Notice:</p> +<p>ended symbols <strong>..</strong> 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/</p> +</div> +<p>Compile:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>make +</pre></div> +</div> +<p>Create DEB package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpack<span class="w"> </span>-G<span class="w"> </span>DEB +</pre></div> +</div> +<p>Install package:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>dpkg<span class="w"> </span>-i<span class="w"> </span>accel-ppp.deb +</pre></div> +</div> +<p>If you have success packet install, rename config file to accel-ppp.conf</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mv<span class="w"> </span>/etc/accel-ppp.conf.dist<span class="w"> </span>/etc/accel-ppp.conf +</pre></div> +</div> +<p>Edit accel-ppp.conf for you schemas and run accel-ppp</p> +<p><strong>Run as systemd unit:</strong></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>systemctl<span class="w"> </span>start<span class="w"> </span>accel-ppp +</pre></div> +</div> +<p>or run manual (not recommended)</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>accel-pppd<span class="w"> </span>-d<span class="w"> </span>-c<span class="w"> </span>/etc/accel-ppp.conf<span class="w"> </span>-p<span class="w"> </span>/var/run/accel-ppp.pid +</pre></div> +</div> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="debian.html" class="btn btn-neutral float-left" title="Install on Debian" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="centos.html" class="btn btn-neutral float-right" title="Install on Centos" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file |