From 48aa97351dd9023a4c8df85f912adf43d0bbc489 Mon Sep 17 00:00:00 2001 From: Alex Orlenko Date: Wed, 8 Jun 2022 23:56:26 +0100 Subject: [PATCH] Add Sandboxing section to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 84686be..a0d9b43 100644 --- a/README.md +++ b/README.md @@ -256,6 +256,14 @@ If you encounter them, a bug report would be very welcome: + If you detect that, after catching a panic or during a Drop triggered from a panic, a `Lua` or handle method is triggering other bugs or there is a Lua stack space leak, this is a bug. `mlua` instances are supposed to remain fully usable in the face of user generated panics. This guarantee does not extend to panics marked with "mlua internal error" simply because that is already indicative of a separate bug. +## Sandboxing + +Please check the [Luau Sandboxing] page if you are interested in running untrusted Lua scripts in controlled environment. + +`mlua` provides `Lua::sandbox` method for enabling sandbox mode (Luau only). + +[Luau Sandboxing]: https://luau-lang.org/sandbox + ## License This project is licensed under the [MIT license](LICENSE)