Skip to content

Commit 0369fbc

Browse files
authored
Merge pull request #22 from RaspAP/billz/reorg-style-tweaks
Reorg insiders + core features set
2 parents 124f1ee + 6790b78 commit 0369fbc

File tree

10 files changed

+28
-20
lines changed

10 files changed

+28
-20
lines changed
File renamed without changes.

docs/features-core/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55
- __Authentication__ [:octicons-arrow-right-24:{ .lg .middle } Get started](authentication.md)
66
- __Captive Portals__ [:octicons-arrow-right-24:{ .lg .middle } Get started](captive.md)
77
- __Custom Plugins__ [:octicons-arrow-right-24:{ .lg .middle } Get started](custom-plugins.md)
8+
- __Firewall__ [:octicons-arrow-right-24:{ .lg .middle } Get started](firewall.md)
89
- __Minimal Writing__ [:octicons-arrow-right-24:{ .lg .middle } Get started](minwrite.md)
910
- __Open VPN Client__ [:octicons-arrow-right-24:{ .lg .middle } Get started](openvpn.md)
11+
- __Speed Testing__ [:octicons-arrow-right-24:{ .lg .middle } Get started](speedtest.md)
1012
- __WiFI Repeater__ [:octicons-arrow-right-24:{ .lg .middle } Get started](repeater.md)
1113
- __Translations__ [:octicons-arrow-right-24:{ .lg .middle } Get started](translations.md)
1214
- __WireGuard__ [:octicons-arrow-right-24:{ .lg .middle } Get started](wireguard.md)
1315

14-
</div>
16+
</div>

