Add documentation for config format

1 files changed, 46 insertions, 0 deletions

diff --git a/doc/config b/doc/config
new file mode 100644
index 0000000..9942eec
--- /dev/null
+++ b/doc/config
@@ -0,0 +1,46 @@
+## File to log messages to, if not set syslog is used
+# logfile =
+
+## Set address for the proxy to listen to, default is all
+# proxy_bind =
+
+## Set port for the proxy to listen to
+# proxy_port = 8080
+
+## Set max number of concurrent client connections
+# max_clients = 1024
+
+## Set max number of monitor client connections
+# max_monitors = 2
+
+## Set to true to allow monitor connections
+# monitor = false
+
+## If monitor is enabled, set address for the monitor to listen to
+# monitor_bind = localhost
+
+## If monitor is enabled, set port for the monitor to listen to
+# monitor_port = 9000
+
+## Monitors get the proxied request and response exactly as it was sent to the
+## proxy and not how it would have looked without the proxy inbetween
+# monitor_proxy_request = false
+
+## If SSL support is compiled in
+
+## SSL certificate bundle to use to verify proxy SSL connections to remote
+## servers. If not set, SSL interception is disabled.
+# ssl_cert_bundle =
+
+## SSL certificate authority to use to sign generated certificates for
+## intercepted connections. If not set, SSL interception is disabled.
+# ssl_ca_cert =
+
+## SSL private key that signed the certificate authority and to use to sign
+## generated certificates for intercepted connections.
+## If not set, SSL interception is disabled.
+# ssl_ca_key =
+
+## SSL unsecure, set to true to allow insecure connections such as SSLv3
+## and missmatched hosts and certificates
+# ssl_unsecure = false
\ No newline at end of file