Update website

mathieucarbou · mathieucarbou · commit 5e7c3153106b · 2026-02-14T19:42:01.000+01:00
diff --git a/docs/eventsource.md b/docs/eventsource.md
@@ -5,7 +5,7 @@
 The server includes EventSource (Server-Sent Events) plugin which can be used to send short text events to the browser.
 Difference between EventSource and WebSockets is that EventSource is single direction, text-only protocol.
 
-See the [ServerSentEvents example here](../examples/ServerSentEvents/ServerSentEvents.ino).
+See the [ServerSentEvents example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ServerSentEvents/ServerSentEvents.ino).
 
 ### Setup Event Source on the server
 
diff --git a/docs/filters.md b/docs/filters.md
@@ -10,7 +10,7 @@ Two filter callback are provided for convince:
 - `ON_STA_FILTER` - return true when requests are made to the STA (station mode) interface.
 - `ON_AP_FILTER` - return true when requests are made to the AP (access point) interface.
 
-See the [Filters example here](../examples/Filters/Filters.ino).
+See the [Filters example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Filters/Filters.ino).
 
 ### Serve different site files in AP mode
 
diff --git a/docs/middleware.md b/docs/middleware.md
@@ -40,7 +40,7 @@ AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest* request, ArMiddlew
 - `LoggerMiddleware`: to log requests globally or per handler with the same pattern as curl. Will also record request processing time
 - `AsyncRateLimitMiddleware`: to limit the number of requests on a windows of time globally or per handler
 
-See the [Middleware example here](../examples/Middleware/Middleware.ino).
+See the [Middleware example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Middleware/Middleware.ino).
 
 ### CORS with AsyncCorsMiddleware
 
@@ -114,7 +114,7 @@ server.addMiddleware(&authMiddleware); // globally add authentication to the ser
 myHandler.addMiddleware(&authMiddleware); // add authentication to a specific handler
 ```
 
-See the [Auth example here](../examples/Auth/Auth.ino).
+See the [Auth example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Auth/Auth.ino).
 
 ### Migration to Middleware to improve performance and memory usage
 
diff --git a/docs/requests.md b/docs/requests.md
@@ -44,7 +44,46 @@ if(request->hasHeader("MyHeader")){
 }
 ```
 
-See the [Headers example here](../examples/Headers/Headers.ino).
+See the [Headers example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Headers/Headers.ino).
+
+## Path Variable
+
+With path variable you can create a custom regex rule for a specific parameter in a route.
+For example we want a `sensorId` parameter in a route rule to match only a integer.
+
+```cpp
+  server.on("^\\/sensor\\/([0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) {
+      String sensorId = request->pathArg(0);
+  });
+```
+
+_NOTE_: All regex patterns starts with `^` and ends with `$`
+
+To enable the `Path variable` support, you have to define the buildflag `-DASYNCWEBSERVER_REGEX`.
+
+For Arduino IDE create/update `platform.local.txt`:
+
+`Windows`: C:\Users\(username)\AppData\Local\Arduino15\packages\\`{espxxxx}`\hardware\\`espxxxx`\\`{version}`\platform.local.txt
+
+`Linux`: ~/.arduino15/packages/`{espxxxx}`/hardware/`{espxxxx}`/`{version}`/platform.local.txt
+
+Add/Update the following line:
+
+```
+  compiler.cpp.extra_flags=-DASYNCWEBSERVER_REGEX
+```
+
+For platformio modify `platformio.ini`:
+
+```ini
+[env:myboard]
+build_flags =
+  -DASYNCWEBSERVER_REGEX
+```
+
+_NOTE_: By enabling `ASYNCWEBSERVER_REGEX`, `<regex>` will be included. This will add an 100k to your binary.
+
+See the [URIMatcher example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/URIMatcher/URIMatcher.ino) and [URIMatcherTest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/URIMatcherTest/URIMatcherTest.ino).
 
 ### GET, POST and FILE parameters
 
