Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nonprojects/pyoutline
A simple CLI app to run Outline VPN keys
https://github.com/nonprojects/pyoutline
outline outline-vpn python3 shadowsocks
Last synced: about 1 month ago
JSON representation
A simple CLI app to run Outline VPN keys
- Host: GitHub
- URL: https://github.com/nonprojects/pyoutline
- Owner: NonProjects
- License: mit
- Created: 2022-08-09T20:54:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-11T17:39:52.000Z (about 2 years ago)
- Last Synced: 2024-04-26T08:47:08.464Z (7 months ago)
- Topics: outline, outline-vpn, python3, shadowsocks
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyOutline: CLI app to start Outline VPN keys
With **PyOutline** you can easily run [ShadowSocks proxy](https://en.wikipedia.org/wiki/Shadowsocks) from the [**Outline keys**](https://getoutline.me/access-keys/).
## Installation
**PIP** ([PyPI](https://pypi.org/project/pyoutline/))
```
pip install pyoutline
```
**With clone from GitHub**
```
git clone https://github.com/NonProjects/pyoutline
pip install ./pyoutline
```
## Requirements
You will need ShadowSocks. Install it via PIP:
```
pip install https://github.com/shadowsocks/shadowsocks/archive/5ff694b2c2978b432918dea6ac104706b25cbf48.zip
```
You can also install it via your packet manager if you're on Linux:
```
apt install shadowsocks-libev # Debian 11
```
## Usage
The "*How to use*" is pretty simple:
```
pyoutline client -k "ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118"
```
If you want to transform Outline Key into the ss-local string:
```
pyoutline to-ss -k "ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118"
# ^ ss-local -s "ak1344.free.www.outline.network" -p 8118 -k "cdBIDV42DCwnfIN" -m "aes-256-gcm" -l 53735
```
Set your own port or ask system to set the free one
```
pyoutline client -p 50000 # Set port 50000, script will ask you for Key
pyoutline client -r # Get a random port, script will ask you for Key
```
You can also specify keys from the file. First working Key will be used:
```
pyoutline client -k /home/user/outline_keys.txt
```
The insides of the file with keys should be placed like this:
```
ss://YWVzLTI1Ni1nY206Y2RCSURWNDJEQ3duZklO@ak1344.free.www.outline.network:8118
ss://YWVzLTI1Ni1nY206VEV6amZBWXEySWp0dW9T@ak1343.free.www.outline.network:6679
ss://Y2hhY2hhMjAtaWV0Zi1wb2x5MTMwNTpHIXlCd1BXSDNWYW8=@ak1338.free.www.outline.network:810
```