Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vilicvane/lucky-vpn
Windows-friendly utilities that generate automation scripts for VPN connection.
https://github.com/vilicvane/lucky-vpn
gfw
Last synced: about 1 month ago
JSON representation
Windows-friendly utilities that generate automation scripts for VPN connection.
- Host: GitHub
- URL: https://github.com/vilicvane/lucky-vpn
- Owner: vilicvane
- Created: 2017-02-25T23:50:59.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-10T01:33:06.000Z (over 7 years ago)
- Last Synced: 2024-11-30T15:41:57.088Z (about 1 month ago)
- Topics: gfw
- Language: TypeScript
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lucky VPN
Heavily inspired by [chnroutes](https://github.com/fivesheep/chnroutes).
Most features are currently Windows only, you may use `lvpn generate -u` to generate `routes.txt` that contains networks allocated for China though.
## Installation
```sh
npm install -g lucky-vpn
```
## Usage
```sh
lvpn generate "VPN Connection Name"
.\vpn-up.bat
.\vpn-down.bat
# Try following commands for more usage information
lvpn generate --help
lvpn route --help
```
Note that `vpn-up.bat` will automatically add routes, but `vpn-down.bat` won't delete routes added.
Run `.\route-delete.bat` manually if you wish.
It is recommanded to leave it there though, as it takes some time to add or remove.
### Phonebook
If you have a `.pbk` file from your VPN provider, you may try `-b` option.
### DNS Overriding
If you want to override DNS specified by the VPN provider, you may try `-d` option.
If there are multiple DNS servers to specify, use `,` to separate.
### Tips
- Use Lucky VPN along with [Lucky DNS](https://github.com/vilic/lucky-dns) (the goal is similar to [ChinaDNS](https://github.com/shadowsocks/ChinaDNS) but it's Windows-friendly) to get even better experience.
- Reduce the number of routes generated by `-s` option. For example, `-s 2048` to filter routes with network length shorter than `2048`.
- Add a task to Task Scheduler to run `vpn-up.bat` or `route-add.bat` on network connection.
> Check out the [task template](res/win32/tasks/task-connect.xml) you may import to Task Scheduler.
## Build
```sh
npm run build
```
## License
MIT License.