@@ -85,7 +124,7 @@ if(request->hasArg("download"))
   String arg = request->arg("download");
 ```
 
-See the [Params example here](../examples/Params/Params.ino).
+See the [Params example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Params/Params.ino).
 
 ### FILE Upload handling
 
@@ -103,7 +142,7 @@ void handleUpload(AsyncWebServerRequest *request, String filename, size_t index,
 }
 ```
 
-See the [Upload example here](../examples/Upload/Upload.ino).
+See the [Upload example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Upload/Upload.ino).
 
 ### Body data handling
 
@@ -138,7 +177,7 @@ AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/en
 server.addHandler(handler);
 ```
 
-See the [Json example here](../examples/Json/Json.ino).
+See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Json/Json.ino).
 
 ### MessagePack body handling
 
@@ -155,4 +194,4 @@ AsyncCallbackMessagePackWebHandler* handler = new AsyncCallbackMessagePackWebHan
 server.addHandler(handler);
 ```
 
-See the [MessagePack example here](../examples/MessagePack/MessagePack.ino).
+See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/MessagePack/MessagePack.ino).
diff --git a/docs/responses.md b/docs/responses.md
@@ -15,7 +15,7 @@
 
 This will send error 400 instead of 200.
 
-See the [example here](../examples/Replace/Replace.ino).
+See the [example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Replace/Replace.ino).
 
 ## Request Continuation
 
@@ -63,7 +63,7 @@ if (auto request = requestPtr.lock()) {
 }
 ```
 
-See the [RequestContinuation example here](../examples/RequestContinuation/RequestContinuation.ino) and [RequestContinuationComplete example here](../examples/RequestContinuationComplete/RequestContinuationComplete.ino).
+See the [RequestContinuation example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/RequestContinuation/RequestContinuation.ino) and [RequestContinuationComplete example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/RequestContinuationComplete/RequestContinuationComplete.ino).
 
 ## Responses
 
@@ -77,7 +77,7 @@ request->redirect("/login");
 request->redirect("http://esp8266.com");
 ```
 
-See the [Redirect example here](../examples/Redirect/Redirect.ino).
+See the [Redirect example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Redirect/Redirect.ino).
 
 ### Basic response with HTTP Code
 
@@ -139,7 +139,7 @@ const char index_html[] PROGMEM = "..."; // large char array, tested with 14k
 request->send_P(200, "text/html", index_html, processor);
 ```
 
-See the [Templates example here](../examples/Templates/Templates.ino).
+See the [Templates example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Templates/Templates.ino).
 
 ### Send large webpage from PROGMEM containing templates and extra headers
 
@@ -291,7 +291,7 @@ request->send(LittleFS, "/index.htm", "text/plain");
 request->send(LittleFS, "/index.htm", String(), true);
 ```
 
-See the [StaticFile example here](../examples/StaticFile/StaticFile.ino).
+See the [StaticFile example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/StaticFile/StaticFile.ino).
 
 ### Respond with content coming from a File and extra headers
 
@@ -361,7 +361,7 @@ request->send("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index
 });
 ```
 
-See the [ChunkResponse example here](../examples/ChunkResponse/ChunkResponse.ino).
+See the [ChunkResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkResponse/ChunkResponse.ino).
 
 ### Respond with content using a callback and extra headers
 
@@ -507,7 +507,7 @@ response->addHeader("Server","ESP Async Web Server");
 request->send(response);
 ```
 
-See the [ChunkRequest example here](../examples/ChunkRequest/ChunkRequest.ino) and [ChunkRetryResponse example here](../examples/ChunkRetryResponse/ChunkRetryResponse.ino).
+See the [ChunkRequest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkRequest/ChunkRequest.ino) and [ChunkRetryResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkRetryResponse/ChunkRetryResponse.ino).
 
 ### Chunked Response containing templates
 
