diff options
| -rw-r--r-- | Cargo.toml | 19 | ||||
| -rw-r--r-- | README.md | 4 |
2 files changed, 19 insertions, 4 deletions
@@ -5,7 +5,7 @@ edition = "2018" authors = ["Bryan Newbold <bnewbold@robocracy.org>"] license = "AGPL-3+" #license-file = "LICENSE.AGPLv3.txt" -description = "simple proxy for exposing a read-only subset of elasticsearch API to the public internet" +description = "simple read-only HTTP reverse-proxy for exposing an Elasticsearch node to the public internet" readme = "README.md" repository = "https://gitlab.com/bnewbold/es-public-proxy" keywords = ["elasticsearch", "proxy"] @@ -33,7 +33,22 @@ section = "utility" priority = "optional" maintainer-scripts = "extra/" systemd-units = { enable = false } -extended-description = "TODO: longer description of package should go here" +extended-description = """" +es-public-proxy is intended to be a simple and reliable alternative for the +use case of exposing popular search queries on specific indices to the public +web. HTTP requests are parsed and filtered in a safe, compiled language (Rust), +then only safe queries are re-serialized and forwarded to the backend search +instance listening on a different port. + +* type-safe de-serialization and re-serialization of all user data +* single-binary, easy to install +* simple configuration with sane defaults +* low-overhead in network latency and compute resources +* optional CORS headers for direct browser requests +* SSL, transport compression, load-balancing, observability, and rate-limiting + are left to other tools like nginx, caddy, or HAproxy +* free software forever: AGPLv3+ license +""" assets = [ ["target/release/es-public-proxy", "usr/bin/", "755"], ["extra/es-public-proxy.1", "usr/share/man/man1/", "644"], @@ -1,6 +1,6 @@ -**es-public-proxy**: simple HTTP reverse-proxy for exposing an Elasticsearch -node to the public internet +**es-public-proxy**: simple read-only HTTP reverse-proxy for exposing an +Elasticsearch node to the public internet * type-safe de-serialization and re-serialization of all user data * single-binary, easy to install |