[gentoo-dev] [PATCH 0/1] 2025-02-21-NGINX-packaging-changes: Add news item

[gentoo-dev] [PATCH 0/1] 2025-02-21-NGINX-packaging-changes: Add news item

[Zurab Kvachadze]

This is a NEWS item for a PR that will be submitted to gentoo-dev.

The corresponging GitHub PR: https://github.com/gentoo/gentoo/pull/37590

Zurab Kvachadze (1):
  2025-02-21-NGINX-packaging-changes: Add news item

 .../2025-02-21-NGINX-packaging-changes.txt    | 118 ++++++++++++++++++
 1 file changed, 118 insertions(+)
 create mode 100644 2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt

-- 
2.45.3

[gentoo-dev] [PATCH 1/1] 2025-02-21-NGINX-packaging-changes: Add news item

[Zurab Kvachadze]

Signed-off-by: Zurab Kvachadze <zurabid2016@gmail.com>
---
 .../2025-02-21-NGINX-packaging-changes.txt    | 118 ++++++++++++++++++
 1 file changed, 118 insertions(+)
 create mode 100644 2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt

diff --git a/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt b/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
new file mode 100644
index 0000000..8050bda
--- /dev/null
+++ b/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
@@ -0,0 +1,118 @@
+Title: Breaking changes in NGINX packaging in Gentoo
+Author: Zurab Kvachadze <zurabid2016@gmail.com>
+Posted: 2025-02-21
+Revision: 1
+News-Item-Format: 2.0
+Display-If-Installed: www-servers/nginx
+
+NGINX is a web server and a reverse proxy. Following a year-long effort,
+its packaging in Gentoo has undergone a major revamp[1]. Starting from
+the mainline version %PUT_MAINLINE_NGINX_VERSION_HERE% and the stable
+version %PUT_STABLE_NGINX_VERSION_HERE%, the changes will come into
+force. If you are reading this NEWS item, the information below is
+relevant for you.
+
+What changed?
+====================
+
+There are a few user-facing changes with the updated packaging.
+
+1. Third-party modules.
+
+Third-party modules, which were previously part of the NGINX package,
+www-servers/nginx, are now separate packages in the www-nginx/ category.
+The Lua, Brotli, headers-more and upload-progress are examples of the
+modules that have been separated. Some of the modules have been removed
+completely due to their apparent low usage and needlessness.
+
+The following is a list of modules that have been removed. If you rely
+on any of the modules outlined below, please file a bug on Gentoo
+Bugzilla[2][3] asking the module to be added. The recommended summary
+for a bug is "www-servers/nginx: please add module MODULE_NAME", where
+MODULE_NAME is the name of the module you would like to see added.
+
+Removed modules:
+    - ngx_cache_purge/http_cache_purge_module
+    - nginx_ngx_slowfs_cache/http_slowfs_cache_module
+    - ngx-fancyindex/http_fancyindex_module
+    - ngx_http_auth_pam_module/http_authpam_module
+    - nginx_upstream_check_module/http_upstream_check_module
+    - ngx_metrics/http_metrics_module
+    - naxsi/http_naxsi_module
+    - nginx-rtmp-module/rtmp_module
+    - nginx-dav-ext-module/http_dav_ext_module
+    - ModSecurity-nginx/http_security_module
+    - nginx-push-stream-module/http_push_stream_module
+    - nginx-sticky-module-ng/http_sticky_module
+    - nginx-mogilefs-module/http_mogilefs_module
+    - nginx-auth-ldap/http_auth_ldap_module
+    - nginx-vod-module/http_vod_module
+    - ngx_http_geoip2_module/http_geoip2_module
+
+2. USE flags.
+
+Some USE flags, like "http-cache", "ktls", "pcre", "pcre-jit" and so on,
+have been removed. They did not have any effect or served no purpose,
+thus you need not worry about them.
+
+The "http2", "http3" use flags have been renamed to
+nginx_modules_http_v2 and nginx_modules_http_v3 respectively. They
+correspond to NGINX_MODULES_HTTP "v2" and "v3" USE_EXPAND flags
+accordingly. "ssl" use flag has been changed into individual "ssl"
+USE_EXPAND flags for the mail, stream and HTTP servers.
+
+Thread pool support[4], previously toggled by the "threads" USE flag, is
+now enabled unconditionally. Vim syntax files are now provided by the
+main www-servers/nginx package.
+
+3. Default log files.
+
+Default log filenames are now error.log and access.log, instead of
+error_log and access_log.
+
+User Action Required
+====================
+
+If you use any third-party modules, install the new separate package.
+For instance, if you previously enabled the nginx_modules_http_lua USE
+flag on www-servers/nginx, here is how you install the new Lua module
+package.
+
+        emerge www-nginx/ngx-lua-module
+
+To list all the available module packages, use
+
+        emerge --search @www-nginx | less
+
+If you use the "http2" or "http3" USE flags, enable the corresponding
+USE_EXPAND flags. To enable http2 only:
+
+        echo 'www-servers/nginx NGINX_MODULES_HTTP: v2' >> \
+            /etc/portage/package.use/nginx.use
+
+To enable http3:
+
+        echo 'www-servers/nginx NGINX_MODULES_HTTP: v3' >> \
+            /etc/portage/package.use/nginx.use
+
+To enable both http2 and http3:
+
+        echo 'www-servers/nginx NGINX_MODULES_HTTP: v2 v3' >> \
+            /etc/portage/package.use/nginx.use
+
+SSL/TLS modules are enabled by default. If you wish to disable them, use
+the following command.
+
+        echo www-servers/nginx NGINX_MODULES_HTTP: -ssl \
+            NGINX_MODULES_STREAM: -ssl \
+            NGINX_MODULES_MAIL: -ssl >> \
+            /etc/portage/package.use/nginx.use
+
+The updated NGINX comes with a new logrotate file that points to the new
+log filenames. If any of your scripts rely on the old log files, change
+them accordingly as needed.
+
+[1]: https://github.com/gentoo/gentoo/pull/37590
+[2]: https://bugs.gentoo.org/
+[3]: https://wiki.gentoo.org/wiki/Bugzilla/Bug_report_guide
+[4]: https://nginx.org/en/docs/ngx_core_module.html#thread_pool
-- 
2.45.3

Re: [gentoo-dev] [PATCH 1/1] 2025-02-21-NGINX-packaging-changes: Add news item

[Zoltan Puskas]

Hi,

This seems to be a significant change to nginx. While I think breaking out
modules is a good idea, I was wondering how it was determined which modules are
low usage or "needless"? I think some of these module removals actually might
break other Gentoo packages in some cases.

> +1. Third-party modules.
> +
> +Third-party modules, which were previously part of the NGINX package,
> +www-servers/nginx, are now separate packages in the www-nginx/ category.
> +The Lua, Brotli, headers-more and upload-progress are examples of the
> +modules that have been separated. Some of the modules have been removed
> +completely due to their apparent low usage and needlessness.
> +
> +The following is a list of modules that have been removed. If you rely
> +on any of the modules outlined below, please file a bug on Gentoo
> +Bugzilla[2][3] asking the module to be added. The recommended summary
> +for a bug is "www-servers/nginx: please add module MODULE_NAME", where
> +MODULE_NAME is the name of the module you would like to see added.
> +
> +Removed modules:
> +    - ngx_cache_purge/http_cache_purge_module
> +    - nginx_ngx_slowfs_cache/http_slowfs_cache_module
> +    - ngx-fancyindex/http_fancyindex_module
> +    - ngx_http_auth_pam_module/http_authpam_module
> +    - nginx_upstream_check_module/http_upstream_check_module
> +    - ngx_metrics/http_metrics_module
> +    - naxsi/http_naxsi_module
> +    - nginx-rtmp-module/rtmp_module
> +    - nginx-dav-ext-module/http_dav_ext_module
> +    - ModSecurity-nginx/http_security_module
> +    - nginx-push-stream-module/http_push_stream_module
> +    - nginx-sticky-module-ng/http_sticky_module
> +    - nginx-mogilefs-module/http_mogilefs_module
> +    - nginx-auth-ldap/http_auth_ldap_module
> +    - nginx-vod-module/http_vod_module
> +    - ngx_http_geoip2_module/http_geoip2_module
> +

From the removed list above I already see that there are modules that I use all
the time and I was wondering if I should file the bugs now preemptively or
should I wait for the PR to be merged.

Modules in question are:

- ngx-fancyindex/http_fancyindex_module:

  I think it's a really useful module to make direcotry listings nicer with
  minimal effort. I personally used it for old school open "pub" directories
  where I just store files for easy access over the web.

- nginx-dav-ext-module/http_dav_ext_module:

  This is required for anyone self hosting anything DAV. One such app in the
  Gentoo repository is www-apps/baikal, which if paired with DAVx5 [1] Android
  application, can be used as a self-hosted private contacts and calendar backend.

- nginx-vod-module/http_vod_module:

  Having DASH and friends capability makes it easy to host adaptive bitrate
  video streaming using simple HTML <video> tags. AFAIK all browsers support
  DASH for quite some time now. I don't see how simple video streaming is
  useless. I feel nginx-rtmp-module/rtmp_module falls under this category too
  since it's used by the popular JW Player, but also can be used by VLC and
  OBS.

- ngx_http_geoip2_module/http_geoip2_module:

  Interesting choice, especially since GeoIP has been deprecated in favour of
  GeoIP2 in 2019[2]. It's a useful module, and IMHO and should be kept instead
  of the old GeoIP one, especially since the old database is not updated any
  more.

Cheers,
Zoltan

[1] https://www.davx5.com/
[2] https://web.archive.org/web/20190930210358/https://support.maxmind.com/geolite-legacy-discontinuation-notice/

Re: [gentoo-dev] [PATCH 1/1] 2025-02-21-NGINX-packaging-changes: Add news item

[Gordon Pettey]

On Sat, Feb 22, 2025 at 8:57 PM Zoltan Puskas <zoltan@sinustrom.info> wrote:
>
> Hi,
>
> This seems to be a significant change to nginx. While I think breaking out
> modules is a good idea, I was wondering how it was determined which modules are
> low usage or "needless"? I think some of these module removals actually might
> break other Gentoo packages in some cases.
>
> - nginx-dav-ext-module/http_dav_ext_module:
>
>   This is required for anyone self hosting anything DAV. One such app in the
>   Gentoo repository is www-apps/baikal, which if paired with DAVx5 [1] Android
>   application, can be used as a self-hosted private contacts and calendar backend.

This removal will also break out-of-tree usage of e.g. Sonatype Nexus
(or any other
repository) hosting of Maven-based sites, as DAV is used to upload files.

[gentoo-dev] On retiring third-party NGINX modules (was: Re: 2025-02-21-NGINX-packaging-changes: Add news item)

[Zurab Kvachadze]

On Sat, 2025-02-22 at 18:55 -0800, Zoltan Puskas wrote:
>Hi,
>
>This seems to be a significant change to nginx. While I think breaking out 
>modules is a good idea, I was wondering how it was determined which modules are 
>low usage or "needless"? I think some of these module removals actually might 
>break other Gentoo packages in some cases.

Hello,

I apologise for not putting much thought into evaluating usefulness of NGINX 
modules. Not using third-party modules myself, the task of porting (i.e. 
separating an NGINX module into its own package) modules was always of lower 
priority to me. Being unable to come up with a good way to enquire about Gentoo 
users' usage patterns, I selected which modules will be separated and which 
retired mostly at random. Actually, at this point, I can no longer recall why I 
ported specifically the modules I ported.

However, thanks to your feedback, I realise that I should have spent a bit more 
time researching which plugins are popular and widely used and which are not so. 
Looking at the list of modules you provided, it is ought to be a trivial matter 
to get them packaged. So do not worry, this will be taken care of. They will get 
ported and will be available as separate packages.

I am going to consult with other Gentoo developers to find a way to tackle this 
problem. Nonetheless, if you have any ideas on what plugins should also be 
ported, please drop a letter, your input is really important for us :)