@@ -585,7 +585,7 @@ response->print("</body></html>");
 request->send(response);
 ```
 
-See the [AsyncResponseStream example here](../examples/AsyncResponseStream/AsyncResponseStream.ino).
+See the [AsyncResponseStream example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/AsyncResponseStream/AsyncResponseStream.ino).
 
 ### ArduinoJson Basic Response
 
@@ -624,7 +624,7 @@ response->setLength();
 request->send(response);
 ```
 
-See the [Json example here](../examples/Json/Json.ino).
+See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Json/Json.ino).
 
 ### MessagePack Response
 
@@ -643,7 +643,36 @@ response->setLength();
 request->send(response);
 ```
 
-See the [MessagePack example here](../examples/MessagePack/MessagePack.ino).
+See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/MessagePack/MessagePack.ino).
+
+## Adding Default Headers
+
+In some cases, such as when working with CORS, or with some sort of custom authentication system,
+you might need to define a header that should get added to all responses (including static, websocket and EventSource).
+The DefaultHeaders singleton allows you to do this.
+
+Example:
+
+```cpp
+DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", "*");
+webServer.begin();
+```
+
+_NOTE_: You will still need to respond to the OPTIONS method for CORS pre-flight in most cases. (unless you are only using GET)
+
+This is one option:
+
+```cpp
+webServer.onNotFound([](AsyncWebServerRequest *request) {
+  if (request->method() == HTTP_OPTIONS) {
+    request->send(200);
+  } else {
+    request->send(404);
+  }
+});
+```
+
+See the [CORS example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/CORS/CORS.ino).
 
 ## Bad Responses
 
diff --git a/docs/routing.md b/docs/routing.md
@@ -121,7 +121,7 @@ Usage:
   server.addRewrite( new OneParamRewrite("/radio/{frequence}", "/radio?f={frequence}") );
 ```
 
-See the [Rewrite example here](../examples/Rewrite/Rewrite.ino).
+See the [Rewrite example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Rewrite/Rewrite.ino).
 
 ## Remove handlers and rewrites
 
diff --git a/docs/setup.md b/docs/setup.md
@@ -1,37 +1,4 @@
-# Setup
-
-## Scanning for available WiFi Networks
-
-```cpp
-//First request will return 0 results unless you start scan from somewhere else (loop/setup)
-//Do not request more often than 3-5 seconds
-server.on("/scan", HTTP_GET, [](AsyncWebServerRequest *request){
-  String json = "[";
-  int n = WiFi.scanComplete();
-  if(n == -2){
-    WiFi.scanNetworks(true);
-  } else if(n){
-    for (int i = 0; i < n; ++i){
-      if(i) json += ",";
-      json += "{";
-      json += "\"rssi\":"+String(WiFi.RSSI(i));
-      json += ",\"ssid\":\""+WiFi.SSID(i)+"\"";
-      json += ",\"bssid\":\""+WiFi.BSSIDstr(i)+"\"";
-      json += ",\"channel\":"+String(WiFi.channel(i));
-      json += ",\"secure\":"+String(WiFi.encryptionType(i));
-      json += ",\"hidden\":"+String(WiFi.isHidden(i)?"true":"false");
-      json += "}";
-    }
-    WiFi.scanDelete();
-    if(WiFi.scanComplete() == -2){
-      WiFi.scanNetworks(true);
-    }
-  }
-  json += "]";
-  request->send(200, "application/json", json);
-  json = String();
-});
-```
+# Server Setup
 
 ## Setting up the server
 
@@ -172,7 +139,7 @@ void loop(){
 }
 ```
 
-**IMPORTANT**: Authentication should now use `AsyncAuthenticationMiddleware` instead of the deprecated methods. See the [How to use authentication with AsyncAuthenticationMiddleware](#how-to-use-authentication-with-asyncauthenticationmiddleware) section.
+**IMPORTANT**: Authentication should now use `AsyncAuthenticationMiddleware` instead of the deprecated methods. See the [How to use authentication with AsyncAuthenticationMiddleware](middleware.md#how-to-use-authentication-with-asyncauthenticationmiddleware) section.
 
 ### Setup global and class functions as request handlers
 
@@ -228,97 +195,3 @@ void loop() {
   if ( !ws.enabled() )
     ws.enable(true);
 ```
