Skip to main content

A simple CLI app to run Outline VPN keys

Project description

PyOutline: CLI app to start Outline VPN keys

With PyOutline you can easily run ShadowSocks proxy from the Outline keys.

Installation

PIP (PyPI)

pip install pyoutline

With clone from GitHub

git clone https://github.com/NonProjects/pyoutline
pip install ./pyoutline

Optional requirements

You can install latest Shadowsocks if you're on Linux:

apt install shadowsocks-libev # e.g Debian

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyoutline-0.4.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyoutline-0.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file pyoutline-0.4.tar.gz.

File metadata

  • Download URL: pyoutline-0.4.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for pyoutline-0.4.tar.gz
Algorithm Hash digest
SHA256 4ce9bceec7907be200856e7f141e568310e7b2803b41a24841d663f17e756ada
MD5 2ef004121394ca474a95525ef3f5a6a4
BLAKE2b-256 7d5ce93ccd8d33d60aa23c9ef0b18dee1061c4e8da69f1afdc73cfdebe4610c6

See more details on using hashes here.

File details

Details for the file pyoutline-0.4-py3-none-any.whl.

File metadata

  • Download URL: pyoutline-0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for pyoutline-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4f1ba2b27f911b467d7be0c81871438b613e6b562d8752c43a64787d6c2d8e0f
MD5 5272facedef32d56803b1736c1b78fb0
BLAKE2b-256 020eea224d53cca976464bcfd7536818a94dd170a0a3fec02124902356671cb1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page