Mercurial > p > roundup > code
view share/man/man1/roundup-server.1 @ 6823:fe0091279f50
Refactor session db logging and key generation for sessions/otks
While I was working on the redis sessiondb stuff, I noticed that
log_wanrning, get_logger ... was duplicated. Also there was code to
generate a unique key for otks that was duplicated.
Changes:
creating new sessions_common.py and SessionsCommon class to provide
methods:
log_warning, log_info, log_debug, get_logger, getUniqueKey
getUniqueKey method is closer to the method used to make
session keys in client.py.
sessions_common.py now report when random_.py chooses a weak
random number generator. Removed same from rest.py.
get_logger reconciles all logging under
roundup.hyperdb.backends.<name of BasicDatabase class>
some backends used to log to root logger.
have BasicDatabase in other sessions_*.py modules inherit from
SessionCommon.
change logging to use log_* methods.
In addition:
remove unused imports reported by flake8 and other formatting
changes
modify actions.py, rest.py, templating.py to use getUniqueKey
method.
add tests for new methods
test_redis_session.py
swap out ModuleNotFoundError for ImportError to prevent crash in
python2 when redis is not present.
allow injection of username:password or just password into redis
connection URL. set pytest_redis_pw envirnment variable to password
or user:password when running test.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 Aug 2022 01:51:11 -0400 |
| parents | a036712c96f4 |
| children | 36cf8a12a26b |
line wrap: on
line source
.TH ROUNDUP-SERVER 1 "27 July 2004" .SH NAME roundup-server \- start roundup web server .SH SYNOPSIS \fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]* .SH OPTIONS .TP \fB-C\fP \fIfile\fP or \fB--config\fP \fIfile\fP Use options read from the configuration file (see below). .TP \fB-n\fP \fIhostname\fP Sets the host name or IP address to listen on. Default is localhost (127.0.0.1). Use 0.0.0.0 to listen on all interfaces on the system. .TP \fB-p\fP \fIport\fP Sets the port to listen on (default: 8080). .TP \fB-d\fP \fIPIDfile\fP Run the server in the background and write the server's PID to the file indicated by PIDfile. The -l (or -L) option \fBmust\fP be specified if -d is used. .TP \fB-t\fP \fBfork|debug|none\fP Control multi-process mode. Default fork. .TP \fB-l\fP \fIfile\fP Sets a filename to log to (instead of stdout). This is required if the -d option is used. .TP \fB-L\fP Have the server log using the Python logger with key roundup.http. .TP \fB-i\fP \fIfile\fP Sets a filename to use as a template for generating the tracker index page. The variable "trackers" is available to the template and is a dict of all configured trackers. .TP \fB-I\fP \fIheader1[,header2,...]\fP Pass the header(s) and their values to the backend. This allow-list of header variables can be used by custom code in the tracker or with a tracker's \fBhttp_auth_header\fP configuration option to allows a front end server to authenticate a user and pass the user identity to roundup. .TP \fB-s\fP Enables use of SSL. .TP \fB-e\fP \fIfile\fP Sets a filename containing the PEM file to use for SSL. If left blank, a temporary self-signed certificate will be used. .TP \fB-N\fP Log client machine names instead of IP addresses (much slower). .TP \fB-V\fP \fIHTTPVER\fP By default roundup-server uses HTTP/1.1 to enable keepalives for faster response. HTTPVER can be set to \fBHTTP/1.0\fP to disable keepalives. .TP \fB-u\fP \fIUID\fP Runs the Roundup web server as this UID. .TP \fB-g\fP \fIGID\fP Runs the Roundup web server as this GID. .TP \fB-v\fP or \fB--version\fP Print version and exit. .TP \fB-h\fP or \fB--help\fP Print help and exit. .TP \fB--save-config\fP Create or update configuration file and exit. .TP \fBname=\fP\fItracker home\fP Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is identified in the URL (it's the first part of the URL path). The \fItracker home\fP variable is the directory that was identified when you did "roundup-admin init". You may specify any number of these name=home pairs on the command-line. For convenience, you may edit the TRACKER_HOMES variable in the roundup-server file instead. Make sure the name part doesn't include any url-unsafe characters like spaces, as these confuse the cookie handling in browsers like IE. .SH EXAMPLES .TP .B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1 Start the server on port \fB9000\fP serving two trackers; one under \fB/bugs\fP and one under \fB/reqs\fP. .SH CONFIGURATION FILE See the "admin_guide" in the Roundup "doc" directory. .SH AUTHOR This manpage was written by Bastian Kleineidam <calvin@debian.org> for the Debian distribution of roundup. The main author of roundup is Richard Jones <richard@users.sourceforge.net>.