Skip to content

Commit d7f6f4d

Browse files
committed
doc: document scgi serves only single tracker and use of localhost
1 parent 9f79f19 commit d7f6f4d

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

doc/installation.txt

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1315,6 +1315,12 @@ can run Roundup using SCGI or CGI.
13151315
To run Roundup using SCGI, the flup_ package provides a translator
13161316
between SCGI and WSGI.
13171317

1318+
The configuration below assumes the web server is running on one host
1319+
and the roundup scgi server is running on another host. If they are
1320+
both running on the same computer, change ``0.0.0.0`` to ``127.0.0.1``
1321+
and ``hostname`` to ``localhost`` or ``127.0.0.1`` to prevent direct
1322+
connection to the roundup scgi server from external hosts.
1323+
13181324
The following ``roundup-scgi.py`` can be run using Python to start the
13191325
server:
13201326

@@ -1340,9 +1346,16 @@ server:
13401346
# all ip address)
13411347
# port as an integer
13421348
bindAddress=("0.0.0.0", 8197),
1343-
scriptName="/roundup.scgi/demo").run()
1349+
# Unlike config.ini, the scriptName should
1350+
# not end with a /.
1351+
scriptName="/roundup.scgi").run()
13441352
sys.exit(ret and 42 or 0)
13451353

1354+
which is started using ``python roundup-scgi.py``. Note this scgi
1355+
configuration serves only one tracker at port 8197. So you run one
1356+
scgi server process for each of your trackers. This is different from
1357+
cgi, roundup-server or some wsgi deployments where you can access
1358+
different trackers through the same entry point.
13461359

13471360
Now you have to configure althttpd so it connects to the scgi
13481361
server. To do this, althttpd requires a file with a ``.scgi``
@@ -1358,14 +1371,14 @@ server. You can also put in other directives including a fallback web
13581371
page if the SCGI server is down, or a command to run to restart the
13591372
SCGI server. See the `althttpd.c file
13601373
<https://sqlite.org/althttpd/file?ci=tip&name=althttpd.c&ln=14>`_ on
1361-
the main web site for details. If you have ``althttpd`` or
1362-
``althttpsd`` installed you can just use the ``--help`` argument.
1374+
the main web site for details. If you have already have althttpd or
1375+
althttpsd installed you can just use the ``--help`` argument.
13631376

13641377
Assuming you run:
13651378
``althttpd --root /var/www/htdocs -port 443 --cert certs.pem`` and you
13661379
installed ``/var/www/htdocs/roundup.scgi``, you will be able to access
1367-
your tracker at: ``https://web_hostname/roundup.scgi/``.
1368-
1380+
your tracker at: ``https://web_hostname/roundup.scgi/`` which will
1381+
also be the value of your ``web`` setting in the tracker's config.ini.
13691382

13701383
WSGI Variations
13711384
---------------

0 commit comments

Comments
 (0)