Skip to content

Commit 276dd6f

Browse files
committed
Document runserver command line flags
1 parent edebfaa commit 276dd6f

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,35 @@ You can take that value and add in your keys like so::
356356

357357
Once the server is up and running it is bound to 0.0.0.0 on port 8080.
358358

359+
Running behind a reverse proxy (e.g. nginx)
360+
-------------------------------------------
361+
362+
If you're running behind a reverse proxy, which this project recommends,
363+
you will want to set one additional command line argument,
364+
``reverse-proxy``. You can instead set the environment variable
365+
SSH_CERT_AUTHORITY_PROXY=true if that is more your style. Setting this
366+
flag to true instructs the daemon to trust the X-Forwarded-For header
367+
that nginx will set and to use that IP address in log messages. Know
368+
that you must not set this value to true if you are not running behind a
369+
proxy as this allows a malicious user to control the value of the IP
370+
address that is put into your log files.
371+
372+
Command Line Flags
373+
------------------
374+
375+
- ``config-file``: The path to a config.json file. Used to override the
376+
default of $HOME/.ssh_ca/sign_certd_config.json
377+
- ``listen-address``: Controls the bind address of the daemon. By
378+
default we bind to localhost which means you will not be able to
379+
connect to the daemon from hosts other than this one without using a
380+
reverse proxy (e.g. nginx) in front of this daemon. A reverse proxy is
381+
the recommended method for running this service in production.
382+
- ``reverse-proxy``: When specified the daemon will trust the
383+
X-Forwarded-For header as added to requests by your reverse proxy.
384+
This flag must not be set when you are not using a reverse proxy as it
385+
permits a malicious user to control the IP address that is written to
386+
log files.
387+
359388
Encrypting a CA Key Using Amazon's KMS
360389
======================================
361390

0 commit comments

Comments
 (0)