make VPN optional in deployment

Author: guFalcon

.github/workflows/docs-local.yml

@@ -74,15 +74,19 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@v4
       - name: Install OpenVPN
+        if: ${{ secrets.NO_VPN != 'true' }}
         run: |
           sudo apt update
           sudo apt install -y openvpn openvpn-systemd-resolved
       - name: Touch OVPN client-config file
+        if: ${{ secrets.NO_VPN != 'true' }}
         run: touch client.ovpn
       - name: Fill OVPN client-config file
+        if: ${{ secrets.NO_VPN != 'true' }}
         run: |
             echo "${{ secrets.VPN_OVPN_FILE }}" >> client.ovpn
       - name: Connect to VPN 🔓
+        if: ${{ secrets.NO_VPN != 'true' }}
         uses: "kota65535/github-openvpn-connect-action@v3"
         with:
           config_file: client.ovpn

docs-building.md

@@ -42,6 +42,7 @@ To build, there is a Github action in this repository, but in order to configure
 | PORT                   | -> `.env`<br>The port your web-server will be accessible when started later on (for example: `8080`).<br>This variable will be written to a newly generated `.env` file that will reside in the root-directory of the node web-server.<br>So that port is INSIDE this web-servers' docker-image that is created.                                                                                                |
 | WEBSERVER_PORT         | This is the EXTERNAL port of the web-server that is created.<br>This port must be unique and accessible on the deployment-machine.                                                                                                                                                                                                                                                                              |
 | AUTOSCAN               | Starts a file-watcher on the markdown-directory on the server so that all changes within that folder will trigger a re-scan of all files available to the server. This only makes sense, if you plan on changing content without re-starting (-building). That would be the case when you're debugging, or if you're running a WYSIWYG docker-container of the server locally.                                  |
+| NO_VPN                 | Set to 'true' if you'd like to skip the VPN-setup entirely. This is useful, if your SSH-access isn't hidden behind an OpenVPN. Defaults to '' and thus is false per default).                                                                                                                                                                                                                                   |
 | VPN_OVPN_FILE          | The OVPN file of your Open VPN configuration. This is used to reach the deployment-server (target host) to start conversation via SSH.                                                                                                                                                                                                                                                                          |
 | VPN_PASSWORD           | The password of your VPN connection.                                                                                                                                                                                                                                                                                                                                                                            |
 | VPN_SERVER             | The server to call for opening your VPN connection.                                                                                                                                                                                                                                                                                                                                                             |