[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Review of new English templates for miniupnpd



Yangfl wrote:
> Template: miniupnpd/start_daemon
> Type: boolean
> Default: false
> _Description: Start the MiniUPnP daemon automatically?
>  Choose this option if the MiniUPnP daemon should start automatically,
>  now and at boot time.
>  .
>  Be aware, the default settings for this package are only suitable for a fresh,
>  unmodified system. If the firewall is already configured (by you or other
>  software), choose 'No' now, edit /etc/miniupnpd/miniupnpd.conf **AND**
>  /etc/miniupnpd/*.sh scripts accordingly, and enable the daemon later with
>  `service miniupnpd enable`.

This one's tricky.  "By you or other software" implies that the reader
is also software; but it would be meaningless to talk about a firewall
being set up "either manually or using software" since all firewalls
are created via software.

Meanwhile it's possible that a firewall has already been configured in
a way that causes no problems for miniUPnPd (it might for instance be a
logging-only nftables setup).  Shouldn't it be saying something more
explicit about what the firewall might be doing that would cause a
problem?  That would make it something like

   Be aware that the default settings for this package are only suitable for
   a system where the ports required are accessible. If a firewall has
   been set up blocking them, you should reject this option now, edit
   /etc/miniupnpd/miniupnpd.conf and the scripts in /etc/miniupnpd/*.sh
   appropriately, and enable the daemon later with "service miniupnpd enable".

(I've no idea what the relevant ports are, so I hope your users can
think of some better search engine queries than I could.)

>   .
>  Be extremely careful if you don't have physical access to the machine, as you
>  may be blocked by the firewall immediately.

Because I might be using UPnP port redirection for my SSH connection?
Except that I haven't started the miniUPnP daemon yet, so how does
that work?

>  .
>  If in doubt, choose 'no'.

DevRef's section on Debconf templates at
https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#general-recommendations-for-authors-and-translators
says to avoid assuming that the debconf UI uses specific features like
the words "yes" or "no" - instead it's something like

   If in doubt, reject this option.

So that would be:

 Template: miniupnpd/start_daemon
 Type: boolean
 Default: false
 _Description: Start the MiniUPnP daemon automatically?
  Choose this option if the MiniUPnP daemon should start automatically,
  now and at boot time.
  .
  Be aware that the default settings for this package are only suitable for
  a system where the ports required are accessible. If a firewall has
  been set up blocking them, you should reject this option now, edit
  /etc/miniupnpd/miniupnpd.conf and the scripts in /etc/miniupnpd/*.sh
  appropriately, and enable the daemon later with "service miniupnpd enable".
  .
  Be extremely careful if you don't have physical access to the machine, as you
  may be blocked by the firewall immediately.
  .
  If in doubt, reject this option.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package


Reply to: