Mercurial > p > roundup > code
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 6834:5129fc03dc1f | 6835:7a48f771cd4f |
|---|---|
| 179 Specifies a template used for displaying the tracker index when | 179 Specifies a template used for displaying the tracker index when |
| 180 multiple trackers are being used. It is processed by TAL and | 180 multiple trackers are being used. It is processed by TAL and |
| 181 the variable "trackers" is available to the template and is a | 181 the variable "trackers" is available to the template and is a |
| 182 dict of all configured trackers. | 182 dict of all configured trackers. |
| 183 **ssl** | 183 **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. | |
| 185 If you enable this, ensure that your tracker's config.ini specifies | 189 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. | |
| 187 **pem** | 192 **pem** |
| 188 If specified, the SSL PEM file containing the private key and certificate. | 193 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-----``. | |
| 189 If not specified, roundup will generate a temporary, self-signed certificate | 199 If not specified, roundup will generate a temporary, self-signed certificate |
| 190 for use. | 200 for use. |
| 191 **trackers** section | 201 **trackers** section |
| 192 Each line denotes a mapping from a URL component to a tracker home. | 202 Each line denotes a mapping from a URL component to a tracker home. |
| 193 Make sure the name part doesn't include any url-unsafe characters like | 203 Make sure the name part doesn't include any url-unsafe characters like |