From 4fc48f7722916d6173683d6ce56c308ee7c9c2c2 Mon Sep 17 00:00:00 2001 From: Daniel Dayley Date: Thu, 7 Nov 2024 13:04:20 -0700 Subject: [PATCH] Updated README Cleaned unused argument hints --- README.md | 15 ++++++++++----- bin/headercheckdashboardproxy | 2 -- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index db639a9..cb7866a 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,25 @@ ## Usage ``` - +headercheckdashboardproxy ``` ## Installation -1. -2. -3. +1. `git clone https://git.cronocide.net/Cronocide/headercheckdashboardproxy.git` +2. `pip3 install -e headercheckdashboardproxy` +3. `headercheckdashboardproxy` ## Configuration ``` - +INDEX_FILE The filename to serve up on / (relative to CWD) +GROUPS_HEADER The header to use to compare group information from +USER_HEADER The header to use to compare user information from +BIND_PORT The TCP port to listen on ``` ## Justification +This is a quick, crappy, and terribly embarrasing little proxy that filters out a apps on a pre-rendered dashboard (not included) using HTTP request headers passed to it by an upstream authentication proxy. +Components in the HTML that don't match the users or groups headers included in the request are removed from the HTML. That's it. That's all this does. A bit stupid, isn't it? diff --git a/bin/headercheckdashboardproxy b/bin/headercheckdashboardproxy index be4133e..a7aa114 100644 --- a/bin/headercheckdashboardproxy +++ b/bin/headercheckdashboardproxy @@ -87,8 +87,6 @@ if __name__ == '__main__': # Gather Argument options EXAMPLE_TEXT='Example:\n\theadercheckdashboardproxy -h' parser = argparse.ArgumentParser(epilog=EXAMPLE_TEXT,formatter_class=argparse.RawDescriptionHelpFormatter) - parser.add_argument('-H', '--hosts', action='append', default=None, help='Collects arguments in an array.') - parser.add_argument('-d', '--dry-run', action='store_true', help='Store the existence of a variable.') parser.add_argument('-l', '--log', action='store', help='Specify a file to log to.') parser.add_argument('-v', '--verbose', action='count', help='Include verbose information in the output. Add \'v\'s for more output.',default=0) args = parser.parse_args()