comparison roundup/configuration.py @ 6458:8f1b91756457

issue2551147 - Enable compression of http responses in roundup. gzip, (brotli/zstd with optional packages) on the fly compression/content-encoding enabled by default. Can serve pre-compressed static assets as well if the client can accept it. Docs updated. Also added example nginx config to installation.txt. The config allows nginx to compress data on the fly. If the config is used, dynamic compression in roundup can be disabled. Dedicating this checkin to my father Paul Hector Rouillard 1930-2021. I did much of the development in this changeset while sitting with him as he slept/transitioned. Without his encouragement and example, my desire to learn would not be what it is and I wouldn't be half the person I am.
author John Rouillard <rouilj@ieee.org>
date Sat, 24 Jul 2021 16:31:36 -0400
parents 1f2f7c0b8968
children a036712c96f4
comparison
equal deleted inserted replaced
6457:dc59051807b6 6458:8f1b91756457
844 (Option, "http_auth_header", "", 844 (Option, "http_auth_header", "",
845 "The HTTP header that holds the user authentication information.\n" 845 "The HTTP header that holds the user authentication information.\n"
846 "If empty (default) the REMOTE_USER header is used.\n" 846 "If empty (default) the REMOTE_USER header is used.\n"
847 "This is used when the upstream HTTP server authenticates\n" 847 "This is used when the upstream HTTP server authenticates\n"
848 "the user and passes the username using this HTTP header."), 848 "the user and passes the username using this HTTP header."),
849 (BooleanOption, "dynamic_compression", "yes",
850 "Setting this option makes roundup look at the Accept-Encoding\n"
851 "header supplied by the client. It will compress the response\n"
852 "on the fly using a common encoding. Disable it if your\n"
853 "upstream server does compression of dynamic data."),
854 (BooleanOption, "use_precompressed_files", "no",
855 "Setting this option enables Roundup to serve precompressed\n"
856 "static files. The admin must create the compressed files with\n"
857 "proper extension (.gzip, .br, .zstd) in the same directory as\n"
858 "the uncompressed file. If a precompressed file doesn't\n"
859 "exist, the uncompressed file will be served possibly with\n"
860 "dynamic compression."),
849 (BooleanOption, 'http_auth_convert_realm_to_lowercase', "no", 861 (BooleanOption, 'http_auth_convert_realm_to_lowercase', "no",
850 "If usernames consist of a name and a domain/realm part of\n" 862 "If usernames consist of a name and a domain/realm part of\n"
851 "the form user@realm and we're using REMOTE_USER for\n" 863 "the form user@realm and we're using REMOTE_USER for\n"
852 "authentication (e.g. via Kerberos), convert the realm part\n" 864 "authentication (e.g. via Kerberos), convert the realm part\n"
853 "of the incoming REMOTE_USER to lowercase before matching\n" 865 "of the incoming REMOTE_USER to lowercase before matching\n"

Roundup Issue Tracker: http://roundup-tracker.org/