Navigation Menu

Skip to content

Commit

Permalink
Document prefix option along with proxy configuration. See #12.
Browse files Browse the repository at this point in the history
  • Loading branch information
mlavin committed Jan 6, 2013
1 parent e858abe commit 8b20cc6
Showing 1 changed file with 41 additions and 5 deletions.
46 changes: 41 additions & 5 deletions docs/configuration.rst
Expand Up @@ -5,6 +5,16 @@ Below is a full set of configuration options for the Sick Muse server. These opt
are configured on the command line via ``sickmuse --<name>=<value>``.


debug
---------------------------------------------

Default: ``False``

Turns the server into debug mode. In this mode the static resouces will use the
non-compressed version and the Python code changes will auto reload. This setting
is used for local development and should not be used in production.


port
---------------------------------------------

Expand All @@ -13,14 +23,40 @@ Default: ``8282``
The port on which the server runs.


debug
prefix
---------------------------------------------

Default: ``False``
Default: ``""`` (Empty String)

Turns the server into debug mode. In this mode the static resouces will use the
non-compressed version and the Python code changes will auto reload. This setting
is used for local development and should not be used in production.
The ``prefix`` argument can be used to run the server on under a url prefix. For instance
if you wanted to run the server under ``sickmuse`` you could start the server with::

sickmuse --prefix=sickmuse

and then proxy the server with Nginx

.. code-block:: guess
upstream sickmuse {
server 127.0.0.1:8282;
}
server {
listen 80;
server_name example.com;
location /sickmuse/ {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $http_host;
proxy_redirect off;
proxy_buffering on;
proxy_intercept_errors on;
proxy_pass http://sickmuse;
}
}
You could then see the server running at http://example.com/sickmuse/.


rrd_directory
Expand Down

0 comments on commit 8b20cc6

Please sign in to comment.