Add file structure and add server installation file

ultrahorizon · Apr 25, 2020 · f567932 · f567932
1 parent 610e45f
commit f567932
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@ lib
 Makefile
 build/
 *.bat
-
+.idea/
diff --git a/source/clients/index.rst b/source/clients/index.rst
@@ -0,0 +1,3 @@
+*******
+Clients
+*******
diff --git a/source/index.rst b/source/index.rst
@@ -1,20 +1,16 @@
-.. UH VPN documentation master file, created by
-   sphinx-quickstart on Fri Apr 24 22:56:26 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+UH VPN Documentation
+====================
 
-Welcome to UH VPN's documentation!
-==================================
+The documentation, `maintained with the help of the community`_, offers
+instructions on how to install, configure, and use UH VPN software.
+Whether you are new to UH VPN, or a seasoned veteran, our docs
+offer something for everyone.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
+   website/index
+   servers/index
+   clients/index
 
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. _maintained with the help of the community: https://github.com/ultrahorizon/UH-VPN-Docs
diff --git a/source/servers/adding-servers.rst b/source/servers/adding-servers.rst
@@ -0,0 +1,3 @@
+Configuring Dynamic DNS
+=======================
+
diff --git a/source/servers/index.rst b/source/servers/index.rst
@@ -0,0 +1,21 @@
+*******
+Servers
+*******
+
+UH VPN Server software runs on machines hosted by the end-user. This could be in a cloud or on-premise environment.
+This software is responsible for the VPN link which encrypts and authenticates data between client applications
+and the hosted machine running UH VPN Server software.
+
+Configuration for UH VPN Servers is done via the `website`_ and each server created is assigned an API token, these
+tokens are used by the server software to dynamically pull all configuration options from the UH VPN API. This
+facilitatescentralised administration for VPN servers and greatly reduces the complexity involved in VPN deployment.
+
+..  toctree::
+    :maxdepth: 1
+
+    installation
+    adding-servers
+    removing-servers
+    upgrading
+
+.. _website: https://uh-vpn.com
diff --git a/source/servers/installation.rst b/source/servers/installation.rst
@@ -0,0 +1,44 @@
+Installation
+============
+
+UH VPN Server software demands the following prerequisites:
+
+* **OS**: Ubuntu 18.04
+* **RAM**: 100MB (1GB preferable)
+* **Network**: Machine accessible either by public IP address, hostname or dynamic DNS.
+
+The first step is to add Ultra Horizon's package archive to the system sources.
+
+.. code-block:: bash
+
+    $> sudo add-apt-repository ppa:ultrahorizon/ppa
+
+A prompt will then display information about the repository, accept this, then download the package information
+from this newly added archive:
+
+.. code-block:: bash
+
+    $> sudo add-get update
+
+Once this is done, UH VPN Server software can now be downloaded through the apt package manager.
+
+.. code-block:: bash
+
+    $> sudo apt-get install uh-vpn-server
+
+Once installed check that the UH VPN Service is running:
+
+.. code-block:: bash
+
+    $> sudo service uh-vpn-server status
+
+The output should say **active (running)**.
+
+If one desires UH VPN Server to start at boot, issue the following command:
+
+.. code-block:: bash
+
+    $> sudo systemctl enable uh-vpn-server
+
+
+
diff --git a/source/servers/removing-servers.rst b/source/servers/removing-servers.rst
@@ -0,0 +1,3 @@
+Configuring Dynamic DNS
+=======================
+
diff --git a/source/servers/upgrading.rst b/source/servers/upgrading.rst
@@ -0,0 +1,3 @@
+Configuring Dynamic DNS
+=======================
+
diff --git a/source/website/index.rst b/source/website/index.rst
@@ -0,0 +1,3 @@
+*******
+Website
+*******