Skip to content

Commit ceef2f0

Browse files
Update README.md
Added information about standalone scripts.
1 parent 0af5542 commit ceef2f0

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

+34-3
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,37 @@ be established between server 127.0.0.1:7000 and clients 127.0.0.1:8000/8001/800
4444

4545
# obfs4-standalone-tunnel
4646

47-
Documentation WIP. Use `standalone-server.py` for server and
48-
`standalone-client.py` for client. Also see respective `-config.ini` files for
49-
commented example configurations.
47+
The two scripts, `standalone_server.py` and `standalone_client.py`, are wrappers
48+
around the `pluggabletransportadapter` libary. They allow running pluggable
49+
transports such as `obfs4proxy` as standalone servers and clients, creating
50+
obfuscated tunnels carrying TCP traffic.
51+
52+
## Requirements
53+
54+
To use these scripts, you'll need:
55+
56+
* The scripts themselves. Check the
57+
[Releases section](https://github.com/twisteroidambassador/pluggabletransportadapter/releases)
58+
for archives containing only the essentials, or do a `git checkout` for everything.
59+
60+
* A compiled binary of the pluggable transport you wish to use. On many Linux
61+
distributions you can install them from the package repository. For Windows, it
62+
might be easiest to extract the binary from Tor Browser Bundle.
63+
64+
* Python 3 for your operating system.
65+
66+
* For the client, [`rsocks`](https://pypi.python.org/pypi/rsocks/0.2.2). Install
67+
it with `pip`.
68+
69+
## Configuration
70+
71+
The provided config files are commented in detail, and intended for testing.
72+
Follow them to write your own config files, but do not use them as-is.
73+
74+
In particular, these provided files contain
75+
matching keys so an `obfs4` clients can authenticate and talk to the server.
76+
**DO NOT use those keys for your own servers!** For `obfs4`, you *do not* need to
77+
specify keys in the configuration file. Just make sure the states directory is
78+
persistent and writable. After first run, the server will save its keys to the
79+
states directory and read it from there for future runs. It will also write the
80+
appropriate client parameters there.

0 commit comments

Comments
 (0)