-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e393bc7
commit 16f51ac
Showing
11 changed files
with
287 additions
and
1 deletion.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,3 +24,4 @@ Contents | |
| configuration | ||
| telegrambot | ||
| deployment | ||
| nixarion | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| AI VPN Using Nix Arion | ||
| ====================== | ||
|
|
||
| What is Nix? | ||
| ------------ | ||
|
|
||
| Nix is a packet manager that uses a model that allows reproducibility of packages and builds using declarative definitions. | ||
| Learn more about Nix and NixOS at `NixOS Quick Start <https://nixos.org/manual/nix/stable/quick-start.html>`. | ||
|
|
||
| What is Arion? | ||
| -------------- | ||
|
|
||
| Arion is a Nix tool designed to help launch modular docker based applications on Nix. Arion was designed with the same Nix principles in mind and follows a declarative approach. Arion focuses on providing an easier deployment and better performance. Learn more about Arion at `Arion Documentation <https://docs.hercules-ci.com/arion/>`. | ||
|
|
||
| How can the AI VPN deployed using Nix Arion? | ||
| -------------------------------------------- | ||
|
|
||
| Once Nix package manager and Arion are already installed, you can start the service with a simple command:: | ||
|
|
||
| $ cd AIVPN/ | ||
| $ arion up -d | ||
|
|
||
| To stop the service run:: | ||
|
|
||
| $ arion down | ||
|
|
||
| If you need to change the configuration of the services, edit the file:: | ||
|
|
||
| * arion-compose.nix | ||
|
|
||
| Note: Arion has some limitations and may not support all the configuration parameters of docker-compose. This is why at the moment the Pi-Hole module is not supported through Arion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
|
|
||
|
|
||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
|
|
||
| <title>AI VPN Using Nix Arion — AI VPN 2021 documentation</title> | ||
|
|
||
|
|
||
|
|
||
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <!--[if lt IE 9]> | ||
| <script src="_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
|
|
||
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | ||
| <script src="_static/jquery.js"></script> | ||
| <script src="_static/underscore.js"></script> | ||
| <script src="_static/doctools.js"></script> | ||
|
|
||
| <script type="text/javascript" src="_static/js/theme.js"></script> | ||
|
|
||
|
|
||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| <link rel="prev" title="Deployment" href="deployment.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"> AI VPN | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <img src="_static/aivpn.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" /> | ||
| <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="main navigation"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <ul class="current"> | ||
| <li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="telegrambot.html">Creating a Telegram Bot for the AI VPN</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a></li> | ||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">AI VPN Using Nix Arion</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="#what-is-nix">What is Nix?</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#what-is-arion">What is Arion?</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#how-can-the-ai-vpn-deployed-using-nix-arion">How can the AI VPN deployed using Nix Arion?</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
|
|
||
|
|
||
| <nav class="wy-nav-top" aria-label="top navigation"> | ||
|
|
||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">AI VPN</a> | ||
|
|
||
| </nav> | ||
|
|
||
|
|
||
| <div class="wy-nav-content"> | ||
|
|
||
| <div class="rst-content"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div role="navigation" aria-label="breadcrumbs navigation"> | ||
|
|
||
| <ul class="wy-breadcrumbs"> | ||
|
|
||
| <li><a href="index.html" class="icon icon-home"></a> »</li> | ||
|
|
||
| <li>AI VPN Using Nix Arion</li> | ||
|
|
||
|
|
||
| <li class="wy-breadcrumbs-aside"> | ||
|
|
||
|
|
||
| <a href="_sources/nixarion.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"> | ||
|
|
||
| <div class="section" id="ai-vpn-using-nix-arion"> | ||
| <h1>AI VPN Using Nix Arion<a class="headerlink" href="#ai-vpn-using-nix-arion" title="Permalink to this headline">¶</a></h1> | ||
| <div class="section" id="what-is-nix"> | ||
| <h2>What is Nix?<a class="headerlink" href="#what-is-nix" title="Permalink to this headline">¶</a></h2> | ||
| <p>Nix is a packet manager that uses a model that allows reproducibility of packages and builds using declarative definitions. | ||
| Learn more about Nix and NixOS at <cite>NixOS Quick Start <https://nixos.org/manual/nix/stable/quick-start.html></cite>.</p> | ||
| </div> | ||
| <div class="section" id="what-is-arion"> | ||
| <h2>What is Arion?<a class="headerlink" href="#what-is-arion" title="Permalink to this headline">¶</a></h2> | ||
| <p>Arion is a Nix tool designed to help launch modular docker based applications on Nix. Arion was designed with the same Nix principles in mind and follows a declarative approach. Arion focuses on providing an easier deployment and better performance. Learn more about Arion at <cite>Arion Documentation <https://docs.hercules-ci.com/arion/></cite>.</p> | ||
| </div> | ||
| <div class="section" id="how-can-the-ai-vpn-deployed-using-nix-arion"> | ||
| <h2>How can the AI VPN deployed using Nix Arion?<a class="headerlink" href="#how-can-the-ai-vpn-deployed-using-nix-arion" title="Permalink to this headline">¶</a></h2> | ||
| <p>Once Nix package manager and Arion are already installed, you can start the service with a simple command:</p> | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd AIVPN/ | ||
| $ arion up -d | ||
| </pre></div> | ||
| </div> | ||
| <p>To stop the service run:</p> | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ arion down | ||
| </pre></div> | ||
| </div> | ||
| <p>If you need to change the configuration of the services, edit the file:</p> | ||
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*</span> <span class="n">arion</span><span class="o">-</span><span class="n">compose</span><span class="o">.</span><span class="n">nix</span> | ||
| </pre></div> | ||
| </div> | ||
| <p>Note: Arion has some limitations and may not support all the configuration parameters of docker-compose. This is why at the moment the Pi-Hole module is not supported through Arion.</p> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| <footer> | ||
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| <a href="deployment.html" class="btn btn-neutral float-left" title="Deployment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p> | ||
| © Copyright 2020, Civilsphere Project. | ||
|
|
||
| </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 type="text/javascript"> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </body> | ||
| </html> |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.