||3 years ago|
|.github||4 years ago|
|_layouts||4 years ago|
|ajax||4 years ago|
|app||4 years ago|
|config||3 years ago|
|dist||4 years ago|
|includes||3 years ago|
|installers||3 years ago|
|locale||3 years ago|
|templates||4 years ago|
|.gitignore||4 years ago|
|.travis.yml||4 years ago|
|BACKERS.md||4 years ago|
|CNAME||6 years ago|
|CONTRIBUTING.md||4 years ago|
|LICENSE||9 years ago|
|README.md||3 years ago|
|_config.yml||6 years ago|
|crowdin.yml||4 years ago|
|favicon.ico||4 years ago|
|gulpfile.js||4 years ago|
|index.php||4 years ago|
|package.json||4 years ago|
|raspap.php||5 years ago|
|yarn.lock||4 years ago|
RaspAP lets you quickly get a WiFi access point up and running to share the connectivity of many popular Debian-based devices, including the Raspberry Pi. Our popular Quick installer creates a known-good default configuration that "just works" on all current Raspberry Pis with onboard wireless. A responsive interface gives you control over the relevant services and networking options. Advanced DHCP settings, OpenVPN client support, SSL, security audits, themes and multilingual options are included.
We hope you enjoy using RaspAP as much as we do creating it. Tell us how you use this with your own projects.
- Quick installer
- Ad Blocking
- Bridged AP
- Simultaneous AP and Wifi client
- Support us
- Manual installation
- 802.11ac 5GHz support
- Supported operating systems
- Multilingual support
- HTTPS support
- OpenVPN support
- How to contribute
- Reporting issues
Start with a clean install of the latest release of Raspbian (currently Buster). Raspbian Buster Lite is recommended.
- Update Raspbian, including the kernel and firmware, followed by a reboot:
sudo apt-get update sudo apt-get dist-upgrade sudo reboot
Set the WiFi country in raspi-config's Localisation Options:
If you have a device without an onboard WiFi chipset, the Edimax Wireless 802.11b/g/n nano USB adapter is an excellent option – it's small, cheap and has good driver support.
With the prerequisites done, you can proceed with either the Quick installer or Manual installation steps below.
Install RaspAP from your device'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:
- IP address: 10.3.141.1
- Username: admin
- Password: secret
- DHCP range: 10.3.141.50 to 10.3.141.255
- Password: ChangeMe
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 system. Best results are obtained by connecting 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.
This feature uses DNS blacklisting to block requests for ads, trackers and other undesirable hosts. To enable ad blocking, simply respond to the prompt during the installation. As a beta release, we encourage testing and feedback from users of RaspAP.
Details are provided here.
By default RaspAP configures a routed AP for your clients to connect to. A bridged AP configuration is also possible. Slide the Bridged AP mode toggle under the Advanced tab of Configure hotspot, then save and restart the hotspot.
Note: In bridged mode, all routing capabilities are handled by your upstream router. Because your router assigns IP addresses to your device's hotspot and its clients, you might not be able to reach the RaspAP web interface from the default
10.3.141.1 address. Instead use your RPi's hostname followed by
.local to access the RaspAP web interface. With Raspbian default settings, this should look like
raspberrypi.local. Alternate methods are discussed here.
More information on Bridged AP mode is provided on our wiki.
Simultaneous AP and Wifi client
RaspAP lets you easily create an AP with a Wifi client configuration. With your system 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 system as a wireless client. For a device 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 GitHub sponsor, join the project on Open Collective or make a one-time donation with PayPal. Any of these options makes a big difference!
Detailed manual setup instructions are provided on our wiki.
802.11ac 5GHz support
RaspAP provides an 802.11ac wireless mode option for supported hardware (currently the RPi 3B+/4 and compatible Orange Pi models) and wireless regulatory domains. See this FAQ for more information.
Supported operating systems
RaspAP was originally made for Raspbian, but now also installs on the following Debian-based distros.
|Debian||Buster||ARM / x86_64||Beta|
|Ubuntu||18.04 LTS / 19.10||ARM / x86_64||Beta|
We find Armbian particularly well-suited for this project. 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.
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:
- 正體中文 (Chinese traditional)
- 简体中文 (Chinese Simplified)
- ελληνικό (Greek)
- 日本語 (Japanese)
- 한국어 (Korean)
- Tiếng Việt (Vietnamese)
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 manage 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.
How to contribute
- Fork the project in your account and create a new branch:
- Open an issue in the repository describing the feature contribution you'd like to make.
- Commit changes in your feature branch.
- 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.
Become a financial contributor and help us sustain our community.
Support this project with your organization. Your logo will show up here with a link to your website.
See the LICENSE file.