Add section for obtaining server API tokens

ultrahorizon · May 2, 2020 · b8f4e0d · b8f4e0d
1 parent 9e1093e
commit b8f4e0d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 2 deletions.
diff --git a/source/_static/icons/key.svg b/source/_static/icons/key.svg
diff --git a/source/_static/website/servers/token.png b/source/_static/website/servers/token.png
diff --git a/source/servers/adding-servers.rst b/source/servers/adding-servers.rst
@@ -4,8 +4,9 @@ Adding VPN Servers
 It is possible to add servers whilst the uh-vpn-server service is running. To do so, one must update
 the token store in ``/etc/uh-vpn-server``.
 
-First, an API token for the relevant server must be obtained from the `website`_. Once this is done, it is
-necessary to append this token to the token store by following the steps outlined below:
+First, an API token for the relevant server must be obtained from the `website`_ by following the
+instructions for `obtaining API tokens`_. Once this is done, it is necessary to append this
+token to the token store by following the steps outlined below:
 
 .. code-block:: bash
 
@@ -40,4 +41,5 @@ configuration has been downloaded and installed:
   :alt: Token acceptance
 
 .. _website: https://uh-vpn.com
+.. _obtaining API tokens: ../website/servers/api-tokens.html
 
diff --git a/source/website/servers/api-tokens.rst b/source/website/servers/api-tokens.rst
@@ -0,0 +1,23 @@
+Obtaining API Tokens
+====================
+
+To use a server defined on the `website`_ with UH VPN Server software it is necessary to obtain an
+API token for the server in question. To do this one needs to click the |key_icon| icon next to the
+appropriate server in the list of servers on the relevant group page. After clicking, one will
+be presented with a modal as shown below:
+
+.. image:: /_static/website/servers/token.png
+  :width: 400
+  :alt: Token Modal
+
+One simply needs to copy the token (shown in pink) and follow the `adding servers`_ instructions
+in order to link the server software with the UH VPN API.
+
+If a token has been compromised, the "Regenerate" button can be used to create a new token for the
+server in question. **This will instantly revoke the old API token**
+
+.. |key_icon| image:: /_static/icons/key.svg
+  :alt: Key Icon
+
+.. _website: https://uh-vpn.com
+.. _adding servers: ../../servers/adding-servers.html
diff --git a/source/website/servers/index.rst b/source/website/servers/index.rst
@@ -17,5 +17,6 @@ configuration.
     creating
     editing
     deleting
+    api-tokens
 
 .. _website: https://uh-vpn.com