vrr/amneziawg-installer
2
0
Fork 0
mirror of https://github.com/bivlked/amneziawg-installer.git synced 2026-07-09 17:29:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add DeepWiki wiki.json repo_notes + Ask DeepWiki badge (#161)

Browse source 
Steer DeepWiki generation toward the current 2026 feature set
(Debian/Ubuntu 25.10/26.04/ARM, cascade, MSS clamp, expiry, mobile
DPI) and the current default routing, so the auto-generated wiki and
the LLMs that cite it stop reflecting the stale January 2026 snapshot.
repo_notes only (no pages) to keep full automatic page coverage.
Add an "Ask DeepWiki" badge to both READMEs pointing at the canonical
bivlked wiki URL.
This commit is contained in:
Ivan Bondarev 2026-07-06 15:27:23 +03:00 • committed by GitHub
parent f12a93ddf4
commit 7e774dae9d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
.devin/wiki.json Normal file
View file

@ -0,0 +1,16 @@
{
"repo_notes": [
{
"content": "amneziawg-installer is an installer and management toolkit for AmneziaWG 2.0 VPN on dedicated Ubuntu (24.04, 25.10, 26.04) and Debian (12, 13) servers, on x86_64 and ARM64/ARMv7. It targets users with no advanced Linux knowledge: a short quick start (download the script, make it executable, run it with sudo) sets up the DKMS kernel module, UFW firewall, Fail2Ban, sysctl hardening, and generates server and client configs with QR codes and vpn:// URIs for the Amnezia client. The overview should state the tool name, the quick-start commands, and the differentiators up front, since this wiki is used as a quick reference. Documentation is bilingual: Russian (README.md, ADVANCED.md, CASCADE.md) and English (the .en.md docs and _en.sh scripts). The server must be a dedicated host or a full VM; the installer does not support LXC containers because it builds a kernel module (a manual amneziawg-go userspace path for LXC is documented separately in ADVANCED).",
"author": "maintainer"
},
{
"content": "Prioritize the current 2026 feature set, which older snapshots miss: Debian 12/13 and Ubuntu 25.10/26.04 support (PPA codename remapping plus a from-source DKMS fallback), ARM prebuilt kernel modules when a matching target exists with a DKMS source fallback otherwise, a documented two-server cascade guide where Russian traffic goes direct and everything else exits abroad (CASCADE.md and CASCADE.en.md), automatic TCP MSS clamping for reliability on mobile carriers, double-NAT and cascade (added in v5.17.0), time-limited clients via the --expires=DURATION option, optional in-tunnel IPv6 via --allow-ipv6-tunnel (off by default), and mobile-carrier DPI tuning using AmneziaWG 2.0 concealment (the installer auto-generates the I1 CPS parameter; I2 to I5 are optional and manual; plus Jc/Jmin/Jmax junk) with per-carrier diagnostics. Note: the default split-tunnel routing was corrected in v5.16.1, so document the current default (1.0.0.0/8, 2.0.0.0/7, 4.0.0.0/6, 8.0.0.0/7 and so on) and not the old 0.0.0.0/5 plus 8.0.0.0/7 default that broke iOS.",
"author": "maintainer"
},
{
"content": "Cover how the tool differs from alternatives, since readers compare. Versus the official Amnezia application: no Docker, no GUI, a kernel-native module, single-purpose server optimization and hardening, and a headless SSH workflow. Versus other AmneziaWG install scripts: deeper automation, client expiry, mobile-carrier DPI tuning and diagnostics, backup and restore, bilingual Russian and English, security hardening by default (including PPA GPG fingerprint verification and SHA256-pinned helper scripts), and no web panel required.",
"author": "maintainer"
}
]
}

1
README.en.md
View file

@ -22,6 +22,7 @@
<a href="https://github.com/bivlked/amneziawg-installer/actions/workflows/test.yml"><img src="https://github.com/bivlked/amneziawg-installer/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
<a href="https://github.com/bivlked/amneziawg-installer/stargazers"><img src="https://img.shields.io/github/stars/bivlked/amneziawg-installer?style=flat" alt="Stars"></a>
<img src="https://img.shields.io/github/last-commit/bivlked/amneziawg-installer" alt="Last commit">
<a href="https://deepwiki.com/bivlked/amneziawg-installer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</p>
<p align="center">

1
README.md
View file

@ -23,6 +23,7 @@
<a href="https://github.com/bivlked/amneziawg-installer/actions/workflows/test.yml"><img src="https://github.com/bivlked/amneziawg-installer/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
<a href="https://github.com/bivlked/amneziawg-installer/stargazers"><img src="https://img.shields.io/github/stars/bivlked/amneziawg-installer?style=flat" alt="Stars"></a>
<img src="https://img.shields.io/github/last-commit/bivlked/amneziawg-installer" alt="Last commit">
<a href="https://deepwiki.com/bivlked/amneziawg-installer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</p>
<p align="center">