diff --git a/sample/README.md b/sample/README.md index cfdbf89..894bed1 100644 --- a/sample/README.md +++ b/sample/README.md @@ -1,33 +1,34 @@ -OpenZiti Python SDK in Action ---------------- +# OpenZiti Python SDK in Action -# Setup +## Setup - install Python requirements `pip install -r requirements` - - get yourself a Ziti identity from [ZEDS](https://zeds.openziti.org) follow enrollment instructions from the site, or better yet enroll with openziti Python module + ```bash - $ python -m openziti enroll --jwt= --identity= + python -m openziti enroll --jwt= --identity= ``` the following instructions assume that Ziti identity is stored in `id.json` file - - set `ZITI_IDENTITIES` environment variable to location of `id.json` file `export ZITI_IDENTITIES=` -# Run Samples! +## Run Samples + All sample scripts use predefined services in [ZEDS](https://zeds.openziti.org) -## ziti-socket-sample.py +### ziti-socket-sample.py + Shows the use of _raw_ Ziti socket. -## h-ziti-p.py +### h-ziti-p.py + Shows the use of Ziti monkeypatching standard socket to intercept network connections - and using Ziti overlay. \ No newline at end of file + and using Ziti overlay.