Skip to content

Commit 95fc08e

Browse files
readme
1 parent a28ed84 commit 95fc08e

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ re = Relay(
208208
port=3000, # this must be the same on your Relay and Endpoints
209209
password="VerySecurePassword", # this must be the same on Relay and Endpoints, AND be strong
210210
local_com_port=3001, # this needs to be non-overlapping if Relays/Endpoints live on the same machine
211-
security="TLS" # this is the default; replace by "TCP" if you do not want to use TLS
211+
security="TLS" # this is the default; replace by None if you do not want to use TLS
212212
)
213213
```
214214
As soon as your `Relay` is created, it is up and running.
@@ -230,7 +230,7 @@ prod = Endpoint(
230230
password="VerySecurePassword", # must be same (strong) password as the Relay
231231
groups="producers", # this endpoint is part of the group "producers"
232232
local_com_port=3002, # must be unique
233-
security="TLS" # this is the default; replace by "TCP" if you do not want to use TLS
233+
security="TLS" # this is the default; replace by None if you do not want to use TLS
234234
)
235235

236236
# Initialize consumer endpoints
@@ -359,7 +359,7 @@ By default, `tlspyo` uses `pickle` for serialization and relies on TLS to preven
359359
In advanced application, you may want to use another serialization protocol instead.
360360
For instance, you may want to transfer non-picklable objects, or further optimize the security of your application.
361361

362-
**In particular, in `security="TCP"` mode (i.e., with TLS disabled) over a public network, using your own secure serialization protocol is critical.**
362+
**In particular, in `security=None` mode (i.e., with TLS disabled) over a public network, using your own secure serialization protocol is critical.**
363363

364364
`tlspyo` makes this easy.
365365
All you need to do is code your own serialization protocol following the `pickle.dumps`/`pickle.loads` signature, and pass it to the `serializer`/`deserializer` arguments of both your `Relay` and `Endpoints`.

0 commit comments

Comments
 (0)