about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 12 insertions, 3 deletions
diff --git a/README b/README
index b8def5e..9999479 100644
--- a/README
+++ b/README
@@ -44,9 +44,18 @@ server.  To be useful, it also depends on having a user account on a
 machine with a publically-accessible IP and DNS name to use as your
 OpenID identity.
 
-"local-openid" should be installed in your $PATH by RubyGems.
-It is a Sinatra application and takes all the usual command-line
-arguments.  Run "local-openid -h" for help.
+== Running
+
+"local-openid" should be installed in your $PATH by RubyGems or
+setup.rb.  It is a Sinatra application and takes the usual
+command-line arguments.  It binds on all addresses (0.0.0.0) and port
+4567 by default, using the standard WEBrick web server.
+
+You may specify a different port with the *-p* switch and address with
+the *-o* switch.  The following command will start local-openid on port
+3000 bound to localhost (useful if behind a reverse proxy like nginx).
+
+  local-openid -o 127.0.0.1 -p 3000
 
 == Hacking