-
-Example of OTA code
-
-```cpp
-  // OTA callbacks
-  ArduinoOTA.onStart([]() {
-    // Clean SPIFFS
-    SPIFFS.end();
-
-    // Clean LittleFS
-    LittleFS.end();
-
-    // Disable client connections
-    ws.enable(false);
-
-    // Advertise connected clients what's going on
-    ws.textAll("OTA Update Started");
-
-    // Close them
-    ws.closeAll();
-
-  });
-
-```
-
-See the [EndBegin example here](../examples/EndBegin/EndBegin.ino).
-
-### Adding Default Headers
-
-In some cases, such as when working with CORS, or with some sort of custom authentication system,
-you might need to define a header that should get added to all responses (including static, websocket and EventSource).
-The DefaultHeaders singleton allows you to do this.
-
-Example:
-
-```cpp
-DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", "*");
-webServer.begin();
-```
-
-_NOTE_: You will still need to respond to the OPTIONS method for CORS pre-flight in most cases. (unless you are only using GET)
-
-This is one option:
-
-```cpp
-webServer.onNotFound([](AsyncWebServerRequest *request) {
-  if (request->method() == HTTP_OPTIONS) {
-    request->send(200);
-  } else {
-    request->send(404);
-  }
-});
-```
-
-See the [CORS example here](../examples/CORS/CORS.ino).
-
-### Path variable
-
-With path variable you can create a custom regex rule for a specific parameter in a route.
-For example we want a `sensorId` parameter in a route rule to match only a integer.
-
-```cpp
-  server.on("^\\/sensor\\/([0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) {
-      String sensorId = request->pathArg(0);
-  });
-```
-
-_NOTE_: All regex patterns starts with `^` and ends with `$`
-
-To enable the `Path variable` support, you have to define the buildflag `-DASYNCWEBSERVER_REGEX`.
-
-For Arduino IDE create/update `platform.local.txt`:
-
-`Windows`: C:\Users\(username)\AppData\Local\Arduino15\packages\\`{espxxxx}`\hardware\\`espxxxx`\\`{version}`\platform.local.txt
-
-`Linux`: ~/.arduino15/packages/`{espxxxx}`/hardware/`{espxxxx}`/`{version}`/platform.local.txt
-
-Add/Update the following line:
-
-```
-  compiler.cpp.extra_flags=-DASYNCWEBSERVER_REGEX
-```
-
-For platformio modify `platformio.ini`:
-
-```ini
-[env:myboard]
-build_flags =
-  -DASYNCWEBSERVER_REGEX
-```
-
-_NOTE_: By enabling `ASYNCWEBSERVER_REGEX`, `<regex>` will be included. This will add an 100k to your binary.
-
-See the [URIMatcher example here](../examples/URIMatcher/URIMatcher.ino) and [URIMatcherTest example here](../examples/URIMatcherTest/URIMatcherTest.ino).
diff --git a/docs/websockets.md b/docs/websockets.md
@@ -40,7 +40,7 @@ I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain furt
 The server includes a web socket plugin which lets you define different WebSocket locations to connect to
 without starting another listening service or using different port
 
-See the [WebSocket example here](../examples/WebSocket/WebSocket.ino) and [WebSocketEasy example here](../examples/WebSocketEasy/WebSocketEasy.ino).
+See the [WebSocket example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/WebSocket/WebSocket.ino) and [WebSocketEasy example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/WebSocketEasy/WebSocketEasy.ino).
 
 ### Async WebSocket Event
 
diff --git a/mkdocs.yml b/mkdocs.yml
