https://github.com/cotestatnt/esp-fs-webserver
ESP32/ESP8266 webserver, WiFi manager and web editor Arduino library
https://github.com/cotestatnt/esp-fs-webserver
arduino esp32 esp32-arduino esp8266 esp8266-arduino ffat filesystem littlefs spiffs web-editor webserver wifi-manager wifimanager
Last synced: 3 days ago
JSON representation
ESP32/ESP8266 webserver, WiFi manager and web editor Arduino library
- Host: GitHub
- URL: https://github.com/cotestatnt/esp-fs-webserver
- Owner: cotestatnt
- License: apache-2.0
- Created: 2021-06-18T13:17:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-01-17T10:40:14.000Z (about 2 months ago)
- Last Synced: 2026-01-17T21:35:42.498Z (about 2 months ago)
- Topics: arduino, esp32, esp32-arduino, esp8266, esp8266-arduino, ffat, filesystem, littlefs, spiffs, web-editor, webserver, wifi-manager, wifimanager
- Language: C
- Homepage:
- Size: 10.1 MB
- Stars: 145
- Watchers: 11
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP-FS-WebServer
A library for ESP8266/ESP32 that provides a web server with an integrated file system browser, WiFi configuration manager, and support for WebSockets. This library is based on the synchronous `WebServer` class.
## Features
- **Dynamic WiFi Configuration**: An integrated setup page (`/setup`) allows you to scan for WiFi networks and connect the ESP to your local network. Passwords are stored using AES-256-CBC encryption (hardware on ESP32 platform) with multiple SSIDs manager (up to 5 different WiFi credentials).
- **Powerful & Customizable UI**:
- Easily add your own configuration parameters (text boxes, checkboxes, sliders, dropdown lists) to the setup page.
- Inject custom **HTML, CSS, and JavaScript** snippets into the setup page to create rich, dynamic user interfaces for your specific project needs.
- **Over-the-Air (OTA) Updates**: Update your device's firmware securely and conveniently through the web interface. You can easily upload also your entire web project's `data` folder to the ESP's filesystem.
- **WebSocket Support**: Built-in support for real-time, two-way communication between the web client and the ESP.
- **Advanced File Management**: An embedded file manager (`/edit`) allows you to browse, view, upload, and delete files and folders.
## Documentation
For more detailed information, please refer to the documentation in the `docs` folder:
- **[API Reference](docs/API.md)** – Detailed overview of the public methods.
- **[Setup and WiFi](docs/SetupAndWiFi.md)** – Guide to `startWiFi()`, captive portal, and the `/setup` page.
- **[Filesystem and Editor](docs/FileEditorAndFS.md)** – How to serve static files and use the `/edit` page.
- **[WebSocket](docs/WebSocket.md)** – Information on using the WebSocket server.
- **[Password Encryption](docs/pwd_encrypt.md)** – Information on how passwords are managed.
## Dependencies
- ESP8266/ESP32 Core for Arduino
## Basic Usage
```cpp
#include
#include
#if defined(ESP8266)
#include
#else
#include
#endif
#include "FSWebServer.h"
// Use LittleFS
fs::FS& filesystem = LittleFS;
FSWebServer server(80, filesystem, "esphost");
void setup() {
Serial.begin(115200);
// Initialize Filesystem
if (!filesystem.begin()) {
Serial.println("Error mounting file system.");
return;
}
// Start WiFi (or captive portal if no credentials)
server.startWiFi(10000);
// Add a handler for the root page
server.on("/", []() {
server.send(200, "text/html", "
Hello from FSWebServer!
");
});
// Start the server
server.begin();
Serial.println("HTTP server started.");
}
void loop() {
server.run();
}
```
## WiFi Management Enhancements
### Dedicated WiFiService class
- `WiFiService` centralizes scanning, connections, captive portal setup, MDNS, and watchdog handling so the sketch can stay focused on application logic.
- When `startWiFi()` runs it loads credentials from `CredentialManager`, picks the SSID with the strongest RSSI (optionally honoring static IP data saved per credential), and reports a `WiFiStartResult` that tells `FSWebServer` whether to stay in STA or fall back to the captive portal.
- `doWifiConnection()` now persists updated credentials before calling `WiFiService::connectWithParams()`, which feeds the long-timeout watchdog, reuses stored passwords when the form leaves the password blank, and advertises `http://.local` through `startMDNSOnly()` as soon as the STA link is up. `FSWebServer` logs when mDNS becomes reachable so you can verify the hostname was published.
### Setup page reconnection experience
- The `/getStatus` handler exposes firmware version, active mode, hostname, IP, and the configuration file path so the UI knows where to direct the user after a network change.
- After `/connect` begins switching SSIDs the browser starts polling `http://.local/getStatus` (falling back to the captured AP when necessary) until the ESP reappears on the new network, automatically updates the credential list, and surfaces a timeout message only after several failed polls.
- This polling loop keeps the loader visible, shows a modal once the device is reachable again, and points users to either the new `http://.local` URL or the IP reported by the ESP without forcing them to refresh manually.
### Custom application "options manager"
### OTA update and `data` folder upload
### Custom 'code snippets'
### ACE file editor
