From 76926fa6f62a61ad3574a3be98a1907dae58a49c Mon Sep 17 00:00:00 2001 From: Adam Gardner <26523841+agardnerIT@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:40:22 +1000 Subject: [PATCH] readme and insecure flag docs fixed --- README.md | 4 ++++ docs/reference/insecure-flag.md | 21 +++++++++++---------- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 50d99dc..ff69be8 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,10 @@ If you like tracepusher and want to do the same thing with logs, check out [logp See [try tracepusher in-browser without installation](https://agardnerit.github.io/tracepusher/try/). +## Standalone Binary + +See [download and use tracepusher as a standalone binary](https://agardnerit.github.io/tracepusher/usage/standalone.md) + ## Python3 Usage See [use tracepusher as a Python script](https://agardnerit.github.io/tracepusher/usage/python). diff --git a/docs/reference/insecure-flag.md b/docs/reference/insecure-flag.md index da2aadc..6ec1f74 100644 --- a/docs/reference/insecure-flag.md +++ b/docs/reference/insecure-flag.md @@ -18,22 +18,23 @@ The `--insecure` is not available The `--insecure` flag defaults to `false` with the intention of meaning insecure endpoints are not allowed. However, to provide ample migration time for end users, the behaviour is as follows: -- `--insecure` flag is omitted +#### `--insecure` flag is omitted - This is the expected behaviour of everyone migrating from v0.8 to v0.9. - The flag defaults to `false` BUT will still allow `http://` endpoints, just like before. +This is the expected behaviour of everyone migrating from v0.8 to v0.9. + +The flag defaults to `false` BUT will still allow `http://` endpoints, just like before. - Tracepusher will emit a soft `WARNING` message to inform users of the upcoming breaking change, like this: +Tracepusher will emit a soft `WARNING` message to inform users of the upcoming breaking change, like this: - ``` - WARN: --insecure flag is omitted or is set to false. Prior to v1.0 tracepusher still works as expected (span is sent). In v1.0 and above, you MUST set '--insecure true' if you want to send to an http:// endpoint. See https://github.com/agardnerIT/tracepusher/issues/78 - ``` +``` +WARN: --insecure flag is omitted or is set to false. Prior to v1.0 tracepusher still works as expected (span is sent). In v1.0 and above, you MUST set '--insecure true' if you want to send to an http:// endpoint. See https://github.com/agardnerIT/tracepusher/issues/78 +``` -- `--insecure` flag is explicitly set to false +#### `--insecure` flag is explicitly set to false - From v0.9 upwards, users are encouraged to get into the best practice habit of explicitly setting this to `false` or `true`. +From v0.9 upwards, users are encouraged to get into the best practice habit of explicitly setting this to `false` or `true`. - Otherwise, for v0.9.*, the behaviour is as above. +Otherwise, for v0.9.*, the behaviour is as above. ### v1.0