-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
444 lines (420 loc) · 25 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<!DOCTYPE html>
<html lang="en">
<head>
<title>RaspAP — Simple wireless router setup for Debian-based devices</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link rel="shortcut icon" href="favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:300,400,300italic,400italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Montserrat:400,700' rel='stylesheet' type='text/css'>
<!-- FontAwesome JS-->
<script defer src="assets/fontawesome/js/all.min.js"></script>
<!-- Global CSS -->
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/prism/prism.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/theme-2.css">
<!-- GitHub Button -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-61X75VBL8Q"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-61X75VBL8Q');
</script>
</head>
<body data-spy="scroll">
<!-- ******HEADER****** -->
<header id="header" class="header">
<div class="container">
<h1 class="logo float-left">
<a class="scrollto" href="#promo">
<span class="logo-title">RaspAP</span>
</a>
</h1><!--//logo-->
<nav id="main-nav" class="main-nav navbar-expand-md float-right" role="navigation">
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button><!--//nav-toggle-->
<div class="navbar-collapse collapse" id="navbar-collapse">
<ul class="nav navbar-nav">
<li class="nav-item sr-only"><a class="nav-link scrollto" href="#promo">Home</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#about">About</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#features">Features</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#docs">Docs</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#license">License</a></li>
<li class="nav-item last"><a class="nav-link scrollto" href="#contact">Contact</a></li>
</ul><!--//nav-->
</div><!--//navabr-collapse-->
</nav><!--//main-nav-->
</div>
</header><!--//header-->
<!-- ******PROMO****** -->
<section id="promo" class="promo section bg-image">
<div class="container">
<h2 class="title">Rasp<span class="highlight">AP</span></h2>
<p class="intro">The easiest, full-featured wireless router setup for Debian-based devices. Period.</p>
<div class="btns">
<a class="btn btn-cta-secondary" href="#quick">Quick start</a>
<a class="btn btn-cta-primary" href="https://github.com/sponsors/RaspAP" target="_blank">Get Insiders</a>
</div>
<ul class="meta list-inline">
<li class="list-inline-item"><a href="https://github.com/RaspAP/raspap-webgui" target="_blank">View on GitHub</a></li>
<li class="list-inline-item"><a href="https://docs.raspap.com/" target="_blank">Full Documentation</a></li>
<li class="list-inline-item">Created by: the <a href="https://github.com/RaspAP" target="_blank">RaspAP team</a></li>
</ul><!--//meta-->
</div><!--//container-->
<div class="social-media">
<div class="social-media-inner container text-center">
<ul class="list-inline mb-2">
<li class="list-inline-item twitter-follow"><a href="https://twitter.com/rasp_ap" class="twitter-follow-button" data-show-count="false">Follow @RaspAP</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</li><!--//twitter-follow-->
<li class="list-inline-item twitter-tweet">
<a href="https://twitter.com/share" class="twitter-share-button" data-via="RaspAP" data-hashtags="RaspAP">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</li><!--//twitter-tweet-->
<!--// Generate github buttons: https://github.com/mdo/github-buttons -->
<li class="list-inline-item github-star"><a class="github-button" href="https://github.com/RaspAP/raspap-webgui" data-icon="octicon-star" aria-label="Star RaspAP/raspap-webgui on GitHub">Star</a></li>
<li class="list-inline-item github-follow"><a class="github-button" href="https://github.com/sponsors/RaspAP" aria-label="Sponsor RaspAP on GitHub">Join Insiders</a></li>
</ul>
</div>
</div>
</section><!--//promo-->
<!-- ******ABOUT****** -->
<section id="about" class="about section">
<div class="container">
<h2 class="title text-center">More than an access point</h2>
<div class="featured-img text-center">
<img class="img-fluid mt-2 mb-4" style="max-width:75%;" src="assets/images/dashboard.png" alt="RaspAP Dashboard" />
</div><!--//featured-img-->
<p class="intro text-center">RaspAP is feature-rich wireless router software that <i>just works</i> on many popular Debian-based devices, including the Raspberry Pi.
Customizable, mobile-friendly interface in 20+ languages. Sets up in minutes.</p>
<div class="row">
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-key"></i>
</div>
<div class="content">
<h3 class="sub-title">Multiple VPN options</h3>
<p>Both <a href="https://docs.raspap.com/openvpn/">OpenVPN</a> and cutting edge <a href="https://docs.raspap.com/wireguard/">WireGuard</a> encrypted tunnels may be configured to securely connect your client devices.</p>
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="far fa-hand-paper"></i>
</div>
<div class="content">
<h3 class="sub-title">Ad block integration</h3>
<p>Streamline AP throughput for your clients by sending requests for ads, trackers and other undesirable hosts to <a href="https://docs.raspap.com/adblock/">DNS blacklist oblivion</a>.</p>
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-archway"></i>
</div>
<div class="content">
<h3 class="sub-title">Bridged mode</h3>
<p>Want your upstream router to assign IP addresses? RaspAP lets you change the default routed configuration to an alternate <a href="https://docs.raspap.com/bridged/">bridged AP</a> mode.</p>
</div><!--//content-->
</div><!--//item-->
<div class="clearfix visible-md"></div>
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-code"></i>
</div>
<div class="content">
<h3 class="sub-title">Easy to customize</h3>
<p>Modify RaspAP to suit your needs with a completely exposed <a href="https://docs.raspap.com/defaults/">default configuration</a>, many <a href="https://docs.raspap.com/quick/">installation options</a>, themes and more.</p>
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fab fa-docker"></i>
</div>
<div class="content">
<h3 class="sub-title">Docker ready</h3>
<p>Deploy RaspAP quickly in a portable, lightweight and isolated <a href="https://docs.raspap.com/docker/">Docker container</a> for all your application needs.
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-microchip"></i>
</div>
<div class="content">
<h3 class="sub-title">Made for IoT</h3>
<p>Small on memory utilization yet big on features, RaspAP is ideal for IoT applications where <a href="https://www.raspberrypi.org/blog/low-cost-raspberry-pi-zero-endoscope-camera/">wireless connectivity</a> and data sharing are a must.</p>
</div><!--//content-->
</div><!--//item-->
<div class="clearfix visible-md"></div>
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-puzzle-piece"></i>
</div>
<div class="content">
<h3 class="sub-title">Integrated API</h3>
<p>RaspAP includes support for stateless client-server data exchange via a high performance <a href="https://docs.raspap.com/restapi/">RESTful API</a> based on FastAPI.</p>
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-plug"></i>
</div>
<div class="content">
<h3 class="sub-title">Custom user plugins</h3>
<p>Want to extend RaspAP's functionality? A plugin manager and <a href="https://github.com/RaspAP/SamplePlugin">sample plugin</a> make it easy for developers to create their own <a href="https://docs.raspap.com/custom-plugins/">custom plugins</a>.</p>
</div><!--//content-->
</div><!--//item-->
<div class="item col-lg-4 col-md-6 col-12">
<div class="icon-holder">
<i class="fas fa-shield-alt"></i>
</div>
<div class="content">
<h3 class="sub-title">VPN provider control</h3>
<p>Administer several of the most popular <a href="https://docs.raspap.com/providers/">VPN providers</a> via their Command Line Interfaces (CLIs) directly in RaspAP's UI.
</div><!--//content-->
</div><!--//item-->
</div><!--//row-->
</div><!--//container-->
</section><!--//about-->
<!-- ******FEATURES****** -->
<section id="features" class="features section">
<div class="container text-center">
<h2 class="title">Additional Features</h2>
<ul class="feature-list list-unstyled">
<li><i class="fas fa-check"></i> Data usage graphs for all interfaces</li>
<li><i class="fas fa-check"></i> <a href="https://docs.raspap.com/ssl/">SSL certificate</a> support</li>
<li><i class="fas fa-check"></i> <a href="https://docs.raspap.com/captive/">Captive portal</a> integration</li>
<li><i class="fas fa-check"></i> Up-to-date security audits</li>
<li><i class="fas fa-check"></i> Advanced DHCP server control</li>
<li><i class="fas fa-check"></i> 802.11ac 5GHz operation</li>
<li><i class="fas fa-check"></i> <a href="https://docs.raspap.com/dynamicdns/">Dynamic DNS</a> support</li>
<li><i class="fas fa-check"></i> Auto-detect external wireless adapters</li>
<li><i class="fas fa-check"></i> <a href="https://docs.raspap.com/ap-basics/#wpa3-personal">WPA3-Personal + 802.11w</a> support</li>
<li><i class="fas fa-check"></i> <a href="https://github.com/RaspAP/raspap-docker">Docker</a> support</li>
<li><i class="fas fa-check"></i> Fully responsive + mobile-ready</li>
</ul>
</div><!--//container-->
</section><!--//features-->
<!-- ******DOCS****** -->
<section id="docs" class="docs section">
<div class="container">
<div class="docs-inner">
<a id="quick"></a><h2 class="title text-center">Quick Start</h2>
<div class="block">
<p>RaspAP gives you two different ways to get up and running quickly. The simplest approach is to use a <a href="https://github.com/RaspAP/raspap-webgui/releases/latest">custom OS image</a> with RaspAP preinstalled. This option eliminates guesswork and gives you a base upon which to build. An alternative method is to execute the Quick installer on an existing <a href="#distros">compatible OS</a>.</p>
<a id="custom"></a><h3 class="sub-title text-center">Custom OS</h3>
<p>Custom Raspberry Pi OS Lite images with the latest RaspAP are available for <a href="https://github.com/RaspAP/raspap-webgui/releases/latest">direct download</a>. This includes both 32- and 64-bit builds for ARM architectures.</p>
<div class="table-responsive-sm">
<table class="table table-hover table-sm">
<thead>
<tr>
<th scope="col">Distribution</th>
<th scope="col">Debian version</th>
<th scope="col">Kernel version</th>
<th scope="col">RaspAP version</th>
<th scope="col">Size</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">Raspberry Pi OS (64-bit) Lite</th>
<td>12 (bookworm)</td>
<td>6.6</td>
<td>Latest</td>
<td>777 MB</td>
</tr>
<tr>
<th scope="row">Raspberry Pi OS (32-bit) Lite</th>
<td>12 (bookworm)</td>
<td>6.6</td>
<td>Latest</td>
<td>805 MB</td>
</tr>
</tbody>
</table>
</div>
<p>These images are automatically generated with each release of RaspAP and are made <a href="https://github.com/RaspAP/raspap-webgui/releases/latest">available here</a>. You may choose between an <code>arm64</code> or <code>armhf</code> (32-bit) based build.</p>
<p>After downloading your desired image, use a utility such as the Raspberry Pi Imager or <a href="https://www.balena.io/etcher">balenaEtcher</a> to flash the OS image onto a microSD card. Insert the card into your device and boot it up. The latest RaspAP release with the most popular components will be active and ready for you to configure.</p>
<a id="quick"></a><h3 class="sub-title text-center">Quick installer</h3>
<p>Alternatively, begin with a clean install of the latest release of a <a href="#distros">supported Linux distribution</a>. In the example below, <a href="https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-64-bit">Raspberry Pi OS (64-bit) Lite</a> is used.
Update your OS to its latest version, including the kernel and firmware, followed by a reboot:.</p>
<div class="code-block">
<pre><code class="language-markup">
sudo apt-get update
sudo apt-get full-upgrade
sudo reboot
</code></pre>
</div><!--//code-block-->
<div class="mt-4">
<p>Set the WiFi country in <code>raspi-config</code>'s <strong>Localisation Options</strong>:</p>
<div class="code-block">
<pre><code class="language-markup">
sudo raspi-config
</code></pre>
</div><!--//code-block-->
</div>
<div class="mt-4">
<p>Invoke RaspAP's Quick Installer:
<div class="code-block">
<pre><code class="language-markup">
curl -sL https://install.raspap.com | bash
</code></pre>
</div><!--//code-block-->
</div>
<div class="mt-4">
<p>The <a href="https://docs.raspap.com/quick/">Quick installer</a> will complete the steps in the <a href="https://docs.raspap.com/manual/">manual installation</a> for you. At the end of the install process, accept the prompt to reboot your system.</p>
<a id="settings"></a><h3 class="sub-title text-center">Initial settings</h3>
<p>After completing either of these setup options, the wireless AP network will be configured as follows:</p>
<ul class="list-unstyled padding-left">
<li><strong>IP address:</strong> 10.3.141.1</li>
<li><strong>Username:</strong> admin</li>
<li><strong>Password:</strong> secret</li>
<li><strong>DHCP range:</strong> 10.3.141.50 — 10.3.141.254</li>
<li><strong>SSID:</strong> raspi-webgui</li>
<li><strong>Password:</strong> ChangeMe</li>
</ul>
</div>
<p>It is strongly recommended that you change these default credentials in RaspAP's <strong>Authentication</strong> and <strong>Hotspot > Security</strong> panels.</p>
<p>Your AP's <a href="https://docs.raspap.com/ap-basics/">basic settings</a> and many <a href="https://docs.raspap.com/ap-basics/#advanced-options">advanced options</a> may now be modified by RaspAP.</p>
</div><!--//block-->
<div class="block">
<a id="distros"><h3 class="sub-title text-center">Supported Distributions</h3></a>
<p>RaspAP was originally made for Raspberry Pi OS, but now also installs on the following Debian-based distros.</p>
<div class="table-responsive-sm">
<table class="table table-hover table-sm">
<thead>
<tr>
<th scope="col">Distribution</th>
<th scope="col">Release</th>
<th scope="col">Architecture</th>
<th scope="col">Support</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">Raspberry Pi OS</th>
<td>(64-bit) Lite Bookworm</td>
<td>ARM</td>
<td>Official</td>
</tr>
<tr>
<th scope="row">Raspberry Pi OS</th>
<td>(32-bit) Lite Bookworm</td>
<td>ARM</td>
<td>Official</td>
</tr>
<tr>
<th scope="row">Raspberry Pi OS</th>
<td>(64-bit) Desktop Bookworm</td>
<td>ARM</td>
<td>Official</td>
</tr>
<tr>
<th scope="row">Raspberry Pi OS</th>
<td>(64-bit) Lite Bullseye</td>
<td>ARM</td>
<td>Official</td>
</tr>
<tr>
<th scope="row">Raspberry Pi OS</th>
<td>(32-bit) Lite Bullseye</td>
<td>ARM</td>
<td>Official</td>
</tr>
<tr>
<th scope="row">Armbian</th>
<td>23.11 (Jammy)</td>
<td><a href="https://www.armbian.com/rpi4b/">ARM</a></td>
<td>Beta</td>
</tr>
<tr>
<th scope="row">Debian</th>
<td>Bookworm</td>
<td>ARM / x86_64</td>
<td>Beta</td>
</tr>
<tr>
<th scope="row">Ubuntu</th>
<td>Server 23.04 (Lunar)</td>
<td>ARM / x86_64</td>
<td>Beta</td>
</tr>
</tbody>
</table>
</div><!--//table-responive-->
<p class="text-center">
<img class="img-fluid mt-2 mb-4" style="max-width:60%;" src="assets/images/supported-distros.png" alt="Linux distributions" />
</p>
<p>
You are also encouraged to try RaspAP's community-led <a href="https://github.com/RaspAP/raspap-docker">Docker container</a>.
</p>
</div><!--//block-->
<div class="block">
<h3 class="sub-title text-center">Documentation and more</h3>
<p>Our <a href="https://docs.raspap.com/faq/">frequently asked questions (FAQ)</a> are continuously updated and are a great place to start. Need help not covered in the FAQ, have an idea or want to share your project
with the RaspAP community? Head over to our GitHub <a href="https://github.com/RaspAP/raspap-webgui/discussions">Discussions</a>. For everything else, dive into our official documentation.</p>
<p class="text-center">
<a class="btn btn-cta-primary" href="https://docs.raspap.com/" target="_blank">RaspAP docs</a>
</p>
</div><!--//block-->
</div><!--//docs-inner-->
</div><!--//container-->
</section><!--//features-->
<!-- ******LICENSE****** -->
<section id="license" class="license section">
<div class="container">
<div class="license-inner">
<h2 class="title text-center">License</h2>
<div class="info">
<code>RaspAP/raspap-webgui</code> is licensed under the <i class="fas fa-balance-scale"></i> <a href="https://github.com/RaspAP/raspap-webgui/blob/master/LICENSE">GNU General Public License v3.0</a>.</p>
<p>Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.</p>
<p>RaspAP is created by a team of <a href="https://github.com/RaspAP">dedicated developers</a> who contribute their time and expertise to improving this project.
</div><!--//info-->
</div><!--//license-inner-->
</div><!--//container-->
</section><!--//how-->
<!-- ******CONTACT****** -->
<section id="contact" class="contact section has-pattern">
<div class="container">
<div class="contact-inner">
<h2 class="title text-center">Contact</h2>
<p class="intro text-center">Follow <a href="https://x.com/rasp_ap/">RaspAP on X</a> for updates.</p>
<div class="clearfix"></div>
<div class="info text-center">
<ul class="social-icons list-inline">
<li class="list-inline-item last"><a href="https://x.com/rasp_ap/" target="_blank"><i class="fab fa-square-x-twitter"></i></a></li>
<li class="list-inline-item last"><a href="https://github.com/RaspAP/" target="_blank"><i class="fab fa-github"></i></a></li>
<li class="list-inline-item last"><a href="https://www.reddit.com/r/RaspAP/" target="_blank"><i class="fab fa-reddit"></i></a></li>
<li class="list-inline-item last"><a href="https://discord.gg/KVAsaAR" target="_blank"><i class="fab fa-discord"></i></a></li>
<li class="list-inline-item last"><a href="https://github.com/sponsors/RaspAP" target="_blank"><i class="fas fa-door-open"></i></a></li>
</ul>
</div><!--//info-->
</div><!--//contact-inner-->
</div><!--//container-->
</section><!--//contact-->
<!-- ******FOOTER****** -->
<footer class="footer">
<div class="container text-center">
<small class="copyright">Designed with <i class="fas fa-heart"></i> by <a href="https://themes.3rdwavemedia.com" target="_blank">Xiaoying Riley</a> for developers</small>
</div><!--//container-->
</footer><!--//footer-->
<!-- Javascript -->
<script type="text/javascript" src="assets/plugins/jquery-3.4.1.min.js"></script>
<script type="text/javascript" src="assets/plugins/jquery.easing.1.3.js"></script>
<script type="text/javascript" src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-scrollTo/jquery.scrollTo.min.js"></script>
<script type="text/javascript" src="assets/plugins/prism/prism.js"></script>
<script type="text/javascript" src="assets/js/main.js"></script>
</body>
</html>