Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Documentation unclear: compression

Đang mở
  • Có gì không ổn?
#7,991 3 bình luận 1 reaction 2 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@seshadhri-aswath đang làm issue này rồi.

Từ ngày 18/8/2025.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

Hi,

I have a few issues with the compression documentation.

It was outlined here: https://openliberty.io/blog/2020/04/22/http-response-compression.html
The actual docs I am referring to: https://openliberty.io/docs/latest/reference/config/compression.html

Here are some enhancements I would like to suggest:

Compression algorithm

currently, we have support for:

  • gzip,
  • x-gzip,
  • deflate,
  • zlib,
  • identity
Update wish / recommendation
  • Please explain each item (I thought deflate is the algorithm used in gz?).
  • Mention identity equals no-compression
  • Mention zlib is hardly supported by browsers
  • Mention zlib has AIX hardware support (has it?)
Future perspective: brotli, lz4 and zstd

Modern browsers will send: Accept-Encoding: gzip, deflate, br, zstd (Firefox, Edge, others).

Please document the small overlap and maybe reference wishlist issues / github RFE issues for br (brotli) and zstd (and maybe lz4).

serverPreferredAlgorithm

This is an attribute, interestingly. Make that information stand out, maybe add an example. Usually server.xml uses tags only, so this is somewhat unexpected.

Luckily, <config onError="fail" /> will make the startup fail.

types

Invalid tags won't fail the start

<config onError="fail" /> will NOT make the startup fail if you accidentally use <type> instead of <types>.
Please mention this explicitly (and why it DOES fail for <serverPreferredAlgorithm>, see above section).

Give examples of configurations

Give an example snipped for the default configuration

combination of no prefix, + and -

What happens if you combine those?

<compression>
  <types>text/plain</types>
  <types>+text/*</types>
  <types>-text/xml</types>
</compression>

What would be the outcome? What takes precedence? What about other combinations?

minGzipSize

This option is not documented

Thanks!

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
14
Fork
58
Merge trung bình
1 giờ 5 phút
Pull request đã merge (30 ngày)
21

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenLiberty/docs

Tất cả issue của OpenLiberty/docs

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.