Updated README
Cleaned unused argument hints
This commit is contained in:
parent
fcf20a1b25
commit
4fc48f7722
15
README.md
15
README.md
@ -4,20 +4,25 @@
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
|
headercheckdashboardproxy
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1.
|
1. `git clone https://git.cronocide.net/Cronocide/headercheckdashboardproxy.git`
|
||||||
2.
|
2. `pip3 install -e headercheckdashboardproxy`
|
||||||
3.
|
3. `headercheckdashboardproxy`
|
||||||
|
|
||||||
## Configuration
|
## 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
|
## 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?
|
||||||
|
@ -87,8 +87,6 @@ if __name__ == '__main__':
|
|||||||
# Gather Argument options
|
# Gather Argument options
|
||||||
EXAMPLE_TEXT='Example:\n\theadercheckdashboardproxy -h'
|
EXAMPLE_TEXT='Example:\n\theadercheckdashboardproxy -h'
|
||||||
parser = argparse.ArgumentParser(epilog=EXAMPLE_TEXT,formatter_class=argparse.RawDescriptionHelpFormatter)
|
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('-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)
|
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()
|
args = parser.parse_args()
|
||||||
|
Loading…
Reference in New Issue
Block a user