Bug 212637 - dns/noip: Improve post-install message for clarity and convenience
Summary: dns/noip: Improve post-install message for clarity and convenience
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Dmitry Marakasov
URL:
Keywords: easy, patch
Depends on:
Blocks:
 
Reported: 2016-09-13 02:43 UTC by Dale Scott
Modified: 2016-09-13 16:41 UTC (History)
2 users (show)

See Also:
koobs: maintainer-feedback? (sthalik)
sthalik: maintainer-feedback+
koobs: merge-quarterly?


Attachments
diff -u pkg-message.in pkg-message.in.proposed > pkg-message.in.diff (1.49 KB, patch)
2016-09-13 02:43 UTC, Dale Scott
koobs: maintainer-approval? (sthalik)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dale Scott 2016-09-13 02:43:35 UTC
Created attachment 174701 [details]
diff -u pkg-message.in pkg-message.in.proposed > pkg-message.in.diff

I would like to suggest a change to the noip pkg-message to provide additional information for binary install using pkg. 
 
I recently rebuilt several systems, including installing the noip DDNS client. I must have a terrible memory, because each time I had to search for the files installed by the package and then read README.FIRST to re-learn how to configure the package for use.
 
To save time the next time I install noip, I propose a wording change for the post-install message. I have included some additional information for clarity assuming that many users will be part-time sysadmins like me. I discussed this off-list with the port maintainer on record (Stanislaw Halik), who agreed in concept and requested I submit a PR including diff file.

Current post-install message:

###########################################################
You need to generate the noip config file 'no-ip2.conf' in
%%PREFIX%%/etc/no-ip2.conf.  To do this automatically, run:

	make conf

You need to register with www.no-ip.com to use this port.

You also need to add the following line to your
/etc/rc.conf or /etc/rc.conf.local file:
noip_enable="YES"
###########################################################


Proposed post-install message:

###########################################################
You must have a registered host with No-IP (www.noip.com)
to use the noip Dynamic DNS Update Client (DUC).

You must also create the noip config file
%%PREFIX%%/etc/no-ip2.conf before using noip. To create the
configuration file, run as root:

/usr/local/bin/noip2 -C

You will be prompted to enter the Ethernet port that will be
associated with the host, your No-IP account name and
password, and the hostname you have registered with No-IP.
Your No-IP username and password are not stored, the
config file contains a unique key for the DUC to access the
No-IP DDNS service and only root has read permission.

If you are compiling from source using the ports tree, you
can also “make conf” to create the config file.

To run noip automatically at boot, add the following line
to /etc/rc.conf

noip_enable="YES"

Refer to the following for more information:

/usr/local/bin/noip2 --help
/usr/local/share/doc/noip/README.FIRST
###########################################################
Comment 1 Kubilay Kocak freebsd_committer freebsd_triage 2016-09-13 12:13:38 UTC
Notify maintainer. This was prevented due to missing "dns/noip" in summary on initial issue creation.

Thank you for the report and patch Dale
Comment 2 Stanislaw Halik 2016-09-13 12:48:24 UTC
The patch is fine. I see how it's necessary for some users to avoid POLA.

+1
Comment 3 commit-hook freebsd_committer 2016-09-13 16:41:48 UTC
A commit references this bug:

Author: amdmi3
Date: Tue Sep 13 16:41:09 UTC 2016
New revision: 422034
URL: https://svnweb.freebsd.org/changeset/ports/422034

Log:
  - Make pkg-message more useful
  - While here, fix license and remove unneeded PKGMESSAGE line (PKGMESSAGE is set by SUB_FILES)

  PR:		212637
  Submitted by:	dalescott@shaw.ca
  Approved by:	sthalik@tehran.lain.pl (maintainer)

Changes:
  head/dns/noip/Makefile
  head/dns/noip/files/pkg-message.in