>> +1. Third-party modules.
>> +
>> +Third-party modules, which were previously part of the NGINX package,
>> +www-servers/nginx, are now separate packages in the www-nginx/ category.
>> +The Lua, Brotli, headers-more and upload-progress are examples of the
>> +modules that have been separated. Some of the modules have been removed
>> +completely due to their apparent low usage and needlessness.
>> +
>> +The following is a list of modules that have been removed. If you rely
>> +on any of the modules outlined below, please file a bug on Gentoo
>> +Bugzilla[2][3] asking the module to be added. The recommended summary
>> +for a bug is "www-servers/nginx: please add module MODULE_NAME", where
>> +MODULE_NAME is the name of the module you would like to see added.
>> +
>> +Removed modules:
>> +    - ngx_cache_purge/http_cache_purge_module
>> +    - nginx_ngx_slowfs_cache/http_slowfs_cache_module
>> +    - ngx-fancyindex/http_fancyindex_module
>> +    - ngx_http_auth_pam_module/http_authpam_module
>> +    - nginx_upstream_check_module/http_upstream_check_module
>> +    - ngx_metrics/http_metrics_module
>> +    - naxsi/http_naxsi_module
>> +    - nginx-rtmp-module/rtmp_module
>> +    - nginx-dav-ext-module/http_dav_ext_module
>> +    - ModSecurity-nginx/http_security_module
>> +    - nginx-push-stream-module/http_push_stream_module
>> +    - nginx-sticky-module-ng/http_sticky_module
>> +    - nginx-mogilefs-module/http_mogilefs_module
>> +    - nginx-auth-ldap/http_auth_ldap_module
>> +    - nginx-vod-module/http_vod_module
>> +    - ngx_http_geoip2_module/http_geoip2_module
>> +
>
>From the removed list above I already see that there are modules that I use all
>the time and I was wondering if I should file the bugs now preemptively or
>should I wait for the PR to be merged.
>
>Modules in question are:
>
>- ngx-fancyindex/http_fancyindex_module:
>
>  I think it's a really useful module to make direcotry listings nicer with
>  minimal effort. I personally used it for old school open "pub" directories
>  where I just store files for easy access over the web.
>
>- nginx-dav-ext-module/http_dav_ext_module:
>
>  This is required for anyone self hosting anything DAV. One such app in the
>  Gentoo repository is www-apps/baikal, which if paired with DAVx5 [1] Android
>  application, can be used as a self-hosted private contacts and calendar backend.
>
>- nginx-vod-module/http_vod_module:
>
>  Having DASH and friends capability makes it easy to host adaptive bitrate
>  video streaming using simple HTML <video> tags. AFAIK all browsers support
>  DASH for quite some time now. I don't see how simple video streaming is
>  useless. I feel nginx-rtmp-module/rtmp_module falls under this category too
>  since it's used by the popular JW Player, but also can be used by VLC and
>  OBS.
>
>- ngx_http_geoip2_module/http_geoip2_module:
>
>  Interesting choice, especially since GeoIP has been deprecated in favour of
>  GeoIP2 in 2019[2]. It's a useful module, and IMHO and should be kept instead
>  of the old GeoIP one, especially since the old database is not updated any
>  more.
>
>Cheers,
>Zoltan
>
>[1] https://www.davx5.com/
>[2] https://web.archive.org/web/20190930210358/https://support.maxmind.com/geolite-legacy-discontinuation-notice/
>

Re: [gentoo-dev] [PATCH 1/1] 2025-02-21-NGINX-packaging-changes: Add news item

[Tomas Mozes]

