Skip to content

Commit 8b51700

Browse files
committed
Clean up docs on roundup-sever SSL use.
Duplicate sections from man page update to admin_guide as the man page often isn't installed anywhere man can find it. Remove warning that SSL is only supported on python 3. Suprisingly my change to fix it on Python 3 also inadvertantly fixed it on python 2.
1 parent 8c95d65 commit 8b51700

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

doc/admin_guide.txt

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,21 @@ Additional notes for each keyword:
181181
the variable "trackers" is available to the template and is a
182182
dict of all configured trackers.
183183
**ssl**
184-
Enables the use of SSL to secure the connection to the roundup-server.
184+
Enables use of SSL to secure the connection to the
185+
roundup-server. In most cases, you will want to run a
186+
real web server (Apache, Nginx) as a proxy to
187+
roundup-server running without SSL. The real web server
188+
can filter/rate limit/firewall requests to roundup-server.
185189
If you enable this, ensure that your tracker's config.ini specifies
186-
an *https* URL.
190+
an *https* URL. See roundup-server.1 man page for
191+
additional information.
187192
**pem**
188193
If specified, the SSL PEM file containing the private key and certificate.
194+
The file must include both the private key and certificate with appropriate
195+
headers (e.g. ``-----BEGIN PRIVATE KEY-----``,
196+
``-----END PRIVATE KEY-----`` and
197+
``-----BEGIN CERTIFICATE-----``,
198+
``-----END CERTIFICATE-----``.
189199
If not specified, roundup will generate a temporary, self-signed certificate
190200
for use.
191201
**trackers** section

share/man/man1/roundup-server.1

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ front end server to authenticate a user and pass the user identity to
4545
roundup.
4646
.TP
4747
\fB-s\fP
48-
Enables use of SSL. SSL only works when running the server using
49-
python 3. In most cases, you will want to run a real web server
48+
Enables use of SSL. In most cases, you will want to run a real web server
5049
(Apache, Nginx) as a proxy to roundup-server running without SSL.
5150
The real web server can filter/rate limit/firewall requests to
5251
roundup-server.

0 commit comments

Comments
 (0)