From 39a2e743929338aa599d74718c58148996d4d8c6 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 12 Jul 2012 23:59:05 +0900 Subject: [PATCH] Updated README --- README.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index d25020ad..47e991f8 100644 --- a/README.rst +++ b/README.rst @@ -208,12 +208,14 @@ Shrpx - A reverse proxy for SPDY/HTTPS ++++++++++++++++++++++++++++++++++++++ The ``shrpx`` is a multi-threaded reverse proxy for SPDY/HTTPS. It -converts SPDY/HTTPS traffic to plain HTTP. +converts SPDY/HTTPS traffic to plain HTTP. It can be used as SSL/SPDY +proxy with the http proxy (e.g., Squid) in the backend. To enable +SSL/SPDY proxy mode, use ``--spdy-proxy`` option. Here is the command-line options:: $ examples/shrpx -h - Usage: shrpx [-Dh] [-b ] [-f ] [-n ] + Usage: shrpx [-Dhs] [-b ] [-f ] [-n ] [-c ] [-L ] A reverse proxy for SPDY/HTTPS. @@ -228,16 +230,24 @@ Here is the command-line options:: Default: 'localhost,3000' -n, --workers= Set the number of worker threads. + Default: 1 -c, --spdy-max-concurrent-streams= Set the maximum number of the concurrent streams in one SPDY session. + Default: 100 -L, --log-level= Set the severity level of log output. - INFO, WARNING, ERROR and FATAL + INFO, WARNING, ERROR and FATAL. + Default: WARNING -D, --daemon Run in a background. If -D is used, the current working directory is changed to '/'. + -s, --spdy-proxy SSL/SPDY proxy mode. + --add-x-forwarded-for + Append X-Forwarded-For header field to the + downstream request. -h, --help Print this help. + For those of you who are curious, ``shrpx`` is an abbreviation of "Spdy/https to Http Reverse ProXy".