Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is deprecated #3804

RonnieDilli · 2024-10-18T01:54:58Z

…eprecated.

This small changed update the code to use the "http2" directive and fixes the issue #3791.

Changed this:

listen 443 ssl http2;

To this:

listen 443 ssl;
http2 on;

Source: https://www.nginx.com/blog/nginx-plus-r30-released/#Important-Changes-in-Behavior-

Summary by CodeRabbit

New Features
- Enhanced SSL connection handling and HTTP/2 settings for improved performance and security.
- Updated version to 3.11.1, reflecting the new nginx HTTP/2 directive.
Bug Fixes
- Streamlined configuration to ensure clarity and functionality of SSL and HTTP/2 settings.
- Suppressed a deprecation warning related to HTTP/2 settings.

…eprecated Fixes issue #3791 ----- Changed this: listen 443 ssl http2; To this: listen 443 ssl; http2 on; ----- Source: https://www.nginx.com/blog/nginx-plus-r30-released/#Important-Changes-in-Behavior-

home-assistant

Hi @RonnieDilli

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2024-10-18T01:55:03Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

coderabbitai · 2024-10-18T02:14:48Z

📝 Walkthrough

Walkthrough

The Nginx configuration file has been modified to improve the handling of SSL connections and HTTP/2 settings. Specifically, the listen directives for port 443 have been updated to separate the declaration of HTTP/2 from the initial settings. The configuration retains existing security measures, such as the ssl_reject_handshake directive and the conditional inclusion of Cloudflare settings. Overall, the changes aim to enhance the clarity and functionality of the SSL and HTTP/2 configurations while maintaining the structure of the server blocks.

Changes

File Path	Change Summary
nginx_proxy/rootfs/etc/nginx/nginx.conf.gtpl	Modified SSL and HTTP/2 settings; separated `http2` declaration; retained security settings.
nginx_proxy/CHANGELOG.md	Added version entry 3.11.1; updated description for new nginx HTTP/2 directive.
nginx_proxy/config.yaml	Updated version number from 3.11.0 to 3.11.1; no other changes to configuration.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Nginx
    participant Server

    Client->>Nginx: HTTPS Request (Port 443)
    Nginx->>Nginx: Check SSL and HTTP/2 settings
    Nginx->>Server: Forward request if valid
    Server-->>Nginx: Response
    Nginx-->>Client: Send response

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 36049ff and d4fec6d.

📒 Files selected for processing (2)

nginx_proxy/CHANGELOG.md (1 hunks)
nginx_proxy/config.yaml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

nginx_proxy/config.yaml

🧰 Additional context used

📓 Path-based instructions (1)

nginx_proxy/CHANGELOG.md (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
In step-by-step instructions, front the location phrase in the instructional sentence.
In step-by-step instructions, front the 'goal' in the instructional sentence.
In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.

Pattern */**(html|markdown|md): do not comment on HTML used for icons

Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🪛 LanguageTool

nginx_proxy/CHANGELOG.md

[grammar] ~5-~5: Possible subject-verb agreement error detected.
Context: ... - Update to new nginx http2 directive. This also suppress a deprecation warning. ## 3.11.0 - Up...

(THIS_THAT_AGR)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

frenck

Looks good @RonnieDilli 👍

However, please also bump the add-on version number and update the changelog. Once that is done, we can go ahead and merge this one in 👍

../Frenck

…warning.

… warning.

RonnieDilli

Bumped the addon version from 3.11.0 to 3.11.1.
Also updated the changelog to: Update to new nginx http2 directive. This also suppress a deprecation warning.

Thanks @frenck, I'm glad to contribute.

frenck

Nice! Thanks, @RonnieDilli 👍

../Frenck

Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is d…

36049ff

…eprecated Fixes issue #3791 ----- Changed this: listen 443 ssl http2; To this: listen 443 ssl; http2 on; ----- Source: https://www.nginx.com/blog/nginx-plus-r30-released/#Important-Changes-in-Behavior-

home-assistant bot previously requested changes Oct 18, 2024

View reviewed changes

home-assistant bot added cla-needed Hacktoberfest labels Oct 18, 2024

home-assistant bot marked this pull request as draft October 18, 2024 01:55

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Oct 18, 2024

RonnieDilli marked this pull request as ready for review October 18, 2024 02:13

RonnieDilli mentioned this pull request Oct 18, 2024

the "listen ... http2" directive is deprecated #3791

Closed

frenck requested changes Nov 10, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 10, 2024 21:45

Uptate to new nginx http2 directive. This also supress a deprecation …

47aef72

…warning.

This comment was marked as outdated.

Sign in to view

Update to new nginx http2 directive. This also suppress a deprecation…

d4fec6d

… warning.

RonnieDilli commented Nov 11, 2024

View reviewed changes

agners marked this pull request as ready for review November 11, 2024 08:25

home-assistant bot requested a review from frenck November 11, 2024 08:25

agners approved these changes Nov 11, 2024

View reviewed changes

frenck approved these changes Nov 11, 2024

View reviewed changes

frenck merged commit 7678e87 into home-assistant:master Nov 11, 2024
11 checks passed

RonnieDilli deleted the patch-1 branch November 11, 2024 13:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is deprecated #3804

Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is deprecated #3804

RonnieDilli commented Oct 18, 2024 •

edited by coderabbitai bot

Loading

home-assistant bot left a comment

home-assistant bot commented Oct 18, 2024

coderabbitai bot commented Oct 18, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

frenck left a comment

This comment was marked as outdated.

RonnieDilli left a comment

frenck left a comment

Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is deprecated #3804

Update nginx.conf.gtpl to suppress: 'listen ... http2' directive is deprecated #3804

Conversation

RonnieDilli commented Oct 18, 2024 • edited by coderabbitai bot Loading

This small changed update the code to use the "http2" directive and fixes the issue #3791.

Summary by CodeRabbit

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Oct 18, 2024

coderabbitai bot commented Oct 18, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

frenck left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

RonnieDilli left a comment

Choose a reason for hiding this comment

frenck left a comment

Choose a reason for hiding this comment

RonnieDilli commented Oct 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)