How-to Guides¶

How-to guides are recipes. They take the reader through the steps required to solve a specific problem. They are goal-oriented.

Identity Providers¶

Installation - How to install the package and its dependencies.
Configure in LuCI - How to configure the OIDC settings and roles from the LuCI web interface.
Installing a Private CA Certificate - How to make the router trust a self-signed or private CA certificate.
Upgrading - How to upgrade to a new version without disrupting active sessions.
Rotating Credentials - How to update the client secret or switch identity providers.
Role-Based Access Control - How to define who can access the router and what they can do.
Split-Horizon Networking - How to configure luci-sso when your router and browser reach the IdP via different addresses.
Debugging & Logs - How to troubleshoot authentication failures.
Backing Up and Restoring Configuration - How to preserve your configuration across a reflash or factory reset.
Removing luci-sso - How to completely uninstall the package and restore password login.

Adding a New Crypto Backend - How to implement a new native C provider (e.g., for BoringSSL).
Running Tests - How to execute the different test tiers.
Fuzz Testing - How to run the coverage-guided fuzzer.
Writing Documentation - How to use the documentation toolkit and standards.