From 01f5b87f26bbfcad6b523e45baa4ea13e28db37a Mon Sep 17 00:00:00 2001 From: "Herman J. Radtke III" Date: Fri, 30 Jun 2017 04:47:08 -0700 Subject: [PATCH] Add package and container info --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 16cbb44..0688cab 100644 --- a/README.md +++ b/README.md @@ -16,26 +16,34 @@ An eventual goal is to have the pool managed by Raft. This will allow a cluster ## Installation -### Requirements +The _production_ versions of weldr are deployed as static binaries. There are two general methods of installation: + + * Packages for common operating systems are located at [https://packagecloud.io/weldr/weldr](https://packagecloud.io/weldr/weldr). + * A container repository is located at [https://hub.docker.com/r/weldr/weldr/](https://hub.docker.com/r/weldr/weldr/). + +### From Source + +#### Requirements * capnproto * A TLS library compatible with rust-tls -### Installing on Ubuntu +Installing requirements on Ubuntu: ``` $ apt-get update && apt-get install gcc libssl-dev pkg-config capnproto ``` -### Docker +#### Docker See [DOCKER.md](./DOCKER.md) for details. ## Usage - * Start the proxy - `RUST_LOG=weldr cargo run --bin weldr` + * Start the proxy - `RUST_LOG=weldr cargo run --bin weldr` or `RUST_LOG=weldr /path/to/weldr` * Add a server to the pool - `curl localhost:8687/servers -d '{"url":"http://127.0.0.1:12345"}'` - * Start test origin server - `cargo run --bin test-server` - start test origin server + * Start test origin server - `cargo run --bin test-server` - start test origin server. This is not provided by packages or the container. + * The test-server provides two routes: `/` and `/large` * Send a request - `curl -vvv localhost:8080/` * Send a request and get back a large response - `curl -vvv localhost:8080/large`