Skip to content

Commit

Permalink
chore(readme): update command line output
Browse files Browse the repository at this point in the history
  • Loading branch information
luizfonseca committed May 15, 2024
1 parent 27c97b9 commit 737d95c
Showing 1 changed file with 40 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Proksi is a simple, lightweight, and easy-to-use proxy server that automatically
- [Middlewares/Plugins](#middlewaresplugins)
- [Extending Proksi](#extending-proksi)
- [Configuration](#configuration)
- [YAML/TOML Configuration](#yamltoml-configuration)
- [Environment variables](#environment-variables)
- [Examples](#examples)
- [Performance \& Benchmarks](#performance--benchmarks)
- [Why build another proxy...?](#why-build-another-proxy)
Expand Down Expand Up @@ -85,17 +87,46 @@ proksi -c config.yaml --service_name=proksi
Running `proksi --help` will provide you with the available options.

```bash
A batteries-included reverse proxy with automatic HTTPS using Cloudflare Pingora and Let's Encrypt.
Usage: proksi [OPTIONS]
Options:
-s, --service-name <SERVICE_NAME> The name of the service (will appear as a log property) [default: proksi]
--level <LEVEL> The level of logging to be used [default: info] [possible values: debug, info, warn, error]
--access-logs-enabled Whether to log access logs (request, duration, headers etc)
--error-logs-enabled Whether to log error logs (errors, panics, etc) from the rust runtime
-h, --help Print help
-V, --version Print version
-s, --service-name <SERVICE_NAME>
The name of the service (will appear as a log property)
[default: proksi]
-w, --worker-threads <WORKER_THREADS>
The number of worker threads to be used by the HTTPS proxy service.
For background services the default is always (1) and cannot be changed.
[default: 1]
-c, --config-path <CONFIG_PATH>
The PATH to the configuration file to be used.
The configuration file should be named either proksi.toml, proksi.yaml or proksi.yml
and be present in that path. Defaults to the current directory.
[default: ./]
--level <LEVEL>
The level of logging to be used
[default: info]
[possible values: debug, info, warn, error]
--access-logs-enabled
Whether to log access logs (request, duration, headers etc)
--error-logs-enabled
Whether to log error logs (errors, panics, etc) from the Rust runtime
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```


Expand Down

0 comments on commit 737d95c

Please sign in to comment.