docs/features-core/repeater.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ If your clients do not have internet connectivity, start by following these [tro
124124
logs and RaspAP's **Networking** interface. Help is available from the sources [mentioned here](../get-started/troubleshooting.md#diagnosing-problems).
125125

126126
## Speed testing
127-
RaspAP hosts a fast, open source and privacy-focused [public speed test server](../features-insiders/speedtest.md) that you can use to evaluate your WiFi repeater's performance. The remote host is RaspAP's public [speedtest server](https://speedtest.raspap.com/) located in the United States. Additional speedtest hosts distributed in other geographic centers are forthcoming.
127+
RaspAP hosts a fast, open source and privacy-focused [public speed test server](speedtest.md) that you can use to evaluate your WiFi repeater's performance. The remote host is RaspAP's public [speedtest server](https://speedtest.raspap.com/) located in the United States. Additional speedtest hosts distributed in other geographic centers are forthcoming.
128128

129129
## Discussions
130130
Questions or comments about configuring a WiFi repeater? Join the [discussion here](https://github.com/RaspAP/raspap-webgui/discussions/).
File renamed without changes.

docs/features-experimental/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@
33
- __AP-STA__ [:octicons-arrow-right-24:{ .lg .middle } Get started](ap-sta.md)
44
- __VPN Providers__ [:octicons-arrow-right-24:{ .lg .middle } Get started](providers.md)
55
- __REST API__ [:octicons-arrow-right-24:{ .lg .middle } Get started](restapi.md)
6-
- __SSL__ [:octicons-arrow-right-24:{ .lg .middle } Get started](ssl.md)
76

8-
</div>
7+
</div>

docs/features-insiders/dynamicdns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ An alternative to forwarding specific ports to an internal IP is using a **demil
101101

102102
This setup is often desirable when a host is running multiple public-facing services that need to be accessed over the internet. In this context, a DMZ provides greater isolation and granular control than is possible with port forwarding. It's also possible to configure different security policies for various DMZ segments. For these reasons, a properly configured DMZ can be a _more secure_ way to expose services to the internet than port forwarding.
103103

104-
The specifics of creating a DMZ are beyond the scope of this document, although at minimum a [firewall](firewall.md) is strongly advised.
104+
The specifics of creating a DMZ are beyond the scope of this document, although at minimum a [firewall](../features-core/firewall.md) is strongly advised.
105105

106106
## Discussions
107107
Questions or comments about using Dynamic DNS? Join the [discussion here](https://github.com/RaspAP/raspap-webgui/discussions/).

docs/features-insiders/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@ Sponsorships start as low as **[$10 per month](#how-to-become-a-sponsor)**.
1717
## Available Features
1818
<div class="grid cards" markdown>
1919

20+
- __Custom user avatars__ [:octicons-arrow-right-24:{ .lg .middle } Get started](../features-core/authentication/#custom-user-avatars)
2021
- __Dynamic DNS__ [:octicons-arrow-right-24:{ .lg .middle } Get started](dynamicdns.md)
21-
- __Firewall__ [:octicons-arrow-right-24:{ .lg .middle } Get started](firewall.md)
22-
- __Network Devices__ [:octicons-arrow-right-24:{ .lg .middle } Get started](net-devices.md)
23-
- __NTP Serrver__ [:octicons-arrow-right-24:{ .lg .middle } Get started](ntp.md)
24-
- __Speed Testing__ [:octicons-arrow-right-24:{ .lg .middle } Get started](speedtest.md)
22+
- __Inspect network adapters__ [:octicons-arrow-right-24:{ .lg .middle } Get started](../get-started/troubleshooting/#inspect-network-adapters)
23+
- __Limited privilege user role__ [:octicons-arrow-right-24:{ .lg .middle } Get started](../features-core/authentication/#limited-privilege-user-role)
24+
- __Network devices__ [:octicons-arrow-right-24:{ .lg .middle } Get started](net-devices.md)
25+
- __NTP Service__ [:octicons-arrow-right-24:{ .lg .middle } Get started](ntp.md)
2526
- __Tailscale VPN__ [:octicons-arrow-right-24:{ .lg .middle } Get started](tailscale.md)
26-
- __WLAN Routing__ [:octicons-arrow-right-24:{ .lg .middle } Get started](wlanrouting.md)
27+
- __WLAN routing__ [:octicons-arrow-right-24:{ .lg .middle } Get started](wlanrouting.md)
2728

2829
</div>
2930

@@ -94,7 +95,7 @@ The following section lists all funding goals. Each goal contains a list of feat
9495
:octicons-check-circle-fill-24:{: .check } [Set AP transmit power](../features-core/ap-basics.md#transmit-power)
9596

9697
#### **$1,000** - 2nd Insiders Edition
97-
:octicons-check-circle-fill-24:{: .check } [Firewall settings](firewall.md)
98+
:octicons-check-circle-fill-24:{: .check } [Firewall settings](../features-core/firewall.md)
9899
:octicons-check-circle-fill-24:{: .check } [WPA3-Personal AP security](../features-core/ap-basics.md#wpa3-personal)
99100
:octicons-check-circle-fill-24:{: .check } [802.11w Protected Management Frames](../features-core/ap-basics.md#80211w)
100101
:octicons-check-circle-fill-24:{: .check } [Printable Wi-Fi signs](../features-core/ap-basics.md#printable-signs)

docs/features-insiders/ntp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Looking at the column headers, this status output may be interpreted with the fo
8585
In the above example, our local NTP server is within 0.37ms of the preferred remote server, which itself is closely tied (`stratum=2`) to a high quality clock source. Our local server is within +/- 6ms of the other remotes.
8686

8787
## Firewall settings
88-
If your system uses a network [firewall](firewall.md), such as the one provided by RaspAP, you will need to be sure that it's configured for the NTP protocol. NTP uses UDP port 123 to communicate with peers. Therefore, you must ensure that the port is open in any firewall. To enable NTP traffic with `iptables` execute the following:
88+
If your system uses a network [firewall](../features-core/firewall.md), such as the one provided by RaspAP, you will need to be sure that it's configured for the NTP protocol. NTP uses UDP port 123 to communicate with peers. Therefore, you must ensure that the port is open in any firewall. To enable NTP traffic with `iptables` execute the following:
8989

9090
```
9191
iptables -A INPUT -p udp --dport 123 -j ACCEPT
@@ -98,7 +98,7 @@ ufw allow 123/udp
9898
```
9999

100100
!!! note "Note"
101-
If you're using RaspAP's [firewall](firewall.md), an exception is already present to allow NTP traffic by default.
101+
If you're using RaspAP's [firewall](../features-core/firewall.md), an exception is already present to allow NTP traffic by default.
102102

103103
## Troubleshooting
104104
Output from the NTP system calls `ntp_gettime()` and `ntp_adjtime()` is displayed prominently on the **NTP Server > Settings** page. If present, the current synchronized timekeeping data are displayed with their associated status codes. A `code 0 (OK)` indicates that these system calls are functioning as expected, as shown below:

docs/features-insiders/wlanrouting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ A system configured with predictable interface names is shown, above.
7272
If a wireless client connection is not detected on your system, it will be indicated as "not configured" in the interface. The **Start WLAN routing** button will also be disabled until an active wireless client connection is present.
7373

7474
### Check ethernet connectivity
75-
Finally, confirm internet connectivity on your Ethernet-equipped client device. Optionally, you may wish to perform a [speed test](speedtest.md). If you want to stop wireless LAN routing, simply choose **Stop WLAN routing**. The `iptables` NAT rules added by RaspAP will be removed from your system. The associated DHCP and `dnsmasq` configurations will be removed as well.
75+
Finally, confirm internet connectivity on your Ethernet-equipped client device. Optionally, you may wish to perform a [speed test](../features-core/speedtest.md). If you want to stop wireless LAN routing, simply choose **Stop WLAN routing**. The `iptables` NAT rules added by RaspAP will be removed from your system. The associated DHCP and `dnsmasq` configurations will be removed as well.
7676

7777
!!! tip "Tip"
7878
RaspAP's default subnets are added for convenience. If you wish to create a custom configuration for your clients, you may do so from the **DHCP Server** page. Be sure to **Save settings** and restart `dsnmasq` to apply your changes. If your interface is named something other than `eth0` or `enx` you must create your own DHCP configuration.

mkdocs.yml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ nav:
2222
- Bridged AP mode: features-core/bridged.md
2323
- Captive portal setup: features-core/captive.md
2424
- Custom user plugins: features-core/custom-plugins.md
25+
- Firewall: features-core/firewall.md
2526
- Minimal SD card write: features-core/minwrite.md
2627
- OpenVPN: features-core/openvpn.md
28+
- Speed testing: features-core/speedtest.md
2729
- SSL certificates: features-core/ssl.md
2830
- Translations: features-core/translations.md
2931
- WiFi repeater: features-core/repeater.md
@@ -35,12 +37,13 @@ nav:
3537
- VPN providers: features-experimental/providers.md
3638
- Insiders:
3739
- Insiders: features-insiders/index.md
38-
- Tailscale VPN: features-insiders/tailscale.md
40+
- Custom user avatars: features-core/authentication/#custom-user-avatars
3941
- Dynamic DNS: features-insiders/dynamicdns.md
40-
- Firewall: features-insiders/firewall.md
42+
- Inspect network adapters: get-started/troubleshooting/#inspect-network-adapters
43+
- Limited privilege user: features-core/authentication/#limited-privilege-user-role
4144
- Network devices: features-insiders/net-devices.md
4245
- NTP Service: features-insiders/ntp.md
43-
- Speed testing: features-insiders/speedtest.md
46+
- Tailscale VPN: features-insiders/tailscale.md
4447
- Wireless LAN routing: features-insiders/wlanrouting.md
4548
- FAQ: faq.md
4649
- Reporting Issues: issues.md
@@ -118,7 +121,10 @@ plugins:
118121
- search
119122
- git-revision-date-localized
120123
- git-committers:
121-
repository: ./ #RaspAP/raspap-docs
124+
repository: RaspAP/raspap-docs
125+
branch: master
126+
token: !ENV MKDOCS_GIT_COMMITTERS_APIKEY
127+
enabled: !ENV [CI, false]
122128
- mkdocs-video
123129
- glightbox
124130
- redirects:
@@ -130,9 +136,11 @@ plugins:
130136
'bridged.md': 'features-core/bridged.md'
131137
'captive.md': 'features-core/captive.md'
132138
'custom-plugins.md': 'features-core/custom-plugins.md'
139+
'firewall.md': 'features-core/firewall.md'
133140
'minwrite.md': 'features-core/minwrite.md'
134141
'openvpn.md': 'features-core/openvpn.md'
135142
'repeater.md': 'features-core/repeater.md'
143+
'speedtest.md': 'features-core/speedtest.md'
136144
'ssl.md': 'features-core/ssl.md'
137145
'translations.md': 'features-core/translations.md'
138146
'wireguard.md': 'features-core/wireguard.md'
@@ -143,10 +151,8 @@ plugins:
143151
# mappings for features-insiders
144152
'insiders.md': 'features-insiders/index.md'
145153
'dynamicdns.md': 'features-insiders/dynamicdns.md'
146-
'firewall.md': 'features-insiders/firewall.md'
147154
'net-devices.md': 'features-insiders/net-devices.md'
148155
'ntp.md': 'features-insiders/ntp.md'
149-
'speedtest.md': 'features-insiders/speedtest.md'
150156
'tailscale.md': 'features-insiders/tailscale.md'
151157
'wlanrouting.md': 'features-insiders/wlanrouting.md'
152158
# mappings for get-started

0 commit comments

Comments
 (0)