Skip to content

NOSS install guide: OpenSSL build instructions are Mac-specific without context; lack guidance for other platforms and architectures #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
travisamartin opened this issue Apr 28, 2025 · 0 comments
Assignees
Labels
bug Something isn't working customer-feedback product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)

Comments

@travisamartin
Copy link
Contributor

Description

In the Installing NGINX Open Source documentation, the instructions for building OpenSSL assume a MacOS Intel (x86_64) environment:

./Configure darwin64-x86_64-cc --prefix=/usr

However:

  • The documentation does not explain that this command is specific to MacOS (Intel architecture).
  • No guidance is given for users on ARM-based Macs (e.g., M1, M2), who would require a different configuration target such as darwin64-arm64-cc.
  • No instructions are provided for Linux, Windows/WSL, or other platforms, despite OpenSSL being available cross-platform.
  • No links are provided to OpenSSL's documentation for identifying the correct configuration target.

This can lead to installation errors or confusion for users who are not on Intel-based Macs.

Suggested Fixes

  • Add a note clarifying that the provided command is specific to Intel-based MacOS systems.
  • Provide guidance for Apple Silicon (ARM64) users, suggesting use of darwin64-arm64-cc.
  • Offer alternative guidance for Linux users (e.g., typically running ./config without a platform target).
  • Add a link to the OpenSSL INSTALL.md for users to find the correct build targets for their system.
  • Optionally, split the OpenSSL instructions into MacOS and Linux sections if commands differ significantly.

Priority

Medium–High — This impacts a wide range of users compiling from source, especially those using newer Apple Silicon Macs or Linux systems.

Screenshots

Image

Image

@travisamartin travisamartin added bug Something isn't working product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) customer-feedback labels Apr 28, 2025
@y82 y82 self-assigned this Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working customer-feedback product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

No branches or pull requests

2 participants