From 8fc8515a0ae44a8e899eae02dd2c992ad1343ccf Mon Sep 17 00:00:00 2001 From: Jacob Brewer Date: Mon, 26 Feb 2024 08:51:32 +0000 Subject: [PATCH] chore(docs): Correcting the Authentication in the docs (#82) Correcting the Authentication in the docs --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 34da87b2..2ebceaa2 100644 --- a/README.md +++ b/README.md @@ -89,14 +89,11 @@ GCS_CREDENTIALS= _Coming soon_ -#### Secure Upload +#### Endpoint Authentication ```shell -./puppet-summary -upload-token +./puppet-summary -auth-token ``` -This will enable the `/upload` endpoint to only accept requests that have this Bearer token in the `Authorization` -header. This is useful if you want to prevent any unauthorised requests to the `/upload` endpoint. One architecture -pattern that you could use is to have a proxy in front of the Puppet Summary application that will handle the -authentication and then forward the request to the Puppet Summary application with the Bearer token in the -`Authorization` header. +This will enable the security on the endpoints that use the authentication method `AuthOptionRequired`. This includes +the `/upload`. If the token is not provided, there will be no security on the endpoints.