Skip to content

Commit

Permalink
Update server creation page`
Browse files Browse the repository at this point in the history
  • Loading branch information
jwsi committed Apr 30, 2020
1 parent e824400 commit 7a2e79c
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Updating Groups
===============
Editing Groups
==============

Groups can be updated at any point by clicking the |edit_icon| icon next to the appropriate
Groups can be edited at any point by clicking the |edit_icon| icon next to the appropriate
group in the `management page`_. After clicking, one is presented with a page similar to that
of group creation, except fields are pre-filled.

Expand Down
2 changes: 1 addition & 1 deletion source/website/groups/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ even if administered through the same user account.
:maxdepth: 1

creating
updating
editing
deleting
admins
billing
44 changes: 44 additions & 0 deletions source/website/servers/creating.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Creating Servers
================

Servers can be created by using the "Create New Server" button at the base of the list of servers on
the relevant group page. One will then be presented with a list of fields to fill in as follows:

* **Name** : Generic name for the server in question. E.g. Office UDP.
* **Appearance Order** : The order in which the server will appear in the list on client applications.
0 = highest, ∞ = lowest.
* **Domain/IP Address** : The public IP address or hostname for the server.
* **Port** : IP port number for the server.
* **IPv4 Tunnel Network** : This is the IPv4 network that will be used for DHCP address assignment to UH VPN
clients. This should be chosen such that it does not conflict with any subnets already defined on one's network.
* **IPv6 Tunnel Network** : This is the IPv6 network that will be used for DHCP address assignment to UH VPN
clients. If you do not have an IPv6 public subnet, use fe80::/64, fe80:1::/64, fe80:2::/64 or similar
to prevent IPv6 traffic from bypassing the VPN.
* **DNS Servers** : CSV list of DNS servers for UH VPN clients to use.
* **Add Forwarding Rule** : This will dynamically update Ubuntu's iptables to allow forwarding UH VPN traffic
onto one's WAN interface. Only disable this when manually adding filter rules.
* **Add NAT Rule** : This will automatically insert a NAT rule in Ubuntu's iptables to allow UH VPN clients
to access the IPv4 Internet from one's machine. Only disable this when manually adding NAT rules.

.. note::
By default all UH VPN servers will push the routes 0.0.0.0/0 and ::/0 to redirect all IPv4 and IPv6
traffic over the VPN interface.

Premium Server Options
~~~~~~~~~~~~~~~~~~~~~~

* **Redirect IPv4 Traffic** : This controls whether the 0.0.0.0/0 route is pushed to clients.

* **Custom IPv4 Routes** : When the redirect button is disabled, one has the ability to insert
custom IPv4 routes in CSV format. E.g. 192.168.0.0/24, 192.168.1.0/24.

* **Redirect IPv6 Traffic** : This controls whether the ::/0 route is pushed to clients.

* **Custom IPv6 Routes** : When the redirect button is disabled, one has the ability to insert
custom IPv6 routes in CSV format. E.g. fc00::/64, fc00:1::/64.

* **Custom Cryptography** : When selected, one is able to specify their own cryptographic parameters
for use within UH VPN. Note this is only recommended if you are experienced in generating
cryptographic keys and certificates. **Rolling your own crypto is dangerous!**.

Upon server submission, the above fields will be validated and submitted.
2 changes: 2 additions & 0 deletions source/website/servers/deleting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Deleting Servers
================
2 changes: 2 additions & 0 deletions source/website/servers/editing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Editing Servers
===============
18 changes: 18 additions & 0 deletions source/website/servers/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
*******
Servers
*******

UH VPN servers are managed through the `website`_ and are contained within UH VPN groups. Every server
defined within a group permits access from all persons within that group. This facilitates
a simple authentication structure.

All VPN configuration options such as transport protocol, port, IP routing, cryptography and so on is
specififed through the management interface and this information is dynamically pushed every minute to
UH VPN Server software to allow for dynamic configuration updates and reduced complexity in server
configuration.

.. toctree::
:maxdepth: 1

creating
editing
deleting

.. _website: https://uh-vpn.com

0 comments on commit 7a2e79c

Please sign in to comment.