Mercurial > p > roundup > code
diff doc/admin_guide.txt @ 6835:7a48f771cd4f
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.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 18 Aug 2022 14:57:15 -0400 |
| parents | 1319ab13f286 |
| children | 9ff091537f43 |
line wrap: on
line diff
--- a/doc/admin_guide.txt Thu Aug 18 14:44:16 2022 -0400 +++ b/doc/admin_guide.txt Thu Aug 18 14:57:15 2022 -0400 @@ -181,11 +181,21 @@ the variable "trackers" is available to the template and is a dict of all configured trackers. **ssl** - Enables the use of SSL to secure the connection to the roundup-server. + Enables use of SSL to secure the connection to the + roundup-server. In most cases, you will want to run a + real web server (Apache, Nginx) as a proxy to + roundup-server running without SSL. The real web server + can filter/rate limit/firewall requests to roundup-server. If you enable this, ensure that your tracker's config.ini specifies - an *https* URL. + an *https* URL. See roundup-server.1 man page for + additional information. **pem** If specified, the SSL PEM file containing the private key and certificate. + The file must include both the private key and certificate with appropriate + headers (e.g. ``-----BEGIN PRIVATE KEY-----``, + ``-----END PRIVATE KEY-----`` and + ``-----BEGIN CERTIFICATE-----``, + ``-----END CERTIFICATE-----``. If not specified, roundup will generate a temporary, self-signed certificate for use. **trackers** section