[-- Attachment #1: Type: text/plain, Size: 5883 bytes --]

On Fri, Feb 21, 2025 at 4:38 PM Zurab Kvachadze <zurabid2016@gmail.com>
wrote:

> Signed-off-by: Zurab Kvachadze <zurabid2016@gmail.com>
> ---
>  .../2025-02-21-NGINX-packaging-changes.txt    | 118 ++++++++++++++++++
>  1 file changed, 118 insertions(+)
>  create mode 100644
> 2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
>
> diff --git
> a/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
> b/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
> new file mode 100644
> index 0000000..8050bda
> --- /dev/null
> +++
> b/2025-02-21-NGINX-packaging-changes/2025-02-21-NGINX-packaging-changes.txt
> @@ -0,0 +1,118 @@
> +Title: Breaking changes in NGINX packaging in Gentoo
> +Author: Zurab Kvachadze <zurabid2016@gmail.com>
> +Posted: 2025-02-21
> +Revision: 1
> +News-Item-Format: 2.0
> +Display-If-Installed: www-servers/nginx
> +
> +NGINX is a web server and a reverse proxy. Following a year-long effort,
> +its packaging in Gentoo has undergone a major revamp[1]. Starting from
> +the mainline version %PUT_MAINLINE_NGINX_VERSION_HERE% and the stable
> +version %PUT_STABLE_NGINX_VERSION_HERE%, the changes will come into
> +force. If you are reading this NEWS item, the information below is
> +relevant for you.
> +
> +What changed?
> +====================
> +
> +There are a few user-facing changes with the updated packaging.
> +
> +1. Third-party modules.
> +
> +Third-party modules, which were previously part of the NGINX package,
> +www-servers/nginx, are now separate packages in the www-nginx/ category.
> +The Lua, Brotli, headers-more and upload-progress are examples of the
> +modules that have been separated. Some of the modules have been removed
> +completely due to their apparent low usage and needlessness.
> +
> +The following is a list of modules that have been removed. If you rely
> +on any of the modules outlined below, please file a bug on Gentoo
> +Bugzilla[2][3] asking the module to be added. The recommended summary
> +for a bug is "www-servers/nginx: please add module MODULE_NAME", where
> +MODULE_NAME is the name of the module you would like to see added.
> +
> +Removed modules:
> +    - ngx_cache_purge/http_cache_purge_module
> +    - nginx_ngx_slowfs_cache/http_slowfs_cache_module
> +    - ngx-fancyindex/http_fancyindex_module
> +    - ngx_http_auth_pam_module/http_authpam_module
> +    - nginx_upstream_check_module/http_upstream_check_module
> +    - ngx_metrics/http_metrics_module
> +    - naxsi/http_naxsi_module
> +    - nginx-rtmp-module/rtmp_module
> +    - nginx-dav-ext-module/http_dav_ext_module
> +    - ModSecurity-nginx/http_security_module
> +    - nginx-push-stream-module/http_push_stream_module
> +    - nginx-sticky-module-ng/http_sticky_module
> +    - nginx-mogilefs-module/http_mogilefs_module
> +    - nginx-auth-ldap/http_auth_ldap_module
> +    - nginx-vod-module/http_vod_module
> +    - ngx_http_geoip2_module/http_geoip2_module
> +
> +2. USE flags.
> +
> +Some USE flags, like "http-cache", "ktls", "pcre", "pcre-jit" and so on,
> +have been removed. They did not have any effect or served no purpose,
> +thus you need not worry about them.
> +
> +The "http2", "http3" use flags have been renamed to
> +nginx_modules_http_v2 and nginx_modules_http_v3 respectively. They
> +correspond to NGINX_MODULES_HTTP "v2" and "v3" USE_EXPAND flags
> +accordingly. "ssl" use flag has been changed into individual "ssl"
> +USE_EXPAND flags for the mail, stream and HTTP servers.
> +
> +Thread pool support[4], previously toggled by the "threads" USE flag, is
> +now enabled unconditionally. Vim syntax files are now provided by the
> +main www-servers/nginx package.
> +
> +3. Default log files.
> +
> +Default log filenames are now error.log and access.log, instead of
> +error_log and access_log.
> +
> +User Action Required
> +====================
> +
> +If you use any third-party modules, install the new separate package.
> +For instance, if you previously enabled the nginx_modules_http_lua USE
> +flag on www-servers/nginx, here is how you install the new Lua module
> +package.
> +
> +        emerge www-nginx/ngx-lua-module
> +
> +To list all the available module packages, use
> +
> +        emerge --search @www-nginx | less
> +
> +If you use the "http2" or "http3" USE flags, enable the corresponding
> +USE_EXPAND flags. To enable http2 only:
> +
> +        echo 'www-servers/nginx NGINX_MODULES_HTTP: v2' >> \
> +            /etc/portage/package.use/nginx.use
> +
> +To enable http3:
> +
> +        echo 'www-servers/nginx NGINX_MODULES_HTTP: v3' >> \
> +            /etc/portage/package.use/nginx.use
> +
> +To enable both http2 and http3:
> +
> +        echo 'www-servers/nginx NGINX_MODULES_HTTP: v2 v3' >> \
> +            /etc/portage/package.use/nginx.use
> +
> +SSL/TLS modules are enabled by default. If you wish to disable them, use
> +the following command.
> +
> +        echo www-servers/nginx NGINX_MODULES_HTTP: -ssl \
> +            NGINX_MODULES_STREAM: -ssl \
> +            NGINX_MODULES_MAIL: -ssl >> \
> +            /etc/portage/package.use/nginx.use
> +
> +The updated NGINX comes with a new logrotate file that points to the new
> +log filenames. If any of your scripts rely on the old log files, change
> +them accordingly as needed.
> +
> +[1]: https://github.com/gentoo/gentoo/pull/37590
> +[2]: https://bugs.gentoo.org/
> +[3]: https://wiki.gentoo.org/wiki/Bugzilla/Bug_report_guide
> +[4]: https://nginx.org/en/docs/ngx_core_module.html#thread_pool
> --
> 2.45.3
>
>

Please keep these modules:
- nginx_upstream_check_module/http_upstream_check_module
- ModSecurity-nginx/http_security_module
- ngx_http_geoip2_module/http_geoip2_module

Thank you,
Tomas

[-- Attachment #2: Type: text/html, Size: 7332 bytes --]