A simple, responsive web interface to control wifi, hostapd and related services on the Raspberry Pi.
This project was inspired by a blog post by SirLagz about using a web page rather than ssh to configure wifi and hostapd settings on the Raspberry Pi. I began by prettifying the UI by wrapping it in SB Admin 2, a Bootstrap based admin theme. Since then, the project has evolved to include greater control over many aspects of a networked RPi, better security, authentication, a Quick Installer, support for OpenVPN, themes and more. RaspAP has been featured on sites such as Instructables, Adafruit, Raspberry Pi Weekly and Awesome Raspberry Pi and implemented in countless projects.
We’d be curious to hear about how you use this with your own RPi-powered projects. Until then, here are some screenshots:
Start with a clean install of the latest release of Raspbian (currently Buster). Raspbian Buster Lite is recommended.
sudo apt-get update sudo apt-get dist-upgrade sudo reboot
Set the WiFi country in raspi-config’s Localisation Options:
With the prerequisites done, you can proceed with either the Quick installer or Manual installation steps below.
Install RaspAP from your RaspberryPi’s shell prompt:
curl -sL https://install.raspap.com | bash
The installer will complete the steps in the manual installation (below) for you.
After the reboot at the end of the installation the wireless network will be configured as an access point as follows:
Note: As the name suggests, the Quick Installer is a great way to quickly setup a new AP. However, it does not automagically detect the unique configuration of your RPi. Best results are obtained by connecting an RPi to ethernet (
eth0) or as a WiFi client, also known as managed mode, with
wlan0. For the latter, refer to this FAQ. Please read this before reporting an issue.
RaspAP lets you easily create an AP with a Wifi client configuration. With your RPi configured in managed mode, enable the AP from the Advanced tab of Configure hotspot by sliding the Wifi client AP mode toggle. Save settings and start the hotspot. The managed mode AP is functional without restart.
Note: This option is disabled until you configure your RPi as a wireless client. For a Raspberry Pi operating in managed mode without an
eth0 connection, this configuration must be enabled before a reboot.
RaspAP is free software, but powered by your support. If you find RaspAP useful for your personal or commercial projects, please become a sponsor or make a one-time donation with Beerpay. Either option makes a big difference!
Detailed manual setup instructions are provided on our wiki.
RaspAP provides an 802.11ac wireless mode option for supported hardware (currently the RPi 3B+/4) and wireless regulatory domains. See this FAQ for more information.
RaspAP uses GNU Gettext to manage multilingual messages. In order to use RaspAP with one of our supported translations, you must configure a corresponding language package on your RPi. To list languages currently installed on your system, use
locale -a at the shell prompt. To generate new locales, run
sudo dpkg-reconfigure locales and select any other desired locales. Details are provided on our wiki.
The following translations are currently maintained by the project:
If your language is not in the list above, why not contribute a translation? Contributors will receive credit as the original translators.
Simply append the
--cert option to the Quick Installer, like so:
curl -sL https://install.raspap.com | bash -s -- --cert
Note: this only installs mkcert and generates an SSL certificate with the input you provide. It does not (re)install RaspAP.
More information on SSL certificates and HTTPS support is available on our wiki.
OpenVPN may be optionally installed by the Quick Installer. Once this is done, you can managage a client configuration and the
openvpn-client service with RaspAP.
To configure an OpenVPN client, upload a valid .ovpn file and, optionally, specify your login credentials. RaspAP will store your client configuration and add firewall rules to forward traffic from OpenVPN’s
tun0 interface to your configured wireless interface.
Note: this feature is currently in beta. Please read this before reporting an issue.
This project follows the PSR-2 coding style guidelines. There are many ways to check your code for PSR-2. An excellent tool is PHP_CodeSniffer. The command line tool
phpcs can be run against any single file. Phing, a PHP build tool, integrates nicely with
phpcs to automate PSR-2 checks across all source files in a project.
Please read this before reporting a bug.
See the LICENSE file.