react-native-outline-vpn

Outline React Native Android & iOS Client

Installation

npm install react-native-outline-vpn

or

yarn add react-native-outline-vpn

Usage

Starting VPN

import Outline from 'react-native-outline-vpn';
// THIS VPN INFORMATIONS INTENTIONALLY LEFT EXPOSED, HAS 0 MB LIMIT SO CANNOT ACCESS INTERNET BUT COULD BE USE FOR TEST VPN CONNECTION

// Start VPN
Outline.startVpn({
	host:'185.218.124.25',
	port: 42248,
	password: 'FQZV7mWkAB3l7pzg7tpv9p',
	method: 'chacha20-ietf-poly1305',
	prefix: '\u0005\u00DC\u005F\u00E0\u0001\u0020', //vpn prefix
	providerBundleIdentifier: 'org.reactjs.native.example.OutlineVpnExample.OutlineVpn', //apple bundle identifier declared step-2 on guide
	serverAddress: 'OutlineServer', //can be any string which user see MyPreciousVpn
	tunnelId: 'OutlineTunnel', //can be random string
	localizedDescription: 'OutlineVpn', //can be random string
});

// Stop VPN
Outline.stopVpn();

Android hasn't need any additional configuration, but iOS needs some additional configuration. Please check the documentation for more information.

Detailed documentation page: Documentation

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Made with create-react-native-library