Release v1.3.2

Update README.md and modular imports

README.md

@@ -43,13 +43,13 @@ Environment variables are loaded from any `env` file if present.
 
 - **VPN_USERNAME** - Username to access `OpenVPN Connect` client.
 - **VPN_PASSWORD** - Password to access `OpenVPN Connect` client.
-- **VPN_PORT** - Port number for web interfaces.
+- **VPN_PORT** - Port number for web interfaces. Defaults to `943`
 
-- **IMAGE_ID** - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for [OpenVPN Access Server AMI Alias][AMI_ALIAS].
-- **INSTANCE_TYPE** - Instance type to use for the VPN server. Defaults to `t2.nano`, use `t2.micro` if under [free-tier](https://aws.amazon.com/free).
-- **KEY_PAIR** - Name of the key pair file to connect to ec2.
-- **SECURITY_GROUP** - Name of the security group.
-- **VPN_INFO** - Name of the JSON file to dump the server information.
+- **IMAGE_ID** - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for [OpenVPN Access Server AMI Alias][AMI_ALIAS]
+- **INSTANCE_TYPE** - Instance type to use for the VPN server. Defaults to `t2.micro` _(minimum memory requirement is 1 GiB)_
+- **KEY_PAIR** - Name of the key pair file to connect to ec2. Defaults to `OpenVPN`
+- **SECURITY_GROUP** - Name of the security group. Defaults to `OpenVPN Access Server`
+- **VPN_INFO** - Name of the JSON file to dump the server information. Defaults to `vpn_info.json`
 - **HOSTED_ZONE** - Domain name for the hosted zone.
 - **SUBDOMAIN** - Alias record name using which the VPN server has to be accessed.
 

docs/README.html

@@ -96,12 +96,12 @@ <h2>ENV Variables<a class="headerlink" href="#env-variables" title="Permalink to
 <summary><strong>More on Environment variables</strong></summary><ul class="simple">
 <li><p><strong>VPN_USERNAME</strong> - Username to access <code class="docutils literal notranslate"><span class="pre">OpenVPN</span> <span class="pre">Connect</span></code> client.</p></li>
 <li><p><strong>VPN_PASSWORD</strong> - Password to access <code class="docutils literal notranslate"><span class="pre">OpenVPN</span> <span class="pre">Connect</span></code> client.</p></li>
-<li><p><strong>VPN_PORT</strong> - Port number for web interfaces.</p></li>
-<li><p><strong>IMAGE_ID</strong> - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for <a class="reference external" href="https://aws.amazon.com/marketplace/server/configuration?productId=fe8020db-5343-4c43-9e65-5ed4a825c931#:~:text=Ami%20Alias">OpenVPN Access Server AMI Alias</a>.</p></li>
-<li><p><strong>INSTANCE_TYPE</strong> - Instance type to use for the VPN server. Defaults to <code class="docutils literal notranslate"><span class="pre">t2.nano</span></code>, use <code class="docutils literal notranslate"><span class="pre">t2.micro</span></code> if under <a class="reference external" href="https://aws.amazon.com/free">free-tier</a>.</p></li>
-<li><p><strong>KEY_PAIR</strong> - Name of the key pair file to connect to ec2.</p></li>
-<li><p><strong>SECURITY_GROUP</strong> - Name of the security group.</p></li>
-<li><p><strong>VPN_INFO</strong> - Name of the JSON file to dump the server information.</p></li>
+<li><p><strong>VPN_PORT</strong> - Port number for web interfaces. Defaults to <code class="docutils literal notranslate"><span class="pre">943</span></code></p></li>
+<li><p><strong>IMAGE_ID</strong> - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for <a class="reference external" href="https://aws.amazon.com/marketplace/server/configuration?productId=fe8020db-5343-4c43-9e65-5ed4a825c931#:~:text=Ami%20Alias">OpenVPN Access Server AMI Alias</a></p></li>
+<li><p><strong>INSTANCE_TYPE</strong> - Instance type to use for the VPN server. Defaults to <code class="docutils literal notranslate"><span class="pre">t2.micro</span></code> <em>(minimum memory requirement is 1 GiB)</em></p></li>
+<li><p><strong>KEY_PAIR</strong> - Name of the key pair file to connect to ec2. Defaults to <code class="docutils literal notranslate"><span class="pre">OpenVPN</span></code></p></li>
+<li><p><strong>SECURITY_GROUP</strong> - Name of the security group. Defaults to <code class="docutils literal notranslate"><span class="pre">OpenVPN</span> <span class="pre">Access</span> <span class="pre">Server</span></code></p></li>
+<li><p><strong>VPN_INFO</strong> - Name of the JSON file to dump the server information. Defaults to <code class="docutils literal notranslate"><span class="pre">vpn_info.json</span></code></p></li>
 <li><p><strong>HOSTED_ZONE</strong> - Domain name for the hosted zone.</p></li>
 <li><p><strong>SUBDOMAIN</strong> - Alias record name using which the VPN server has to be accessed.</p></li>
 </ul>

docs/_sources/README.md.txt

@@ -43,13 +43,13 @@ Environment variables are loaded from any `env` file if present.
 
 - **VPN_USERNAME** - Username to access `OpenVPN Connect` client.
 - **VPN_PASSWORD** - Password to access `OpenVPN Connect` client.
-- **VPN_PORT** - Port number for web interfaces.
+- **VPN_PORT** - Port number for web interfaces. Defaults to `943`
 
-- **IMAGE_ID** - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for [OpenVPN Access Server AMI Alias][AMI_ALIAS].
-- **INSTANCE_TYPE** - Instance type to use for the VPN server. Defaults to `t2.nano`, use `t2.micro` if under [free-tier](https://aws.amazon.com/free).
-- **KEY_PAIR** - Name of the key pair file to connect to ec2.
-- **SECURITY_GROUP** - Name of the security group.
-- **VPN_INFO** - Name of the JSON file to dump the server information.
+- **IMAGE_ID** - AMI ID to be used. Defaults to a pre-built AMI from SSM parameter for [OpenVPN Access Server AMI Alias][AMI_ALIAS]
+- **INSTANCE_TYPE** - Instance type to use for the VPN server. Defaults to `t2.micro` _(minimum memory requirement is 1 GiB)_
+- **KEY_PAIR** - Name of the key pair file to connect to ec2. Defaults to `OpenVPN`
+- **SECURITY_GROUP** - Name of the security group. Defaults to `OpenVPN Access Server`
+- **VPN_INFO** - Name of the JSON file to dump the server information. Defaults to `vpn_info.json`
 - **HOSTED_ZONE** - Domain name for the hosted zone.
 - **SUBDOMAIN** - Alias record name using which the VPN server has to be accessed.
 

release_notes.rst

@@ -1,6 +1,10 @@
 Release Notes
 =============
 
+1.3.2 (09/26/2023)
+------------------
+- Includes minor improvements for increased compatibility
+
 1.3 (09/25/2023)
 ----------------
 - Includes bug fixes and upgrades to latest OpenVPN Access Server version

vpn/__init__.py

@@ -1,6 +1,7 @@
 """Place holder for package."""
 
 from vpn.main import VPNServer  # noqa: F401
-from vpn.models import util  # noqa: F401
+from vpn.models import (config, exceptions, image_factory,  # noqa: F401
+                        logger, route53, server, util)
 
-version = "1.3"
+version = "1.3.2"