Clarify the --secure command line option

2015-02-19 21:28:07 -08:00
parent cac5daca01
commit 51b379d78b
1 changed files with 6 additions and 2 deletions
@@ -26,10 +26,14 @@ Download the binary ([OS X](http://bin.begriffs.com/dbapi/osx/postgrest-0.2.6.0.
 postgrest  --db-host localhost  --db-port 5432     \
           --db-name my_db      --db-user postgres \
           --db-pass foobar     --db-pool 200      \
-           --anonymous postgres --secure           \
-           --port 3000
+           --anonymous postgres --port 3000
 ```

+In production include the `--secure` option which redirects all
+requests to HTTPS. Note that PostgREST does not handle the SSL
+internally and must be put behind another server that does (such
+as nginx or the Heroku load balancer).
+
 ### Performance

 TLDR; subsecond response times for up to 2000 requests/sec on Heroku free tier. ([see the load test](https://github.com/begriffs/postgrest/wiki/Performance-and-Scaling))