WiFiManager gives ESP8266 and ESP32 firmware a polished, self-hosted Wi-Fi setup experience. It reconnects to saved networks and opens a temporary captive portal when it cannot, so users can configure the device from any phone or browser without a cloud service or companion app.

See it on real hardware

Brand the built-in portal	Combine Wi-Fi and application setup

Give each product its own title, identity, icon, and color theme without copying portal HTML.	Show live nearby networks and collect application values, such as an MQTT broker, in the same setup flow.

These are unmodified browser captures of Branded Portal and Custom Portal Content running on the supported boards. The portal is served by the device itself; no cloud UI or companion app is involved.

Start with a working portal

#include <Arduino.h>
#include <WiFiManager.h>

WiFiManager wifi;

void setup() {
    Serial.begin(115200);
    wifi.setConfigPortalTimeout(180);
    wifi.autoConnect("Device Setup", "change-me");
}

void loop() {
    wifi.process();
}

When saved Wi-Fi is unavailable, autoConnect() starts the portal asynchronously. Call process() from every loop() iteration while it may be open. Flash Basic Portal to try this exact flow; its README gives the network name, password, portal address, and expected result after saving Wi-Fi.

Make it yours

const char kTitle[] PROGMEM = "Set up Temperature Monitor";
const char kBrand[] PROGMEM = "Example Devices";
const char kAccent[] PROGMEM = "#347a45";

const WiFiManagerPortalConfig kPortalUI = {
    WiFiManagerPortalText::progmem(kTitle),
    WiFiManagerPortalText::progmem(kBrand),
    {}, {}, {},
    {
        {}, {}, {}, {}, {},
        WiFiManagerPortalText::progmem(kAccent),
        {}, {}, {}, {}, {},
        10, 0,
    },
};

void setup() {
    wifi.setPortalConfig(kPortalUI);  // before the portal starts
    wifi.autoConnect("Device Setup");
}

void loop() {
    wifi.process();
}

The Branded Portal example includes a static SVG, accessible identity text, and a small semantic theme. Custom Portal Content shows the supported parameters, information sections, and home cards without replacing the portal shell.

What it provides

Captive Wi-Fi setup: starts an access point only when saved network credentials cannot connect.
Responsive portal: one small portal for Wi-Fi, application fields, information, actions, and firmware update flow.
Structured APIs: JSON endpoints under /api/... for applications that need portal state or connection results.
Product presentation: title, logo, tagline, and semantic colour tokens without copying the portal HTML.
Primary and fallback networks: an opt-in two-network controller backed by an application-provided store.
ESP8266 and ESP32 support: the package resolves its asynchronous web dependencies for the selected target.

Choose a guide

Goal	Guide
Brand the portal or add structured built-in content	Portal UI
Configure primary/fallback station profiles	Station profiles
Understand the JSON APIs and station-connect handoff	Portal API
Build or flash a complete example	Examples
Contribute to this fork or prepare a release	Development

Install

[common]
lib_deps =
    WiFiManager=https://github.com/alexhopeoconnor/WiFiManager.git#v3.2.0

The suffix after # is a Git ref. PlatformIO clones the repository and checks out that release tag; GitHub Release assets are unrelated. Arduino IDE users can install this repository as a library checkout.

See the documentation index, examples, release history, and licence.