Skip to content
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

security/pfSense-pkg-acme: update formatting and descriptions #1248

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

heitbaum
Copy link

Formatting updates for ACME

  • fix indentation in acme.inc
  • Use correct ACME capitalisation
  • update spacing between functions / code blocks
  • standarise on “, “ between variables
  • Fix v2 text
  • Fix help text

<include_file>/usr/local/pkg/acme/acme.inc</include_file>
<menu>
<name>Acme Certificates</name>
<name>ACME Certificates</name>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the menu name is fairly disruptive. Even just changing the case, it won't match in the code that adds/removes menu entries and some users will end up with two menu entries depending on what they do.


$section->addInput(new \Form_Input(
'email',
'E-Mail Address',
'text',
$pconfig['email']
))->setHelp('The e-mail address to register for this key. This is used by Let\'s Encrypt to send automated certificate expiration notices.');
))->setHelp('The e-mail address to register for this key. This is used to send automated certificate expiration notices.');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should at least retain a reference to it being the CA that sends these not the firewall. It's easy for users to be confused otherwise.

e.g. "The ACME Server/CA may send messages to this address, such as automated notices for expiring certificates."

@jim-p
Copy link
Contributor

jim-p commented Mar 27, 2023

To effectively track changes and bug/feature requests, we require an entry on the pfSense Redmine issue tracker associated with every pull request, and likewise the Redmine entry should also have a link back to the pull request.

Please associate this PR to a Redmine issue either by locating an existing issue at https://redmine.pfsense.org or by creating a new issue. Add a link to the Redmine issue that points to this PR, and also add a link on the PR to the Redmine issue.

For more information, see https://docs.netgate.com/pfsense/en/latest/development/pull-request.html
Thanks!

@marcos-ng marcos-ng changed the title security/pfSense-pkg-acme: update code formatting security/pfSense-pkg-acme: update formatting and descriptions Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants