net/i2pd README improvements

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

net/i2pd README improvements

Richard Ulmer
Hi,
I'm happy to see that net/i2pd has been updated recently, thanks to
everyone involved! I find the README file a very good addition; It could
have spared me a few hours of tinkering and a GitHub ticket [1], had I
found it earlier.

I think a few slight improvements could be made to the README:

1. Use "openfiles" instead of setting "openfiles-cur" and
   "openfiles-max" to the same value in /etc/login.conf.
2. Provide the command for changing the login class of the _i2pd user.
3. Use either spaces or tab for indentation (it's mixed right now)

[1] https://github.com/PurpleI2P/i2pd/issues/1537

Index: net/i2pd/pkg/README
===================================================================
RCS file: /cvs/ports/net/i2pd/pkg/README,v
retrieving revision 1.1
diff -u -p -u -r1.1 README
--- net/i2pd/pkg/README 28 May 2020 20:57:30 -0000 1.1
+++ net/i2pd/pkg/README 24 Jun 2020 18:07:30 -0000
@@ -15,12 +15,15 @@ also raise the system-wide maxfiles limi
 
 1. Configure i2pd login class in the login.conf(5) file:
 
-        i2pd:\
-                :openfiles-cur=8192:\
-                :openfiles-max=8192:\
-                :tc=daemon:
+ i2pd:\
+ :openfiles=8192:\
+ :tc=daemon:
 
-2. Adjust kern.maxfiles, if needed:
+2. Assign the i2pd login class to the _i2pd user:
+
+ # usermod -L i2pd _i2pd
+
+3. Adjust kern.maxfiles, if needed:
 
  # sysctl kern.maxfiles=16000
  # echo "kern.maxfiles=16000" >> /etc/sysctl.conf

Reply | Threaded
Open this post in threaded view
|

Re: net/i2pd README improvements

Jeremie Courreges-Anglas-2
On Wed, Jun 24 2020, "Richard Ulmer" <[hidden email]> wrote:
> Hi,

Hi Richard,

> I'm happy to see that net/i2pd has been updated recently, thanks to
> everyone involved! I find the README file a very good addition; It could
> have spared me a few hours of tinkering and a GitHub ticket [1], had I
> found it earlier.
>
> I think a few slight improvements could be made to the README:
>
> 1. Use "openfiles" instead of setting "openfiles-cur" and
>    "openfiles-max" to the same value in /etc/login.conf.

This would match what we have in base for bgpd and unbound: they
override "openfiles", not "openfile-max" and "openfile-cur".

> 2. Provide the command for changing the login class of the _i2pd user.

I don't think this is warranted.  /etc/rc.d/rc.subr has this code:

--8<--
# set default values; duplicated in rcctl(8)
getcap -f /etc/login.conf ${_name} 1>/dev/null 2>&1 && daemon_class=${_name} ||
        daemon_class=daemon
-->8--

and later

--8<--
rcexec="su -l -c ${daemon_class} -s /bin/sh ${daemon_user} -c"
-->8--

with ${_name} being the basename of the rc script, in your case "i2pd".

Disclaimer: I'm no i2pd user and I haven't tested what we have in tree
right now.

> 3. Use either spaces or tab for indentation (it's mixed right now)
>
> [1] https://github.com/PurpleI2P/i2pd/issues/1537
>
> Index: net/i2pd/pkg/README
> ===================================================================
> RCS file: /cvs/ports/net/i2pd/pkg/README,v
> retrieving revision 1.1
> diff -u -p -u -r1.1 README
> --- net/i2pd/pkg/README 28 May 2020 20:57:30 -0000 1.1
> +++ net/i2pd/pkg/README 24 Jun 2020 18:07:30 -0000
> @@ -15,12 +15,15 @@ also raise the system-wide maxfiles limi
>  
>  1. Configure i2pd login class in the login.conf(5) file:
>  
> -        i2pd:\
> -                :openfiles-cur=8192:\
> -                :openfiles-max=8192:\
> -                :tc=daemon:
> + i2pd:\
> + :openfiles=8192:\
> + :tc=daemon:
>  
> -2. Adjust kern.maxfiles, if needed:
> +2. Assign the i2pd login class to the _i2pd user:
> +
> + # usermod -L i2pd _i2pd
> +
> +3. Adjust kern.maxfiles, if needed:
>  
>   # sysctl kern.maxfiles=16000
>   # echo "kern.maxfiles=16000" >> /etc/sysctl.conf
>

--
jca | PGP : 0x1524E7EE / 5135 92C1 AD36 5293 2BDF  DDCC 0DFA 74AE 1524 E7EE

Reply | Threaded
Open this post in threaded view
|

Re: net/i2pd README improvements

Richard Ulmer
Hi Jeremie,

Jeremie Courreges-Anglas <[hidden email]> wrote:

> > 2. Provide the command for changing the login class of the _i2pd user.
>
> I don't think this is warranted.  /etc/rc.d/rc.subr has this code:
>
> --8<--
> # set default values; duplicated in rcctl(8)
> getcap -f /etc/login.conf ${_name} 1>/dev/null 2>&1 && daemon_class=${_name} ||
> daemon_class=daemon
> -->8--
>
> and later
>
> --8<--
> rcexec="su -l -c ${daemon_class} -s /bin/sh ${daemon_user} -c"
> -->8--
>
> with ${_name} being the basename of the rc script, in your case "i2pd".
>
> Disclaimer: I'm no i2pd user and I haven't tested what we have in tree
> right now.

Thanks for the enlightenment! I'm not sure how I could test this,
since I already used usermod(8), but I think you are very likely
correct. I had already wondered why other READMEs - like the ones from
net/syncthing or net/go-ipfs - didn't mention usermod(8).

Best regards,
Richard