From nobody Tue Nov 30 01:08:33 2021 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id AC9EC18AD12C; Tue, 30 Nov 2021 01:08:33 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4J33xs2nHYz3MJG; Tue, 30 Nov 2021 01:08:33 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 3BACB4E42; Tue, 30 Nov 2021 01:08:33 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 1AU18XH4015086; Tue, 30 Nov 2021 01:08:33 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 1AU18XTE015085; Tue, 30 Nov 2021 01:08:33 GMT (envelope-from git) Date: Tue, 30 Nov 2021 01:08:33 GMT Message-Id: <202111300108.1AU18XTE015085@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Daniel Ebdrup Jensen Subject: git: bd6dce978c1a - main - rc.conf(5): Add _limits, _login_class, and _oomprotect List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: debdrup X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: bd6dce978c1a4d4472c98ff5685de3c2f2bd0203 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1638234513; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=cm8ekSBOs/Phk/pfvnTDDt1jmyukS1oZSn/Ne6HD0wQ=; b=JqYyrDQkEjO9h6Mot+i9Wyw0/FztyeLFonYJBvRsbSzRchSXX3W7aEUUQi0nrsu4VIc/Bg LttLD1eAV3pPf7yz+AJS8OBt5HUMD84p3tITKFDpqw45i44zmK/GAvG097E6hjHA0HcYgA 7I2Lt+F8t0Qa0yjk4KNw9pcGHOa3IEMQafwbK0XZsHNrhsv6G6K+SUT2auwJbFcILU9b4T 5LPjjFGVx+IAuKdwxJV36Uw1J0dmrRgo06zco1YfN/decz1Z3iR2czis5M1qb56VjOwo7C UHo6/Mt7su6DIHRtXWfQMs1gzHdOTsqxzRyscVR8Su/uU2zP3maNdH24EbA9bg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1638234513; a=rsa-sha256; cv=none; b=xTR5uRM0a21A9rN2II6VP2zQ7bApdHS/dAepzR8mVn4nEA0JJ6kHTOdAmvtNFYMjdYGqFY /Dy2XSf62Ackp0HwcZIy0IfAiBy6lx4zA/c2NfsffUVabQQDGdxJQA+G5ZOtLoFELJE0z6 nZj72FKf8RHUYFZHt2RaDWoJeO5jcYTeFd0lGEnmAikEvxLQPBvpm7UbAp7m41pdo3m8nn 0CAXTRilubjfXFZs5VFCTOe2vd9S/0odSnEsgv9i7DJatJxplJ0AmmNOHAWEvlqBD/fctZ 16PDMaKjTvbM0+G/eDlYcodOv5GalPvEszfJafqY9+nrmBi+0zPCs5+ylxEKLg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by debdrup (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=bd6dce978c1a4d4472c98ff5685de3c2f2bd0203 commit bd6dce978c1a4d4472c98ff5685de3c2f2bd0203 Author: Daniel Ebdrup Jensen AuthorDate: 2021-05-18 12:46:41 +0000 Commit: Daniel Ebdrup Jensen CommitDate: 2021-11-30 01:06:40 +0000 rc.conf(5): Add _limits, _login_class, and _oomprotect Add a few very useful variables that might easily be overlooked, since they're only documented in rc.subr(8) which might not be the first place that people look. At least _oomprotect has existed since 11.0-RELEASE, and doesn't appear to be very well-known. While the others aren't as new, in my estimation, a lot more people would use them if they knew about them. While here, also add a reference to rc.subr(8) and login.conf(5), and sort the variables alphabetically. Reported by: Daniel Dettlaff Reviewed by: ceri, gbe, 0mp, ygy, a.wolk, pauamma --- share/man/man5/rc.conf.5 | 51 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index a22f267c13b9..7a704242373b 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 21, 2021 +.Dd November 30, 2021 .Dt RC.CONF 5 .Os .Sh NAME @@ -192,24 +192,53 @@ services are enabled that utilize the force_depend check. .Pq Vt str .Xr chroot 8 to this directory before running the service. -.It Ao Ar name Ac Ns Va _user -.Pq Vt str -Run the service under this user account. -.It Ao Ar name Ac Ns Va _group -.Pq Vt str -Run the chrooted service under this system group. -Unlike the _user -setting, this setting has no effect if the service is not chrooted. .It Ao Ar name Ac Ns Va _fib .Pq Vt int The .Xr setfib 1 value to run the service under. +.It Ao Ar name Ac Ns Va _group +.Pq Vt str +Run the chrooted service under this system group. +Unlike the +.Ao Ar name Ac Ns Va _user +setting, this setting has no effect if the service is not chrooted. +.It Ao Ar name Ac Ns Va _limits +.Pq Vt str +Resource limits to apply to the service using +.Xr limits 1 . +By default, resource limits are based on the login class defined in +.Ao Ar name Ac Ns Va _login_class . +.It Ao Ar name Ac Ns Va _login_class +.Pq Vt str +Login class to be used with +.Ao Ar name Ac Ns Va _limits . +Defaults to +.Dq Li daemon . .It Ao Ar name Ac Ns Va _nice .Pq Vt int The .Xr nice 1 value to run the service under. +.It Ao Ar name Ac Ns Va _oomprotect +Use +.Xr protect 1 +to prevent the service from being killed when swap space +is exhausted. +Use +.Dq Li YES +to protect only the service itself, and +.Dq Li ALL +to protect the service and all child processes. +.Pp +Please note rc scripts that redefine +.Bd +${name}_cmd +.Ed +such as PostgreSQL will not a inherit the OOM killer protection. +.It Ao Ar name Ac Ns Va _user +.Pq Vt str +Run the service under this user account. .It Va apm_enable .Pq Vt bool If set to @@ -4625,6 +4654,8 @@ it will be made permanently active. .Xr gdb 1 , .Xr info 1 , .Xr kbdcontrol 1 , +.Xr limits 1 , +.Xr protect 1 , .Xr sh 1 , .Xr vi 1 , .Xr vidcontrol 1 , @@ -4646,6 +4677,7 @@ it will be made permanently active. .Xr ipnat 5 , .Xr jail.conf 5 , .Xr loader.conf 5 , +.Xr login.conf 5 , .Xr motd 5 , .Xr newsyslog.conf 5 , .Xr pf.conf 5 , @@ -4694,6 +4726,7 @@ it will be made permanently active. .Xr quotaon 8 , .Xr rc 8 , .Xr rc.sendmail 8 , +.Xr rc.subr 8 , .Xr rcorder 8 , .Xr rfcomm_pppd 8 , .Xr route 8 ,