https://github.com/tytan-codes/simplevpn
The VPN Connect script simplifies OpenVPN connections and offers a user-friendly interface
https://github.com/tytan-codes/simplevpn
collaborate communityexchange dashlane ghdesktop github github-codespaces github-pages jetbrains learn microsoft microsoftvisualstudio openvpn openvpn-client openvpn-configuration openvpn-server student-vscode termius travis tytancodes
Last synced: 6 months ago
JSON representation
The VPN Connect script simplifies OpenVPN connections and offers a user-friendly interface
- Host: GitHub
- URL: https://github.com/tytan-codes/simplevpn
- Owner: Tytan-Codes
- License: mit
- Created: 2023-05-31T18:35:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-31T18:50:31.000Z (over 2 years ago)
- Last Synced: 2025-02-14T21:54:56.162Z (8 months ago)
- Topics: collaborate, communityexchange, dashlane, ghdesktop, github, github-codespaces, github-pages, jetbrains, learn, microsoft, microsoftvisualstudio, openvpn, openvpn-client, openvpn-configuration, openvpn-server, student-vscode, termius, travis, tytancodes
- Language: Python
- Homepage:
- Size: 7.81 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# simpleVPN :rocket:
This script allows you to easily connect to and disconnect from an OpenVPN server using a YAML configuration file.
## Prerequisites
- Python 3.x installed
- `pyyaml` module installed (`pip install pyyaml`)
- `sudo` access to run the script with administrative privileges
## Installation
1. Clone the repository or download the `vpn_connect.py` script to your local machine.
2. Install the required Python module:
```shell
pip install pyyaml
```
## Usage
1. Create a YAML configuration file with the VPN details.
Example YAML file (`vpn_config.yml`):
```yaml
USA:
path to file: /home/user/vpns/usa.ovpn
username: 118fcg0b10999b742796q7fd0551b77d
password: 0000000021dbc5ce8b4555d92d6wsc5f7a38079836e7e986
```
Make sure to replace the placeholders with the actual values of your VPN configuration.
2. To connect to the VPN:
```shell
python vpn.py vpn_config.yml connect
```
The script will read the configuration file and establish the VPN connection in the background.
3. To disconnect from the VPN:
```shell
python vpn_connect.py disconnect
```
The script will terminate the OpenVPN connection.
## Troubleshooting
- If you encounter any errors while running the script, please ensure that you have the necessary permissions to run the script with `sudo`.
- Double-check your YAML configuration file for any formatting issues. Ensure that the indentation is done using tabs (not spaces) consistently.
## Contributing
Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).