declutter top-level files into extra/

3 files changed, 100 insertions, 0 deletions

diff --git a/extra/es-public-proxy.1 b/extra/es-public-proxy.1
new file mode 100644
index 0000000..ee12f43
--- /dev/null
+++ b/extra/es-public-proxy.1
@@ -0,0 +1,52 @@
+.\" Generated by scdoc 1.9.0
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "es-public-proxy" "1" "2020-08-26" "es-public-proxy Manual Page"
+.P
+.SH NAME
+.P
+es-public-proxy - something something
+.P
+.SH SYNOPSIS
+.P
+es-public-proxy --config CONFIGFILE
+.P
+.SH DESCRIPTION
+.P
+.SH OPTIONS
+.P
+Argument processing is crude; only one option can be specified at a time.
+.P
+\fB-h, --help\fR
+.RS 4
+Prints help information
+.P
+.RE
+\fB-V, --version\fR
+.RS 4
+Prints version information
+.P
+.RE
+\fB--config <file>\fR [env: ES_PUBLIC_PROXY_CONFIG_PATH]
+.RS 4
+Supply path to configuration file (TOML), which is effectively required for operation
+.P
+.RE
+\fB--example-config\fR
+.RS 4
+An annotated config file (TOML) will be printed to standard out.
+.P
+.RE
+.SH EXAMPLES
+.P
+Some examples of usage will go here.
+.P
+.RS 4
+es-public-proxy --example-config > /etc/es_public_proxy.toml
+.P
+es-public-proxy --config /etc/es_public_proxy.toml
+.P
+.RE
diff --git a/extra/es-public-proxy.1.scdoc b/extra/es-public-proxy.1.scdoc
new file mode 100644
index 0000000..00104d9
--- /dev/null
+++ b/extra/es-public-proxy.1.scdoc
@@ -0,0 +1,36 @@
+es-public-proxy(1) "es-public-proxy Manual Page"
+
+# NAME
+
+es-public-proxy - something something
+
+# SYNOPSIS
+
+es-public-proxy --config CONFIGFILE
+
+# DESCRIPTION
+
+# OPTIONS
+
+Argument processing is crude; only one option can be specified at a time.
+
+*-h, --help*
+	Prints help information
+
+*-V, --version*
+	Prints version information
+
+*--config <file>* [env: ES_PUBLIC_PROXY_CONFIG_PATH]
+	Supply path to configuration file (TOML), which is effectively required for operation
+
+*--example-config*
+	An annotated config file (TOML) will be printed to standard out.
+
+# EXAMPLES
+
+Some examples of usage will go here.
+
+	es-public-proxy --example-config > /etc/es_public_proxy.toml
+
+	es-public-proxy --config /etc/es_public_proxy.toml
+
diff --git a/extra/example_config.toml b/extra/example_config.toml
new file mode 100644
index 0000000..cd66403
--- /dev/null
+++ b/extra/example_config.toml
@@ -0,0 +1,12 @@
+
+bind_addr = "127.0.0.1:9292"
+upstream_addr = "127.0.0.1:9200"
+allow_all_indices = false
+
+# Index-level configuration
+[[index]]
+name = "test"
+
+# Configure additional indices by repeating the [[index]] block
+#[[index]]
+#name = "some-other-index"