📝 middleware/filesystem does not handle url encoded values on it's own (

#2247) * 📝 middleware/filesystem does not handle url encoded values * Update README.md add newline after first warning Co-authored-by: Xaver Fischer <xaverfischer@mail.de>
gofiber · Dec 1, 2022 · 6d798db · 6d798db
1 parent 3629947
commit 6d798db
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/middleware/filesystem/README.md b/middleware/filesystem/README.md
@@ -2,7 +2,8 @@
 
 Filesystem middleware for [Fiber](https://github.com/gofiber/fiber) that enables you to serve files from a directory.
 
-⚠️ **`:params` & `:optionals?` within the prefix path are not supported!**
+⚠️ **`:params` & `:optionals?` within the prefix path are not supported!**  
+⚠️ **To handle paths with spaces (or other url encoded values) make sure to set `fiber.Config{ UnescapePath: true}`**
 
 ## Table of Contents
 

diff --git a/middleware/filesystem/filesystem.go b/middleware/filesystem/filesystem.go
@@ -64,7 +64,11 @@ var ConfigDefault = Config{
 	MaxAge:     0,
 }
 
-// New creates a new middleware handler
+// New creates a new middleware handler.
+//
+// filesystem does not handle url encoded values (for example spaces)
+// on it's own. If you need that functionality, set "UnescapePath"
+// in fiber.Config
 func New(config ...Config) fiber.Handler {
 	// Set default config
 	cfg := ConfigDefault