Skip to content

Commit 00c0279

Browse files
committed
docs: Updated README.md with additional optional steps
1 parent 4e35d4c commit 00c0279

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ To use this action, you need to provide the necessary configuration details for
1919
config: ${{ secrets.VPN_SERVER_CONFIG }}
2020
certificate: ${{ secrets.VPN_CERTIFICATE }}
2121
certificate_name: ${{ secrets.VPN_CERTIFICATE_NAME }}
22+
23+
- name: Wait for VPN to connect
24+
if: success()
25+
run: until ping -c 1 -W 5 172.16.0.61; do sleep 2; done
26+
27+
- name: Upload VPN logs
28+
if: always()
29+
uses: actions/upload-artifact@v2
30+
with:
31+
name: vpn-logs
32+
path: openvpn.log
2233
```
2334
2435
Make sure to store your sensitive information (such as the config, certificate, and certificate_name) as secrets in your GitHub repository to keep them secure.
@@ -36,4 +47,6 @@ Replace `<file_name>` with the name of the file you want to encode. The encoded
3647

3748
Remember to replace `<file_name>` with the actual name of the file you want to encode.
3849

50+
The optional `Upload VPN logs` step allows you to see logs from the OpenVPN process and debug where needed.
51+
3952
For more information on how to use this action, please refer to the [GitHub Action documentation](https://docs.github.com/actions).

0 commit comments

Comments
 (0)