From 93d4e43cfadf8c5aa499b126c5d452b336205342 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Tue, 2 Nov 2021 00:05:59 +0100 Subject: [PATCH] README: mention need to raise memlock limits --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 3678786..f8e7e7a 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,16 @@ of sub-implementations for different protocols: - Install Rust with [rustup](https://rustup.rs/) (stable is recommended) - Install cmake with your package manager (e.g., `apt-get install cmake`) +- Unless you're planning to only run aquatic_udp and only the cross-platform, + mio based implementation, make sure locked memory limits are sufficient. + You can do this by adding the following lines to `/etc/security/limits.conf`, + and then logging out and back in: + +``` +* hard memlock 512 +* soft memlock 512 +``` + - Clone this git repository and enter it ### Compiling