frodovdr/raspap-webgui
1
0
Fork 0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bill Zimmerman 2021-03-11 11:32:48 +01:00 committed by GitHub
parent b6e308351f
commit 18bcc3032a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -17,6 +17,7 @@ We hope you enjoy using RaspAP as much as we do creating it. Tell us how you use
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Quick installer](#quick-installer) - [Quick installer](#quick-installer)
- [WireGuard support](#wireguard-support) - [WireGuard support](#wireguard-support)
- [OpenVPN support](#openvpn-support)
- [Ad Blocking](#ad-blocking) - [Ad Blocking](#ad-blocking)
- [Bridged AP](#bridged-ap) - [Bridged AP](#bridged-ap)
- [Simultaneous AP and Wifi client](#simultaneous-ap-and-wifi-client) - [Simultaneous AP and Wifi client](#simultaneous-ap-and-wifi-client)
@ -26,7 +27,6 @@ We hope you enjoy using RaspAP as much as we do creating it. Tell us how you use
- [Supported operating systems](#supported-operating-systems) - [Supported operating systems](#supported-operating-systems)
- [Multilingual support](#multilingual-support) - [Multilingual support](#multilingual-support)
- [HTTPS support](#https-support) - [HTTPS support](#https-support)
- [OpenVPN support](#openvpn-support)
- [How to contribute](#how-to-contribute) - [How to contribute](#how-to-contribute)
- [Reporting issues](#reporting-issues) - [Reporting issues](#reporting-issues)
- [License](#license) - [License](#license)
@ -76,6 +76,14 @@ WireGuard may be optionally installed by the [Quick Installer](https://docs.rasp
Details are [provided here](https://docs.raspap.com/wireguard/). 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 ## 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. 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.
@ -134,13 +142,6 @@ curl -sL https://install.raspap.com | bash -s -- --cert
More information on SSL certificates and HTTPS support is available [in our documentation](https://docs.raspap.com/ssl-quick/). More information on SSL certificates and HTTPS support is available [in our documentation](https://docs.raspap.com/ssl-quick/).
## OpenVPN support
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](https://docs.raspap.com/faq/#openvpn-fails) before reporting an issue.
## How to contribute ## How to contribute
1. Fork the project in your account and create a new branch: `your-great-feature`. 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. 2. Open an issue in the repository describing the feature contribution you'd like to make.