RaspAP is feature-rich wireless router software that just works on many popular Debian-based devices, including the Raspberry Pi. Our custom OS images, Quick installer and Docker container create a known-good default configuration for all current Raspberry Pis with onboard wireless. A fully responsive, mobile-ready interface gives you control over the relevant services and networking options. Advanced DHCP settings, WireGuard, Tailscale and OpenVPN support, SSL certificates, ad blocking, security audits, captive portal integration, themes and multilingual options are included.

RaspAP has been featured by PC World, MSN, Adafruit, Raspberry Pi Weekly, and Awesome Raspberry Pi and implemented in countless projects.

We hope you enjoy using RaspAP as much as we do creating it. Tell us how you use this with your own projects.

• Quick start
• Join Insiders
• WireGuard support
• OpenVPN support
• VPN Provider support
• Ad Blocking
• Bridged AP
• Manual installation
• 802.11ac 5GHz support
• Supported operating systems
• HTTPS support
• Docker support
• Custom user plugins
• Multilingual support
• How to contribute
• Reporting issues
• License

RaspAP gives you two different ways to get up and running quickly. The simplest and recommended approach is to use a custom Raspberry Pi OS image with RaspAP preinstalled. This option eliminates guesswork and gives you a base upon which to build. Alternatively, you may execute the Quick installer on an existing compatible OS.

Custom Raspberry Pi OS Lite images with the latest RaspAP are available for direct download. This includes both 32- and 64-bit builds for ARM architectures.

These images are automatically generated with each release of RaspAP. You may choose between an arm64 or armhf (32-bit) based build. Refer to this resource to ensure compatibility with your hardware.

After downloading your desired image from the latest release page, use a utility such as the Raspberry Pi Imager or balenaEtcher to flash the OS image onto a microSD card. Insert the card into your device and boot it up. The latest RaspAP release version with the most popular optional components will be active and ready for you to configure.

Alternatively, start with a clean install of a latest release of Raspberry Pi OS. Both the 32- and 64-bit release versions are supported, as well as the latest 64-bit Desktop distribution.

Update RPi OS to its latest version, including the kernel and firmware, followed by a reboot:

sudo apt-get update
sudo apt-get full-upgrade
sudo reboot

Set the WiFi country in raspi-config's Localisation Options: sudo raspi-config.

Install RaspAP from your device's shell prompt:

curl -sL https://install.raspap.com | bash

The Quick installer will respond to several command line arguments, or switches, to customize your installation in a variety of ways, or install one of RaspAP's optional helper tools.

After completing either of these setup options, the wireless AP network will be configured as follows:

• IP address: 10.3.141.1
  • Username: admin
  • Password: secret
• DHCP range: 10.3.141.50 — 10.3.141.254
• SSID: RaspAP
• Password: ChangeMe

It's strongly recommended that your first post-install action is to change the default admin authentication settings. Thereafter, your AP's basic settings and many advanced options are now ready to be modified by RaspAP.

Please read this before reporting an issue.

RaspAP is free software, but powered by your support. If you find RaspAP useful for your personal or commercial projects, become an Insider and get early access to exclusive features in the Insiders Edition.

A tangible side benefit of sponsorship is that Insiders are able to help steer future development of RaspAP. This is done through Insiders' team access to discussions, feature requests, issues and more in the private GitHub repository.

WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be considerably more performant than OpenVPN, and is generally regarded as the most secure, easiest to use, and simplest VPN solution for modern Linux distributions.

WireGuard is included in the pre-built OS and may be optionally installed by the Quick Installer. Once this is done, you can manage local (server) settings, create a peer configuration and control the wg-quick service with RaspAP.

Details are provided here.

OpenVPN is included in the pre-built OS and may be optionally installed by the Quick Installer. Once this is done, you can manage client configurations 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.

See our OpenVPN documentation for more information.

Several popular VPN providers include a Linux Command Line Interface (CLI) for interacting with their services. As a new beta feature, you may optionally control these VPN services from within RaspAP. After your provider's CLI is installed on your system you may administer it thereafter by using RaspAP's UI.

See our VPN provider documentation for more information.

This feature uses DNS blacklisting to block requests for ads, trackers and other undesirable hosts. Ad blocking is included in the pre-built OS and may be optionally installed by the Quick Installer. Thereafter, you may choose between several of the best available blocklist sources to suit your needs.

Details are provided here.

By default RaspAP configures a routed AP for your clients to connect to. A bridged AP configuration is also possible. Select the Bridged AP mode toggle under the Advanced tab of Hotspot, configure a static IP address for the bridge interface, then save and restart the AP.

Details on Bridged AP mode are provided here.

Detailed manual setup instructions are provided here.

RaspAP provides an 802.11ac wireless mode option for supported hardware (currently the RPi 3B+, 4, 5 and compatible Orange Pi models) and wireless regulatory domains. See this for more information.

RaspAP was originally made for Raspbian, but now also installs on the following Debian-based distros.

You are also encouraged to use RaspAP's community-led Docker container. Please note that "supported" is not a guarantee. If you are able to improve support for your preferred distro, we encourage you to actively contribute to the project.

The Quick Installer may be used to generate SSL certificates with mkcert. The installer automates the manual steps described here, including configuring lighttpd with SSL support.

Simply append the -c or --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 in our documentation.

As an alternative to the Quick installer, RaspAP may be run in an isolated, portable Docker container.

See the RaspAP-docker repo for more information.

RaspAP's integrated PluginManager provides a framework for developers to create custom plugins. To facilitate this, a SamplePlugin repository is available to get developers started on the right track. If you'd like to develop your own plugin for RaspAP, see the documentation or get started right away by forking the SamplePlugin.

RaspAP uses GNU Gettext to manage multilingual messages. Our pre-built OS includes the locales-all package, eliminating the need to manually generate locales.

If you're using the Quick Installer or Manual setup methods, you must configure a corresponding language package for your system. 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 here.

See this list of supported languages that are actively maintained by volunteer translators. If your language is not supported, why not contribute a translation? Contributors will receive credit as the original translators.

1. Fork the project in your account and create a new branch: your-great-feature.
2. Open an issue in the repository describing the feature contribution you'd like to make.
3. Commit changes in your feature branch.
4. Open a pull request and reference the initial issue in the pull request message.

Find out more about our coding style guidelines and recommended tools.

Please read this before reporting a bug.

This project exists thanks to all the awesome people who contribute their time and expertise.

Development of RaspAP is made possible thanks to a sponsorware release model. This means that new features are first exclusively released to sponsors as part of Insiders.

Learn more about how sponsorship works, and how easy it is to get access to Insiders.

See the LICENSE file.