-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from openziti/markdown-nits
lint samples readme
- Loading branch information
Showing
1 changed file
with
11 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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=<enrollment token file> --identity=<identity file> | ||
python -m openziti enroll --jwt=<enrollment token file> --identity=<identity file> | ||
``` | ||
|
||
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=<path to id.json>` | ||
|
||
# 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. | ||
and using Ziti overlay. |