From a44976419782fbc54faaa178f02198137d5e1e8d Mon Sep 17 00:00:00 2001 From: gigirassy Date: Sun, 19 Jul 2026 21:47:09 +0200 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c85fba9..36c0de1 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,14 @@ it has extremely minimal dependencies, so minimal that you can tack on a craploa it is compiled with ``panic=immediate-abort``. +## flavors + +the official docker image comes in two flavors, ``latest`` and ``mimalloc``. + +the ``latest`` one uses a basic rust alpine container to build teletraan, thus using alpine's default allocator. this allocator has a history of performance issues; albeit for a basic web server it may be suitable for most use cases. + +the ``mimalloc`` one uses chimera for the build stage, which is a musl distro based on the llvm toolchain and which patches the musl libc to use mimalloc, a performance-based allocator made by microsoft, as default allocator. this means that the binary here uses the mimalloc allocator during runtime, which fixes performance issues but is less secure. regardless, it shouldnt matter much if you run teletraan read-only. + ## example usage ### compose file