mirror of
https://github.com/billz/raspap-webgui.git
synced 2023-10-10 13:37:24 +02:00
Update release version - First Insiders Edition
This commit is contained in:
billz
parent
c2665ae528
commit
0c5ecb549d
228
README.md
228
README.md
@ -1,87 +1,177 @@
|
|||||||
|
|
||||||
[](https://github.com/raspap/raspap-insiders/releases) [](https://github.com/thibmaek/awesome-raspberry-pi) [](https://github.com/sponsors/RaspAP)  [](https://crowdin.com/project/raspap) [](https://twitter.com/rasp_ap) [](https://www.reddit.com/r/RaspAP/)
|
[](https://github.com/raspap/raspap-webgui/releases) [](https://github.com/thibmaek/awesome-raspberry-pi) [](https://github.com/sponsors/RaspAP)  [](https://crowdin.com/project/raspap) [](https://twitter.com/rasp_ap) [](https://www.reddit.com/r/RaspAP/)
|
||||||
|
|
||||||
Welcome to **RaspAP Insiders**. You, the members of the Insiders community, support the sponsorware release model, which means that new features are first exclusively released to sponsors as part of Insiders. Read on for details about how this strategy works—and *thank you* for joining us on this journey.
|
RaspAP is feature-rich wireless router software that _just works_ on many popular [Debian-based devices](#supported-operating-systems), including the Raspberry Pi. Our popular [Quick installer](#quick-installer) creates 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 and OpenVPN support, [SSL certificates](https://docs.raspap.com/ssl-quick/), security audits, [captive portal integration](https://docs.raspap.com/captive/), themes and [multilingual options](https://docs.raspap.com/translations/) are included.
|
||||||
|
|
||||||
|
RaspAP has been featured on sites such as [Instructables](http://www.instructables.com/id/Raspberry-Pi-As-Completely-Wireless-Router/), [Adafruit](https://blog.adafruit.com/2016/06/24/raspap-wifi-configuration-portal-piday-raspberrypi-raspberry_pi/), [Raspberry Pi Weekly](https://www.raspberrypi.org/weekly/commander/) and [Awesome Raspberry Pi](https://project-awesome.org/thibmaek/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](https://github.com/raspap/raspap-awesome).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
- [How sponsorship works](#how-sponsorship-works)
|
- [Prerequisites](#prerequisites)
|
||||||
- [About your sponsorship](#about-your-sponsorship)
|
- [Quick installer](#quick-installer)
|
||||||
- [Exclusive features](#exclusive-features)
|
- [Join Insiders](#join-insiders)
|
||||||
- [Funding targets](#funding-targets)
|
- [WireGuard support](#wireguard-support)
|
||||||
- [Frequently asked questions](#frequently-asked-questions)
|
- [OpenVPN support](#openvpn-support)
|
||||||
|
- [Ad Blocking](#ad-blocking)
|
||||||
|
- [Bridged AP](#bridged-ap)
|
||||||
|
- [Simultaneous AP and Wifi client](#simultaneous-ap-and-wifi-client)
|
||||||
|
- [Manual installation](#manual-installation)
|
||||||
|
- [802.11ac 5GHz support](#80211ac-5ghz-support)
|
||||||
|
- [Supported operating systems](#supported-operating-systems)
|
||||||
|
- [Multilingual support](#multilingual-support)
|
||||||
|
- [HTTPS support](#https-support)
|
||||||
|
- [How to contribute](#how-to-contribute)
|
||||||
|
- [Reporting issues](#reporting-issues)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
## How sponsorship works
|
## Prerequisites
|
||||||
New features first land in Insiders, which means that *sponsors will have access to them immediately*. Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into the [public RaspAP repository](https://github.com/RaspAP/raspap-webgui) and released for general availability. Bugfixes and minor enhancements are always released simultaneously in both editions.
|
Start with a clean install of the [latest release of Raspberry Pi OS (32-bit) Lite](https://www.raspberrypi.org/software/operating-systems/#raspberry-pi-os-32-bit). The Raspberry Pi OS desktop and 64-bit beta distros are unsupported.
|
||||||
|
|
||||||
Don't want to sponsor? No problem, RaspAP already has tons of features available, so chances are that most of your requirements are already satisfied. See the list of [exclusive features](#exclusive-features) to learn which features are currently only available to sponsors.
|
|
||||||
|
|
||||||
## About your sponsorship
|
|
||||||
Your sponsorship is through your individual or organization's GitHub account. By visiting [**RaspAP's sponsor profile**](https://github.com/sponsors/RaspAP), you may change your sponsorship tier or cancel your sponsorship anytime. <sup>[1](#footnote-1)</sup>
|
|
||||||
|
|
||||||
As part of the initial rollout of Insiders, all previous one-time backers of RaspAP on GitHub, PayPal or [Open Collective](https://opencollective.com/raspap) will receive unlimited access to Insiders. This is a small gesture for those early financial supporters who recognized the potential of this project.
|
|
||||||
|
|
||||||
|
|
||||||
> ℹ️ **Important**: If you're [sponsoring](https://github.com/sponsors/RaspAP) RaspAP through a GitHub organization, please send a short email to [sponsors@raspap.com](mailto:sponsors@raspap.com) with the name of your organization and the account that should be added as a collaborator. <sup>[2](#footnote-2)</sup>
|
|
||||||
|
|
||||||
## Exclusive features
|
|
||||||
The following features are currently available exclusively to sponsors. A tangible side benefit of sponsorship is that Insiders are able to help steer future development of RaspAP. This is done through your Insiders access to discussions, feature requests, issues and pull requests in the private GitHub repository.
|
|
||||||
|
|
||||||
✅ [Manage OpenVPN client configs](https://docs.raspap.com/openvpn/#multiple-client-configs)
|
|
||||||
✅ [OpenVPN certificate authentication](https://docs.raspap.com/openvpn/#certificate-authentication)
|
|
||||||
✅ OpenVPN service logging
|
|
||||||
✅ Night mode toggle
|
|
||||||
✅ Restrict network to static clients
|
|
||||||
✅ [WireGuard support](https://docs.raspap.com/wireguard/)
|
|
||||||
✅ [Set AP transmit power](https://docs.raspap.com/ap-basics/#transmit-power)
|
|
||||||
✅ Mobile data client support
|
|
||||||
✅ Firewall settings
|
|
||||||
⚙️ Traffic shaping (in progress)
|
|
||||||
⚙️ Printable WiFi signs (in progress)
|
|
||||||
|
|
||||||
Look for the list above to grow as we add more exlcusive features. Have an idea or suggestion for a future enhancement? Start or join an [Insiders discussion](https://github.com/RaspAP/raspap-insiders/discussions) and let us know!
|
|
||||||
|
|
||||||
## Funding targets
|
|
||||||
Following is a list of funding targets. When a funding target is reached, the features that are tied to it are merged back into RaspAP and released to the public for general availability.
|
|
||||||
|
|
||||||
### $500
|
|
||||||
The first **Insiders Edition** includes the exclusive features listed above.
|
|
||||||
|
|
||||||
## Frequently asked questions
|
|
||||||
|
|
||||||
### Upgrading
|
|
||||||
*I have an existing RaspAP installation. How do I upgrade to Insiders?*
|
|
||||||
|
|
||||||
Upgrading is easy. Simply invoke the Quick Installer with the --upgrade switch, specifying the private Insiders Edition, like so:
|
|
||||||
|
|
||||||
|
1. Update Raspbian, including the kernel and firmware, followed by a reboot:
|
||||||
```
|
```
|
||||||
curl -sL https://install.raspap.com | bash -s -- --upgrade --insiders
|
sudo apt-get update
|
||||||
|
sudo apt-get full-upgrade
|
||||||
|
sudo reboot
|
||||||
|
```
|
||||||
|
2. Set the "WLAN country" option in `raspi-config`'s **Localisation Options**: `sudo raspi-config`
|
||||||
|
|
||||||
|
3. If you have a device without an onboard wireless chipset, the [**Edimax Wireless 802.11b/g/n nano USB adapter**](https://www.edimax.com/edimax/merchandise/merchandise_detail/data/edimax/global/wireless_adapters_n150/ew-7811un) 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.
|
||||||
|
|
||||||
|
## Quick installer
|
||||||
|
Install RaspAP from your device's shell prompt:
|
||||||
|
```sh
|
||||||
|
curl -sL https://install.raspap.com | bash
|
||||||
|
```
|
||||||
|
The [installer](https://docs.raspap.com/quick/) 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 — 10.3.141.255
|
||||||
|
* SSID: `raspi-webgui`
|
||||||
|
* 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](https://docs.raspap.com/faq/#headless). Special instructions for the Pi Zero W are [available here](https://docs.raspap.com/ap-sta/).
|
||||||
|
|
||||||
|
Please [read this](https://docs.raspap.com/issues/) before reporting an issue.
|
||||||
|
|
||||||
|
## Join Insiders
|
||||||
|
[](https://github.com/sponsors/RaspAP/)
|
||||||
|
|
||||||
|
RaspAP is free software, but powered by _your_ support. If you find RaspAP useful for your personal or commercial projects, [become an Insider](https://github.com/sponsors/RaspAP/) and get early access to [exclusive features](https://docs.raspap.com/insiders/#exclusive-features) in the [Insiders Edition](https://docs.raspap.com/insiders/).
|
||||||
|
|
||||||
|
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 support
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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 may be optionally installed by the [Quick Installer](https://docs.raspap.com/quick/). 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](https://docs.raspap.com/wireguard/).
|
||||||
|
|
||||||
|
## OpenVPN support
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
OpenVPN may be optionally installed by the Quick Installer. Once this is done, you can [manage client configurations](https://docs.raspap.com/openvpn/) 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](https://docs.raspap.com/openvpn/) for more information.
|
||||||
|
|
||||||
|
|
||||||
|
## Ad Blocking
|
||||||
|
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](https://docs.raspap.com/adblock/).
|
||||||
|
|
||||||
|
## Bridged AP
|
||||||
|
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](https://www.raspberrypi.org/documentation/remote-access/ip-address.md).
|
||||||
|
|
||||||
|
More information on Bridged AP mode is provided [in our documentation](https://docs.raspap.com/bridged/).
|
||||||
|
|
||||||
|
## Simultaneous AP and Wifi client
|
||||||
|
RaspAP lets you create an AP with a Wifi client configuration, often called [AP-STA mode](https://docs.raspap.com/ap-sta/). 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](https://docs.raspap.com/faq/#headless) without an `eth0` connection, this configuration must be enabled [_before_ a reboot](https://docs.raspap.com/ap-sta/).
|
||||||
|
|
||||||
|
## Manual installation
|
||||||
|
Detailed manual setup instructions are provided [on our documentation site](https://docs.raspap.com/manual/).
|
||||||
|
|
||||||
|
## 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](https://docs.raspap.com/faq/#80211ac) for more information.
|
||||||
|
|
||||||
|
## Supported operating systems
|
||||||
|
RaspAP was originally made for Raspbian, but now also installs on the following Debian-based distros.
|
||||||
|
|
||||||
|
| Distribution | Release | Architecture | Support |
|
||||||
|
|---|:---:|:---:|:---:|
|
||||||
|
| Raspberry Pi OS | (32-bit) Lite Bullseye | ARM | Official |
|
||||||
|
| Armbian | Bullseye | [ARM](https://docs.armbian.com/#supported-socs) | Official |
|
||||||
|
| Debian | Bullseye | 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](#how-to-contribute) to the project.
|
||||||
|
|
||||||
|
## Multilingual support
|
||||||
|
RaspAP uses [GNU Gettext](https://www.gnu.org/software/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 [documentation site](https://docs.raspap.com/translations/).
|
||||||
|
|
||||||
|
See this list of [supported languages](https://docs.raspap.com/translations/#supported-languages) that are actively maintained by volunteer translators. If your language is not supported, why not [contribute a translation](https://docs.raspap.com/translations/#contributing-to-a-translation)? Contributors will receive credit as the original translators.
|
||||||
|
|
||||||
|
## HTTPS support
|
||||||
|
The Quick Installer may be used to [generate SSL certificates](https://docs.raspap.com/ssl-quick/) with `mkcert`. The installer automates the manual steps [described here](https://docs.raspap.com/ssl-manual/), including configuring lighttpd with SSL support.
|
||||||
|
|
||||||
|
Simply append the `-c` or `--cert` option to the Quick Installer, like so:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -sL https://install.raspap.com | bash -s -- --cert
|
||||||
```
|
```
|
||||||
|
|
||||||
If you haven't [added SSH keys to your GitHub account](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) you will be prompted to authenticate. If so, just enter your GitHub credentials during the install:
|
**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](https://docs.raspap.com/ssl-quick/).
|
||||||
RaspAP Install: Cloning latest files from github
|
|
||||||
Cloning into '/tmp/raspap-webgui'...
|
|
||||||
Username for 'https://github.com': octocat
|
|
||||||
Password for 'https://octocat@github.com':
|
|
||||||
```
|
|
||||||
|
|
||||||
> ℹ️ Note: your password is sent securely via SSH to GitHub. The above prompt is actually from GitHub, so the installer does not know your credentials.
|
## How to contribute
|
||||||
|
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.
|
||||||
|
|
||||||
### Terms
|
Find out more about our [coding style guidelines and recommended tools](CONTRIBUTING.md).
|
||||||
*We're using RaspAP for a commercial project. Can we use Insiders under the same terms and conditions?*
|
|
||||||
|
|
||||||
Yes. Whether you're an individual or a company, you may use RaspAP Insiders precisely under the same terms as RaspAP, which are defined by the [GNU GPL-3.0 license](https://github.com/RaspAP/raspap-insiders/blob/master/LICENSE). However, we kindly ask you to respect the following guidelines:
|
## Reporting issues
|
||||||
|
Please [read this](https://docs.raspap.com/issues/) before reporting a bug.
|
||||||
|
|
||||||
* Please **don't distribute the source code** of Insiders. You may freely use it for public, private or commercial projects, fork it, mirror it, do whatever you want with it, but please don't release the source code, as it would counteract the sponsorware strategy.
|
## Contributors
|
||||||
* If you cancel your subscription, you're removed as a collaborator and will miss out on future updates of Insiders. However, you may *use the latest version* that's available to you as long as you like. Just remember that [GitHub deletes private forks](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository).
|
|
||||||
|
### Code Contributors
|
||||||
|
This project exists thanks to all the awesome people who [contribute](CONTRIBUTING.md) their time and expertise.
|
||||||
|
|
||||||
|
<a href="https://github.com/raspap/raspap-webgui/graphs/contributors"><img src="https://opencollective.com/raspap/contributors.svg?width=890&button=false" /></a>
|
||||||
|
|
||||||
|
### Financial Contributors
|
||||||
|
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**](https://github.com/sponsors/RaspAP).
|
||||||
|
|
||||||
|
Learn more about [how sponsorship works](https://docs.raspap.com/insiders/#how-sponsorship-works), and how easy it is to get access to Insiders.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
See the [LICENSE](./LICENSE) file.
|
See the [LICENSE](./LICENSE) file.
|
||||||
|
|
||||||
### Footnotes
|
|
||||||
|
|
||||||
<sub><a name="footnote-1"></a>1. If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle, which ends at the 22nd of a month for monthly sponsorships. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable.</sub>
|
|
||||||
|
|
||||||
<sub><a name="footnote-2"></a>2. It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to sponsors@raspap.com, stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler.</sub>
|
|
||||||
|
|||||||
@ -6,7 +6,7 @@ if (!defined('RASPI_CONFIG')) {
|
|||||||
|
|
||||||
$defaults = [
|
$defaults = [
|
||||||
'RASPI_BRAND_TEXT' => 'RaspAP',
|
'RASPI_BRAND_TEXT' => 'RaspAP',
|
||||||
'RASPI_VERSION' => '2.7.1',
|
'RASPI_VERSION' => '2.8.0',
|
||||||
'RASPI_CONFIG_NETWORK' => RASPI_CONFIG.'/networking/defaults.json',
|
'RASPI_CONFIG_NETWORK' => RASPI_CONFIG.'/networking/defaults.json',
|
||||||
'RASPI_ADMIN_DETAILS' => RASPI_CONFIG.'/raspap.auth',
|
'RASPI_ADMIN_DETAILS' => RASPI_CONFIG.'/raspap.auth',
|
||||||
'RASPI_WIFI_AP_INTERFACE' => 'wlan0',
|
'RASPI_WIFI_AP_INTERFACE' => 'wlan0',
|
||||||
|
|||||||
@ -7,15 +7,15 @@
|
|||||||
* Enables use of simple web interface rather than SSH to control WiFi and related services on the Raspberry Pi.
|
* Enables use of simple web interface rather than SSH to control WiFi and related services on the Raspberry Pi.
|
||||||
* Recommended distribution is Raspberry Pi OS (32-bit) Lite. Specific instructions to install the supported software are
|
* Recommended distribution is Raspberry Pi OS (32-bit) Lite. Specific instructions to install the supported software are
|
||||||
* in the README and original post by @SirLagz. For a quick run through, the packages required for the WebGUI are:
|
* in the README and original post by @SirLagz. For a quick run through, the packages required for the WebGUI are:
|
||||||
* lighttpd (version 1.4.53 installed via apt)
|
* lighttpd (version 1.4.59 installed via apt)
|
||||||
* php-cgi (version 7.3.19-1 installed via apt)
|
* php-cgi (version 7.4.25 installed via apt)
|
||||||
* along with their supporting packages, php7.3 will also need to be enabled.
|
* along with their supporting packages, php7.3 will also need to be enabled.
|
||||||
*
|
*
|
||||||
* @author Lawrence Yau <sirlagz@gmail.com>
|
* @author Lawrence Yau <sirlagz@gmail.com>
|
||||||
* @author Bill Zimmerman <billzimmerman@gmail.com>
|
* @author Bill Zimmerman <billzimmerman@gmail.com>
|
||||||
* @license GNU General Public License, version 3 (GPL-3.0)
|
* @license GNU General Public License, version 3 (GPL-3.0)
|
||||||
* @version 2.7.1
|
* @version 2.8.0
|
||||||
* @link https://github.com/raspap/raspap-webgui/
|
* @link https://github.com/RaspAP/raspap-webgui/
|
||||||
* @link https://raspap.com/
|
* @link https://raspap.com/
|
||||||
* @see http://sirlagz.net/2013/02/08/raspap-webgui/
|
* @see http://sirlagz.net/2013/02/08/raspap-webgui/
|
||||||
*
|
*
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user