raspap-webgui-mirror/BACKERS.md

78 lines
5.5 KiB
Markdown
Raw Normal View History

2021-02-10 17:13:34 +00:00
## Insiders
2019-09-03 07:14:59 +00:00
2021-02-10 17:13:34 +00:00
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). Read on to learn how sponsorship works, and how easy it is to get access to Insiders.
2019-09-03 07:14:59 +00:00
2021-02-10 17:13:34 +00:00
<img width="461" alt="Untitled" src="app/img/insiders.png">
2019-09-03 07:14:59 +00:00
2021-02-10 17:13:34 +00:00
### How sponsorship works
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.
2019-09-03 07:14:59 +00:00
2021-02-10 17:13:34 +00:00
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 to learn which features are currently only available to sponsors.
2019-09-03 07:14:59 +00:00
2021-02-10 17:13:34 +00:00
### How to become a sponsor
You can [become a sponsor](https://github.com/sponsors/RaspAP) using your individual or organization's GitHub account. Just pick any tier from $10/month and complete the checkout. Then, after a few hours, you will be added as a team member to the super-secret private GitHub repository containing the Insiders edition, which has all exclusive features. In addition, you get access to Insiders-only team discussions and content.
2020-01-26 07:51:06 +00:00
2021-02-10 17:13:34 +00:00
> **Important**: If you're sponsoring [RaspAP](https://github.com/RaspAP/sponsors) 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.
2020-01-26 07:51:06 +00:00
2021-02-10 17:13:34 +00:00
### Exclusive features
2022-01-05 09:55:48 +00:00
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 Insiders' access to discussions, feature requests, issues and pull requests in the private GitHub repository.
2022-01-06 18:10:34 +00:00
✅ [Network device management](https://docs.raspap.com/net-devices/)
2022-01-10 08:53:09 +00:00
✅ [Firewall settings](https://docs.raspap.com/firewall/)
2022-01-06 18:10:34 +00:00
✅ [WPA3-Personal AP security](https://docs.raspap.com/ap-basics/#wpa3-personal)
2022-01-10 08:53:09 +00:00
✅ [802.11w Protected Management Frames](https://docs.raspap.com/ap-basics/#80211w)
✅ [Printable Wi-Fi signs](https://docs.raspap.com/ap-basics/#printable-signs)
2022-01-05 09:55:48 +00:00
⚙️ Traffic shaping (in progress)
Look for the list above to grow as we add more exclusive features. Be sure to visit this page from time to time to learn about what's new, check the [Insiders docs page](https://docs.raspap.com/insiders/) and follow [@RaspAP on Twitter](https://twitter.com/rasp_ap) to stay updated.
## Funding targets
2021-02-10 17:13:34 +00:00
Below 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.
2022-01-05 09:55:48 +00:00
### $1000
The second **Insiders Edition** includes the features listed above.
### $500
The [first Insiders Edition goal](https://docs.raspap.com/insiders/#500-1st-insiders-edition) was reached in December 2021. Thank you sponsors!
2021-02-10 17:13:34 +00:00
### Frequently asked questions
2021-04-23 13:27:41 +00:00
#### How do I install Insiders?
*How do I install Insiders?*
Invoke the [Quick Installer](https://docs.raspap.com/quick/) with the `--insiders` switch, like so:
```
curl -sL https://install.raspap.com | bash -s -- --insiders
```
This will automatically pull from the private Insiders repo during the installation process.
2021-02-10 17:13:34 +00:00
#### Upgrading
*I have an existing RaspAP installation. How do I upgrade to Insiders?*
2021-04-23 13:27:41 +00:00
Upgrading is easy. Invoke the [Quick Installer](https://docs.raspap.com/quick/) with the `--upgrade` switch, specifying the private Insiders edition, like so:
2021-02-10 17:13:34 +00:00
```
2021-04-23 13:27:41 +00:00
curl -sL https://install.raspap.com | bash -s -- --upgrade --insiders
2021-02-10 17:13:34 +00:00
```
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:
```
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.
#### Terms
*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. However, we kindly ask you to respect the following guidelines:
* 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.
* 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).