From debbugs-submit-bounces@debbugs.gnu.org Fri Jul 09 09:55:17 2021 Received: (at 49258) by debbugs.gnu.org; 9 Jul 2021 13:55:18 +0000 Received: from localhost ([127.0.0.1]:58884 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m1qyL-0006tv-9X for submit@debbugs.gnu.org; Fri, 09 Jul 2021 09:55:17 -0400 Received: from mail-fr2deu01on2110.outbound.protection.outlook.com ([40.107.135.110]:64480 helo=DEU01-FR2-obe.outbound.protection.outlook.com) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m1qyI-0006p1-F7 for 49258@debbugs.gnu.org; Fri, 09 Jul 2021 09:55:15 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=j46yboZUz8ivufYYe7i9De61iv/arijB/oBJHPyf44y9omCR19TefcL9mU5UmF61OsYIfgGjof42xOu/1wVCdSKEanxqUPuUdvCF+5U68kxPo1MKb/r0ddpCdZbUfYihQeg4njUGiyS2YxsnsflDzwPI3Ct/sz9XXDt+b3uJvNSwY6C/o4zJKtHScU/Z5aLfWrN+MeLNeNZPJ5FBPDysyFPBhMkkHJHdv79CEoeOSJsx5nQia36GeAHodjGYCs6ZcBdT4pCEuYAotmuyHHRvUOoYqNs6hWabDPALnVabORoMMe2jmhm/euRLmDs+6UnoKvxx2FDGSJ7dVZ8rZ9c8DQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zK93GCIZkJdPvQmrshYdRdYpmjR0CnArto943FwzqWA=; b=JyZa6ACpwcLTkohjO9r7sWNzN+UfEwEr93y5U3VzmVIkL6aj3/OBtBVCuOxb2psKRsNrwPHVN2mGwE6ceTIFt8q903dJrKzYKJkm2aWYrdSXlFxs87KSC7gk1NE5pTBFTL166hW3i/7GBiPA4wy4pqdAG9odxsNC4Z1ZqBDFs/SzSaVRJp1SnzZZqex/fnwbxgYxYlQdoL7o1pXtbRpCjrk0UlbbrAG9rTrh/V4s/sIT9iPwM4joaX+W1/S9zwxdesE5USzpUsUW/e2Imy10YBOlIriLLgrwojIy5kH338lZNc9LYGepXa/ljlO8U+PQNeWOJL1DYzjD/nmihG0gZw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=stern-data.com; dmarc=pass action=none header.from=stern-data.com; dkim=pass header.d=stern-data.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sternasset.onmicrosoft.com; s=selector1-sternasset-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zK93GCIZkJdPvQmrshYdRdYpmjR0CnArto943FwzqWA=; b=mOp626fA4N2KZMBw4CagoKWkiSNze3+54DlhqJr3+d/PQHaq7UkjI4lyB5Ng1pAybg4FiKg7FmBPjZ/OtiOlAZmP3qsGrM/Psg5qZUPlCAsvhV+ZV1aUAcJ2bIVoPQ3D3z2gBnOXJY/JfvrdjC1pkfP/Da8F0845gALW3hbNHd1CkHJZEPmHbr7NXDdq/03LaQPN0wBrxCX+UkMTWvQIjLYbU3YBXmYTMqb8X+FtpRnNUR12V7cqPO6Qao79Fy6LJsPWFgQThILTM56YUs6NTs2FYCpEm6eu1zZR9rOnx2hAvWSxypeUByqjPARX9D4l+nGlLLiXDp6OBLS1ku40Mw== Authentication-Results: debbugs.gnu.org; dkim=none (message not signed) header.d=none;debbugs.gnu.org; dmarc=none action=none header.from=stern-data.com; Received: from BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM (2603:10a6:b10:f::11) by BEXP281MB0136.DEUP281.PROD.OUTLOOK.COM (2603:10a6:b10:6::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.10; Fri, 9 Jul 2021 13:55:06 +0000 Received: from BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM ([fe80::b9ef:9f1:8c7c:cb72]) by BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM ([fe80::b9ef:9f1:8c7c:cb72%9]) with mapi id 15.20.4331.014; Fri, 9 Jul 2021 13:55:06 +0000 From: Aljosha Papsch To: 49258@debbugs.gnu.org Subject: [PATCH 3/4] guix.texi: Document wondershaper-service-type. Date: Fri, 9 Jul 2021 15:54:08 +0200 Message-Id: <20210709135409.54308-4-ep@stern-data.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210709135409.54308-1-ep@stern-data.com> References: <20210709135409.54308-1-ep@stern-data.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: AM3PR05CA0113.eurprd05.prod.outlook.com (2603:10a6:207:2::15) To BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM (2603:10a6:b10:f::11) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from localhost.localdomain (2a02:908:c39:9d60:ec9b:bd9a:f3b7:625d) by AM3PR05CA0113.eurprd05.prod.outlook.com (2603:10a6:207:2::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4308.20 via Frontend Transport; Fri, 9 Jul 2021 13:55:05 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: d1b3ac1f-a75e-4e23-146d-08d942e1284e X-MS-TrafficTypeDiagnostic: BEXP281MB0136: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:8273; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 1rEyR93M3hZ+bhBtKtd3VgKcbmTTFVerQf2Ed1i+lhKGUdAHFZL3b4/WBRtlMhBXr7VK9+M99yIg1S7+skKYDz2JCVVqaHN6z3qI4EpGMJf0aNEwZOAQpwhEfSrdGsTW2nQ+bO0TdO1TcZUOdu3W9IkA5gRRf7YMgXM+hX762bTv6UweH9f4vtEFcUPcp2PBKPEDoMxkPmyiwOjPXvA9bvqHl6qk+1d8jUtxq9yqnZ/cnYSrOTB94YLbAxlvt7Uy1kP2IxD58Vwt8aXzwebBVDiUDQIzxu4NMsiFW1d3fimqjjGHw6mQoZUQ48s3fIiv33Pfqa1BrEtKrjzLWUNR+i8N+2Noy6+Vk8Na89G06co5uJfbwgdqI8aM8iYMrmNxZ3lZfOSSCJl1T36pimgg+ecjsIwd7tBM49fp57wsWWq0uWBkWw7n525119K4tc2IxAh5eMgDNT3urdn2mJ11MIb5TAnDVCh6ASuYCTwwiUTw9Yq/QfjzDGmY9AkdYv5dGsypvENJ/Vx96jNLtCgx9FfkK25HROI5cfAeUrmLvwyTaQRSjjh/IQZp3v9AMgcwYeMHIVrDSLiOZG3V9uPk+3N0uJ+Uy9jphsmakO3Y9RyWNGoddG9pKjUGHx1vwPSHypOt0bXZBcpt/I7TlbCOODuk/x9+X/gUsvfiMdMW9FhQtvvvbSDuR4tWqZMhHSzypO2A+7sM5Yt2IAsazqQ3dJUPCvJ1lxiBfgcvsZlEfv4= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM; PTR:; CAT:NONE; SFS:(4636009)(366004)(396003)(346002)(136003)(376002)(39830400003)(6916009)(52116002)(66946007)(83380400001)(186003)(5660300002)(6486002)(66476007)(6506007)(2906002)(107886003)(2616005)(478600001)(38100700002)(6512007)(4326008)(66556008)(36756003)(316002)(8936002)(8676002)(86362001)(1076003); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?JJ9jcUmzWpVEc8Q03LrUkK/k77+ExhP9bPwJS3bd9+ABKTuUoMO3Rxb5f0OP?= =?us-ascii?Q?uyjphKdSN9OL4ZAyx2kiO5iX2+ceNHUG2PTwoKEg4lX4Bp6iblWK6Ukr74Tu?= =?us-ascii?Q?h7VtzQmbP2RmKhJi4Gz2tptEgQszFbR/aqPvsAp9f0ViwAqjmpUBxhgWsqKp?= =?us-ascii?Q?kzHsgwyYgpGLhO4zfUj/W4//al9oRC63GJqJA5x0mVFqdcW0OnMFjSiM8tle?= =?us-ascii?Q?3OuCdXdttc2voDXm+WrNozxbQGBb88QOpD5ochlWt16PvEj2lX9XlZ+OXuDU?= =?us-ascii?Q?Oy4uMOBA1D+f/yhy7JvJRExyyx3z1d+oMHnlIdaA4thwbRy59bQpE7KgE0RW?= =?us-ascii?Q?hKoyRPs5vKQJmpwDc+u0ats7ooHA+wpUdhwB12xDwuPQLkRdtJBkP4Spdihz?= =?us-ascii?Q?0EAFNXFe7oWTJtrmmRsQkc1k0BABpn9qnthFKOzQODzFFesaJm+eIJYQBbPy?= =?us-ascii?Q?tuxPVYdSxBBmkYOUG7snEGdKMOAW49rBPjVkZhl3snandkOYgxz9IJRDKF/T?= =?us-ascii?Q?3tq7lJL6IZ88Nhj7W3IPgpxscKB/uhUzQVxZPLWMSIb3QaMufSZaRCBUXrRm?= =?us-ascii?Q?aXf3GSIeqom5e49bWVlEvJtJNxMOsObw4RecGWxxehbOG2RHLUHYz2L0vcI2?= =?us-ascii?Q?q2ErHANvKDKUlJg4r06UciIN2c44XnJ/ygnQrmKPLi9McX5+kY/BdfRs7HfV?= =?us-ascii?Q?95Dcuk9i7X429u51LkhUZ0571q2VviIu2vTU5yUk5DPW8+MqMDxovG7wOUJm?= =?us-ascii?Q?vKxiv7Xsut1qGWuEgH+UDDCSHbrf7v2J2NAaGLafs2oOMvmwr2F3CgY6bpTP?= =?us-ascii?Q?kKd+SVZDgFwP2FmeKwgjAeMMr/KuGN/iR5B6Hgb61fArcZPIHlKQ7xckVORA?= =?us-ascii?Q?JXkESEYgOLvglcx9+F5xZspoBu+Vx7HkXS1OKgC13O3PF39jA8GiJMYNnG8+?= =?us-ascii?Q?GdFSZPZToGNG6+8Ec3TlnJfcoigb82hgC+CwjGk20hQ+7LbkwYgM0LkvsY44?= =?us-ascii?Q?BtCrWz2cy6NNyneipVrF/I05bMl4Y1Tnk6h7vkS2kpuHTuYdjX+Y3f6A5UVo?= =?us-ascii?Q?Ma+9RYx7gGQZ0CGsrinLVosXWeZ9w2CJiPKQyHr/dDj2kycsqQKAOVuQIzot?= =?us-ascii?Q?uABkwoT/9BFgFvpdwx4RxNb6ktEkRSXdeI9KQ4yVbG9qhuFYyZ1Zotvqwa1Q?= =?us-ascii?Q?yWyzkglmkHbeyZBPNk7rZeqlRFDC479l3tOG0tFSpJXSlnBUYwdN7NAuZkGe?= =?us-ascii?Q?q4cVLHhdd+acmPXkNwAYNFuafJETU8EFNQK0lOHQWkN1+yNvbBY9b4mnG9Ja?= =?us-ascii?Q?aUSJtWYfCblK/hbhfh0VOZrOOrllBTDKXePTh4Vd5vDRg7/2yJyNr1SjRl3y?= =?us-ascii?Q?vH2N52N1mcRtV1R2iyhpRM63LGED?= X-OriginatorOrg: stern-data.com X-MS-Exchange-CrossTenant-Network-Message-Id: d1b3ac1f-a75e-4e23-146d-08d942e1284e X-MS-Exchange-CrossTenant-AuthSource: BE0P281MB0034.DEUP281.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jul 2021 13:55:06.2081 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: e55b1d7b-b6d7-445f-a720-8de54d4464ac X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: n3Mdh3Q43gECxpoCJ5ZXI0YhRHPam1z/74Hqv3J7dkxqRteLAoLtwr0f2vgxOD47vclotXFOmSX3TqqeqLpV3g== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BEXP281MB0136 X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 49258 Cc: Aljosha Papsch X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) * doc/guix.texi: Document wondershaper-service-type and wondershaper-configuration fields. --- doc/guix.texi | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index 18bc600440..58238f5935 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -16945,6 +16945,79 @@ See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information. @end deffn +@cindex Wondershaper +@defvr {Scheme Variable} wondershaper-service-type +This is the type for a service that runs +@uref{https://github.com/magnific0/wondershaper, Wonder Shaper} once +during boot. It configures traffic control (tc) with a Hierarchy Token +Bucket (htb) queue both for upload and download. For upload three +classes are added in order to prioritize traffic. Priority 1 is the +highest priority and priority 3 is the lowest priority. Interactive +traffic (e.g. ssh) is designated priority 1, while non-interactive +traffic is designated priority 2. Priority 3 is reserved for specially +configured ports and addresses. The service is configured using a +@code{} record. Some options below are not +found in the original upstream release but are maintained +@uref{https://github.com/apapsch/wondershaper, in a fork} until merged. +These options are marked specially. + +@end defvr + +@deftp {Data Type} wondershaper-configuration +@table @asis +@item @code{wondershaper} (default: @code{wondershaper}) +The package that provides Wonder Shaper. This package is expected to +provide the script at @file{bin/wondershaper} relative to its output +directory. The default package is +@uref{https://github.com/apapsch/wondershaper, a fork of Wonder Shaper} +adding more configuration options. + +@item @code{interface} (default: @code{"eth0"}) +The interface for which the limits shall be applied. + +@item @code{download-speed} (default: @code{2048}) +Maximum download speed in kbits. Tune this parameter to be a bit less than +your actual download speed. + +@item @code{upload-speed} (default: @code{512}) +Maximum upload speed in kbits. Tune this parameter to be a bit less than +your actual upload speed. + +@item @code{prio-3-rate} (default: @code{download-speed * 20 / 100}) +Maximum rate (kbits) for the priority 3 class, which is the lowest priority for +upload traffic. In a desktop environment the default computed value +should suffice, while in a controlled environment you might want to set +a static value. This option exists only in the fork! + +@item @code{prio-3-ceil} (default: @code{download-speed * 90 / 100}) +Maximum burst rate (kbits) for the priority 3 class. The same remarks as +for @code{prio-3-rate} apply. This option exists only in the fork! + +@item @code{high-prio-dest} (default: @code{'()}) +List of destination IP addresses for which traffic is designated +priority 1. This applies to upload only. Note that SSH (not SCP), ICMP +and packets smaller than 64b are automatically designated priority 1 no +matter the destination address. + +@item @code{no-prio-host-src} (default: @code{'()}) +List of source IP addresses for which traffic is designated priority 3. +This applies to upload only. + +@item @code{no-prio-host-dest} (default: @code{'()}) +List of destination IP addresses for which traffic is designated +priority 3. This applies to upload only. + +@item @code{no-prio-port-src} (default: @code{'()}) +List of source port numbers for which traffic is designated priority 3. +This applies to upload only. + +@item @code{no-prio-port-dest} (default: @code{'()}) +List of destination port numbers for which traffic is designated +priority 3. This applies to upload only. + +@end table +@end deftp + The @code{(gnu services rsync)} module provides the following services: You might want an rsync daemon if you have files that you want available -- 2.32.0