Dawnline 0.10.0
Build packages / CI (push) Blocked by required conditions
Build packages / Version (push) Waiting to run
CI / Web (format, types, tests, bundles) (push) Blocked by required conditions
CI / ShellCheck (push) Blocked by required conditions
CI / ucode static checks (push) Blocked by required conditions
CI / ucode compiles and tests pass (OpenWrt 24.10) (push) Blocked by required conditions
CI / ucode compiles and tests pass (OpenWrt 25.12) (push) Blocked by required conditions
Build packages / CI (push) Blocked by required conditions
Build packages / Version (push) Waiting to run
CI / Web (format, types, tests, bundles) (push) Blocked by required conditions
CI / ShellCheck (push) Blocked by required conditions
CI / ucode static checks (push) Blocked by required conditions
CI / ucode compiles and tests pass (OpenWrt 24.10) (push) Blocked by required conditions
CI / ucode compiles and tests pass (OpenWrt 25.12) (push) Blocked by required conditions
- Portal redesigned from scratch. No header bar: the page opens with the server's name and the person's and fades under the edges. Device cards show the status, the last 7 days (hover a day for its figures) and a Connect or Update button; "Your access" folds into rows: what they can reach (with the names at home), data this month day by day, and when access ends. The page follows the system's light or dark theme - Adding a device: pick the kind (PC, Mobile, Router, Other) and a name, or add it from the device itself with the page's QR code. The set-up sheet then shows the app for that system and the connection, waits for the first connection, says "<device> connected" and closes on its own - Switching apps in the set-up sheet changes only what differs: the old words blur into the new ones, and the menu path is shown for iOS and Android in one line. Names, numbers and statuses that change on the page morph in place - Dialogs open in the middle on a computer, on the same spring as the menu; buttons that wait for the router show a spinner at once - A paused account gets one card that says so; the page's messages are short and no longer send people to the admin. A QR code of the page sits beside the breadcrumb, to open it on another device - Allowed hours are shown in the visitor's own time zone - The portal's Title setting is gone: the page and its tab take the server's name. A title set before is removed on upgrade - The admin names .conf files after the server too, as the portal does (Outline-Home.conf); its device menu says "Download AmneziaWG config" and "Copy AmneziaVPN config", and its QR codes use the portal's round look in the admin's light or dark colours - README rewritten, with screenshots made from a demo cast (scripts/capture-screenshots.mjs --demo)
This commit is contained in:
1 parent
edeb1506fd
commit
4f12ca19e7
94 files changed
+8076
-5009
No files matched your search
@@ -1,88 +1,182 @@
|
||||
# Dawnline
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/tickcount/luci-app-dawnline/actions/workflows/ci.yml)
|
||||
[](https://github.com/tickcount/luci-app-dawnline/actions/workflows/build.yml)
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
|
||||
<img alt="Dawnline" src="docs/assets/logo-light.svg" width="88" height="88">
|
||||
</picture>
|
||||
|
||||
Your OpenWrt router as a private VPN for the people you choose.
|
||||
<h1>Dawnline</h1>
|
||||
|
||||
Dawnline runs an [AmneziaWG](https://docs.amnezia.org/) server on the router
|
||||
and gives every person a personal link. They open it, add their own devices
|
||||
(up to the limit you set) and connect with AmneziaVPN or AmneziaWG. You decide
|
||||
what each person may reach: the home network, the internet, or both.
|
||||
**Your OpenWrt router as a private VPN for the people you choose.**
|
||||
|
||||
Dawnline is the successor of [Liminal](https://github.com/tickcount/openwrt-liminal):
|
||||
the same idea rebuilt around people instead of peers, with a personal portal,
|
||||
limits, live traffic and a LuCI admin that follows a modern design.
|
||||
<a href="https://github.com/tickcount/luci-app-dawnline/releases/latest"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/release/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=dark"><img alt="Latest release" src="https://shieldcn.dev/github/release/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=light"></picture></a>
|
||||
<a href="https://github.com/tickcount/luci-app-dawnline/actions/workflows/ci.yml"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/ci/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=dark"><img alt="CI" src="https://shieldcn.dev/github/ci/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=light"></picture></a>
|
||||
<a href="https://github.com/tickcount/luci-app-dawnline/releases"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/downloads/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=dark"><img alt="Downloads" src="https://shieldcn.dev/github/downloads/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=light"></picture></a>
|
||||
<a href="LICENSE"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/license/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=dark"><img alt="License" src="https://shieldcn.dev/github/license/tickcount/luci-app-dawnline.svg?variant=secondary&font=geist&mode=light"></picture></a>
|
||||
<br>
|
||||
<a href="https://openwrt.org/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/badge/OpenWrt-24.10%20%C2%B7%20opkg.svg?variant=secondary&font=geist&logo=openwrt&mode=dark"><img alt="OpenWrt 24.10" src="https://shieldcn.dev/badge/OpenWrt-24.10%20%C2%B7%20opkg.svg?variant=secondary&font=geist&logo=openwrt&mode=light"></picture></a>
|
||||
<a href="https://openwrt.org/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/badge/OpenWrt-25.12%20%C2%B7%20apk.svg?variant=secondary&font=geist&logo=openwrt&mode=dark"><img alt="OpenWrt 25.12" src="https://shieldcn.dev/badge/OpenWrt-25.12%20%C2%B7%20apk.svg?variant=secondary&font=geist&logo=openwrt&mode=light"></picture></a>
|
||||
<a href="https://docs.amnezia.org/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/badge/AmneziaWG-2.0%20%C2%B7%203.1.svg?variant=secondary&font=geist&logo=wireguard&mode=dark"><img alt="AmneziaWG 2.0 and 3.1" src="https://shieldcn.dev/badge/AmneziaWG-2.0%20%C2%B7%203.1.svg?variant=secondary&font=geist&logo=wireguard&mode=light"></picture></a>
|
||||
|
||||

|
||||
[**Quick start**](#-quick-start) · [Features](#-features) · [How it works](#-how-it-works) · [Screenshots](#-a-closer-look) · [FAQ](#-faq) · [Development](#-development)
|
||||
|
||||
| People | A person |
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
Dawnline runs an [AmneziaWG] server on your OpenWrt router and gives every
|
||||
person you invite **a personal link**. They open it, **add their own phones and
|
||||
computers** and connect with AmneziaVPN, AmneziaWG or WireGuard. You decide
|
||||
**what each of them may reach** (the home network, the internet, or both) and
|
||||
**for how long, how much and when**.
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/portal.png" alt="The personal portal: devices and access, and adding a phone in three steps" width="860">
|
||||
<br>
|
||||
<sub>A person's own page: their devices and access. Adding a phone takes three steps, and the page sees it connect.</sub>
|
||||
</p>
|
||||
|
||||
## 💡 Why Dawnline?
|
||||
|
||||
Sharing a home VPN usually means making a config file by hand, sending it over
|
||||
a messenger and hoping nobody shares it further. Dawnline turns that around:
|
||||
|
||||
| | A VPN by hand | With Dawnline |
|
||||
|---|---|---|
|
||||
| **Setting up a device** | You make a config and send it | They add it themselves from their link |
|
||||
| **Who can do what** | Everyone gets the same | Home, internet or both, per person |
|
||||
| **Ending access** | Find and delete their peers | A date, a data limit, or one click |
|
||||
| **Knowing what goes on** | Read `wg show` | Who is online, traffic, places, a log |
|
||||
| **When something breaks** | You find out from them | A watchdog notices and repairs it |
|
||||
|
||||
It is the successor of [Liminal]: the same idea rebuilt around people instead
|
||||
of peers, with a personal portal, limits, live traffic and a LuCI admin that
|
||||
follows a modern design.
|
||||
|
||||
## 🚀 Quick start
|
||||
|
||||
1. **Install** on the router (it asks before it changes anything):
|
||||
|
||||
```sh
|
||||
sh -c "$(wget -qO- https://raw.githubusercontent.com/tickcount/luci-app-dawnline/main/install.sh)"
|
||||
```
|
||||
|
||||
2. **Set up** in LuCI: <kbd>Network</kbd> › <kbd>Dawnline</kbd>, and follow the
|
||||
wizard. It suggests the port, the public address and the networks.
|
||||
3. **Invite** someone: <kbd>Add person</kbd>, then send them the link or the
|
||||
invite card with its QR code. They do the rest.
|
||||
|
||||
> [!TIP]
|
||||
> Behind Cloudflare, give the portal a port Cloudflare proxies: 2053, 2083,
|
||||
> 2087, 2096 or 8443.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%" valign="top">
|
||||
<h3>🔗 A link, not an account</h3>
|
||||
<p>Three words, like <code>vpn.example.com/kamiro-telosu-bavine</code>. The link is the key: no sign-up, no password, and a new link locks the old one out at once.</p>
|
||||
</td>
|
||||
<td width="50%" valign="top">
|
||||
<h3>📱 Their own devices</h3>
|
||||
<p>People add, rename and remove devices up to their limit. Adding one walks them through it: the right app, then a QR code, a link, a key or a file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<h3>👥 People, not peers</h3>
|
||||
<p>One card per person with their devices, who is online, traffic, end date and data limit. Filter by who needs attention or is paused.</p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<h3>🧭 Who reaches what</h3>
|
||||
<p>The home network, the internet or both; only some networks or devices at home (a NAS, Home Assistant). Family sees family, guests see guests.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<h3>⏳ Limits</h3>
|
||||
<p>End dates, monthly or total data limits, allowed hours, a pause button. Changes apply at once, without dropping anyone else's connection.</p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<h3>🕶️ Disguise</h3>
|
||||
<p>Presets that make the VPN traffic harder to spot and block, with what each one needs from the apps.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<h3>🏠 Internet like a home device</h3>
|
||||
<p>People's devices go online the way the devices at home do, so your proxies, ad and DNS filters cover them too.</p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<h3>🗺️ Overview and places</h3>
|
||||
<p>Who is online with what, speed now, the last 30 days, and a map of where people connect from, at city level.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<h3>🩺 Repairs itself</h3>
|
||||
<p>Health checks with one-click fixes, and a watchdog that checks the tunnels, access rules and portal every minute and mends them.</p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<h3>📦 Updates and backups</h3>
|
||||
<p>Dawnline and AmneziaWG built for your firmware in one place; nightly backups, and export and import to move to another router.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## 🧩 How it works
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
you(["🛠️ You, in LuCI"]) -- "add a person" --> link["🔗 Their link"]
|
||||
link -- "they open it" --> portal["📱 Their portal"]
|
||||
portal -- "add a device" --> app["App and connection"]
|
||||
app == "AmneziaWG tunnel" ==> router["🌅 Dawnline<br>on your router"]
|
||||
router -- "if allowed" --> home["🏠 Home network"]
|
||||
router -- "if allowed" --> net["🌍 Internet"]
|
||||
```
|
||||
|
||||
1. **You add a person** in LuCI and choose what they may reach, their device
|
||||
limit, an end date or a data limit.
|
||||
2. **They open their link** on any device. The portal is theirs alone: it shows
|
||||
their devices and their access; access and limits stay yours to change.
|
||||
3. **They add a device.** The portal points them to the app for that system and
|
||||
hands over the connection; the router gives each device its own keys.
|
||||
4. **The device connects** through the router's AmneziaWG server, and Dawnline
|
||||
lets through what that person may reach, counts their traffic and keeps to
|
||||
their limits.
|
||||
|
||||
## 📸 A closer look
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/overview.png" alt="Overview: who is online, speed, the last 30 days and where people connect from" width="720">
|
||||
<br>
|
||||
<sub><b>Overview</b>: who is online, speed now, the last 30 days and a map of where people connect from.</sub>
|
||||
</p>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%" valign="top">
|
||||
<img alt="People: everyone on the server, with their devices, data and state" src="docs/screenshots/people.png">
|
||||
<p align="center"><sub><b>People</b>: online, ending soon, over the limit, outside their hours, paused.</sub></p>
|
||||
</td>
|
||||
<td width="50%" valign="top">
|
||||
<img alt="A person: their devices, traffic, places and limits" src="docs/screenshots/person.png">
|
||||
<p align="center"><sub><b>A person</b>: their devices, traffic, places and limits.</sub></p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
| | What Dawnline needs |
|
||||
|---|---|
|
||||
|  |  |
|
||||
| **OpenWrt** | 24.10 (opkg, `.ipk`) or 25.12 (apk, `.apk`) |
|
||||
| **AmneziaWG** | `kmod-amneziawg`, `amneziawg-tools`, `luci-proto-amneziawg`: the installer adds a build made for your firmware when they are missing |
|
||||
| **Free flash** | about 2 MB |
|
||||
|
||||
| Personal portal | Home network access |
|
||||
|---|---|
|
||||
|  |  |
|
||||
|
||||
## Features
|
||||
|
||||
- **People, not peers.** One card per person with device chips, live status,
|
||||
traffic, end date and data limit. Add a person, send them the link or the
|
||||
invite card (QR code), and they do the rest.
|
||||
- **Personal portal.** Every person gets a link made of three words
|
||||
(`https://vpn.example.com/kamiro-telosu-bavine`). The link is the key: no
|
||||
accounts, no sessions, and a new link locks the old one out at once. People
|
||||
add, rename and remove their devices and get each one as a QR code,
|
||||
"Open in AmneziaVPN" (`vpn://`), a key or a `.conf` file. They cannot change
|
||||
access or limits. Links work on the portal's own port with a Let's Encrypt
|
||||
certificate (via ACME), several addresses at once (a Cloudflare-proxied name,
|
||||
a plain IP), the same link at home, and wrong links can redirect to your
|
||||
website. Behind Cloudflare, pick a port it proxies (2053, 2083, 2087, 2096 or
|
||||
8443).
|
||||
- **Access per person**, enforced in an `inet dawnline` nftables table on the
|
||||
tunnel interface: home network only, internet only, or both, and optionally
|
||||
only some home networks or home services (picked from the devices the router
|
||||
sees over DHCP). Devices of different people reach each other never, always,
|
||||
or within circles (family sees family, guests see guests). "Who reaches what"
|
||||
sums up the rules and "Check access" walks them step by step for a device
|
||||
and an address.
|
||||
- **Limits.** End dates (pause, keep, or remove devices when they pass), monthly
|
||||
or total data limits, allowed hours, pause anyone. Devices
|
||||
drop off the tunnel at once (`awg syncconf`, no interface restart).
|
||||
- **Disguise presets** for AmneziaWG obfuscation (junk packets,
|
||||
header and padding parameters), with what each preset needs from the apps.
|
||||
- **Internet like a home device.** Tunnel clients' internet traffic enters the
|
||||
router from the LAN, through a small network namespace on the LAN bridge
|
||||
(needs `kmod-veth`). Whatever handles LAN traffic on the router (proxies, DPI
|
||||
bypass, DNS filters, the `lan` zone) handles VPN clients too, with no
|
||||
per-tool integration.
|
||||
- **Overview.** Who is online with what, speed now, today and the last 30 days,
|
||||
and a map of where people connect from (city level).
|
||||
- **Diagnostics.** Health checks with one-click fixes, including the ones that
|
||||
matter for reaching the portal from outside (DNS, port forwards, reply
|
||||
routing behind proxies such as SSClash/Mihomo, certificate coverage). A
|
||||
watchdog checks the tunnels, access rules, portal, resolver and LuCI link
|
||||
every minute and repairs them on its own (a cron job looks after the agent
|
||||
itself). One log holds people's activity and the service log: tunnel starts
|
||||
and stops with netifd's reasons, repairs and errors (`dawnline log` on the
|
||||
router).
|
||||
- **Updates.** Dawnline itself, AmneziaWG builds for your firmware (choose
|
||||
between [Slava-Shchipunov](https://github.com/Slava-Shchipunov/awg-openwrt)
|
||||
and [2Grey](https://github.com/2Grey/awg-openwrt), AmneziaWG 2.0 or 3.1), and
|
||||
the few OpenWrt packages Dawnline adds.
|
||||
- **Backups** nightly and before risky operations, JSON export/import to move
|
||||
to another router.
|
||||
|
||||
## Requirements
|
||||
|
||||
- OpenWrt **24.10** (opkg, `.ipk`) or **25.12** (apk, `.apk`)
|
||||
- AmneziaWG (`kmod-amneziawg`, `amneziawg-tools`, `luci-proto-amneziawg`):
|
||||
the installer adds a build made for your firmware when it is missing
|
||||
- About 2 MB of free flash
|
||||
|
||||
## Install
|
||||
|
||||
On the router:
|
||||
## 📥 Install
|
||||
|
||||
```sh
|
||||
sh -c "$(wget -qO- https://raw.githubusercontent.com/tickcount/luci-app-dawnline/main/install.sh)"
|
||||
@@ -90,17 +184,21 @@ sh -c "$(wget -qO- https://raw.githubusercontent.com/tickcount/luci-app-dawnline
|
||||
|
||||
The installer checks the firmware, the clock, free space and DNS, lets you pick
|
||||
a release (the latest is the default), shows the plan and asks before it
|
||||
changes anything. It downloads the Dawnline package for your package manager,
|
||||
checks it against `sha256sums.txt`, installs AmneziaWG built for your firmware
|
||||
if it is missing, then installs Dawnline with its dependencies and checks that
|
||||
LuCI can reach it. Then open **LuCI → Network → Dawnline** and run the setup
|
||||
wizard.
|
||||
changes anything. It downloads the package for your package manager, checks it
|
||||
against `sha256sums.txt`, installs AmneziaWG built for your firmware if it is
|
||||
missing, then installs Dawnline and checks that LuCI can reach it.
|
||||
|
||||
Before changing anything it saves `/etc/config/{dawnline,network,firewall,dhcp,uhttpd}`
|
||||
and the service state to `/etc/dawnline/installer-backups/` (the newest three
|
||||
are kept); if a step fails, it puts them back. Packages are not rolled back: to
|
||||
return to an older release, run the installer with `--tag`. Everything it does
|
||||
is logged to `/tmp/dawnline-install.log`.
|
||||
> [!NOTE]
|
||||
> Before changing anything it saves `/etc/config/{dawnline,network,firewall,dhcp,uhttpd}`
|
||||
> and the service state to `/etc/dawnline/installer-backups/` (the newest three
|
||||
> are kept), and puts them back if a step fails. Packages are not rolled back:
|
||||
> to return to an older release, run the installer with `--tag`. Everything it
|
||||
> does is logged to `/tmp/dawnline-install.log`.
|
||||
|
||||
<details>
|
||||
<summary><b>Installer options</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
With options, download it first:
|
||||
|
||||
@@ -117,39 +215,64 @@ sh /tmp/dawnline-install.sh --awg grey # AmneziaWG from 2Grey
|
||||
| `-n`, `--dry-run` | Check the system, resolve, download and verify the release; change nothing |
|
||||
| `-v`, `--verbose` / `-q`, `--quiet` | More detail / only warnings and errors |
|
||||
| `--tag X.Y.Z` | A given release (`sh install.sh 0.3.1` works too) |
|
||||
| `--awg auto\|slava\|grey\|skip` | Where AmneziaWG comes from when it is missing: [Slava-Shchipunov](https://github.com/Slava-Shchipunov/awg-openwrt), then [2Grey](https://github.com/2Grey/awg-openwrt) (`auto`, the default), only one of them, or not at all (install it later from **Dawnline → Updates**). `DAWNLINE_AWG` does the same |
|
||||
| `--awg auto\|slava\|grey\|skip` | Where AmneziaWG comes from when it is missing: [Slava-Shchipunov], then [2Grey] (`auto`, the default), only one of them, or not at all (install it later from **Dawnline → Updates**). `DAWNLINE_AWG` does the same |
|
||||
| `--no-awg` | Same as `--awg skip` |
|
||||
|
||||
When GitHub is slow or blocked, the installer retries downloads through
|
||||
`ghfast.top` and `gh-proxy.com` on its own. To fetch the installer itself
|
||||
through a mirror:
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>When GitHub is slow or blocked</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
The installer retries downloads through `ghfast.top` and `gh-proxy.com` on its
|
||||
own. To fetch the installer itself through a mirror:
|
||||
|
||||
```sh
|
||||
sh -c "$(wget -qO- https://cdn.jsdelivr.net/gh/tickcount/luci-app-dawnline@main/install.sh)"
|
||||
sh -c "$(wget -qO- https://ghfast.top/https://raw.githubusercontent.com/tickcount/luci-app-dawnline/main/install.sh)"
|
||||
```
|
||||
|
||||
By hand, from a [release](https://github.com/tickcount/luci-app-dawnline/releases):
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Installing by hand</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
From a [release](https://github.com/tickcount/luci-app-dawnline/releases):
|
||||
|
||||
```sh
|
||||
opkg update && opkg install ./luci-app-dawnline-0.1.0.ipk # OpenWrt 24.10
|
||||
apk update && apk add --allow-untrusted ./luci-app-dawnline-0.1.0.apk # OpenWrt 25.12
|
||||
```
|
||||
|
||||
**Upgrade** from **Dawnline → Updates**, or run the installer again. Settings,
|
||||
keys and history are kept, and a backup is made first.
|
||||
</details>
|
||||
|
||||
**Remove** on the router:
|
||||
**Upgrade** from <kbd>Dawnline</kbd> › <kbd>Updates</kbd>, or run the installer
|
||||
again. Settings, keys and history are kept, and a backup is made first.
|
||||
|
||||
### Remove
|
||||
|
||||
```sh
|
||||
sh -c "$(wget -qO- https://raw.githubusercontent.com/tickcount/luci-app-dawnline/main/uninstall.sh)"
|
||||
```
|
||||
|
||||
It backs up the configuration to `/etc/dawnline/backups`, runs Dawnline's own
|
||||
removal (the same as **Settings → Remove Dawnline from this router**), removes
|
||||
the package and cleans up what is left. AmneziaWG stays installed, since other
|
||||
tunnels may use it. After installing Dawnline again, restore the backup in
|
||||
**Settings → Backups**. With options, download it first:
|
||||
removal (the same as <kbd>Settings</kbd> › <kbd>Remove Dawnline from this router</kbd>),
|
||||
removes the package and cleans up what is left. After installing Dawnline
|
||||
again, restore the backup in <kbd>Settings</kbd> › <kbd>Backups</kbd>.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> AmneziaWG stays installed, since other tunnels may use it. Add `--remove-awg`
|
||||
> to take it away too.
|
||||
|
||||
<details>
|
||||
<summary><b>Uninstaller options</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
With options, download it first:
|
||||
|
||||
```sh
|
||||
wget -O /tmp/dawnline-uninstall.sh https://raw.githubusercontent.com/tickcount/luci-app-dawnline/main/uninstall.sh
|
||||
@@ -163,25 +286,83 @@ sh /tmp/dawnline-uninstall.sh --dry-run
|
||||
| `--remove-awg` | Also remove AmneziaWG, unless another interface still uses it (`--keep-awg`, the default, keeps it) |
|
||||
| `-n`, `--dry-run` | Show what would be removed; change nothing |
|
||||
|
||||
By hand: **Settings → Remove Dawnline from this router** (keeps a backup), then
|
||||
`opkg remove luci-app-dawnline` or `apk del luci-app-dawnline`.
|
||||
By hand: <kbd>Settings</kbd> › <kbd>Remove Dawnline from this router</kbd>
|
||||
(keeps a backup), then `opkg remove luci-app-dawnline` or
|
||||
`apk del luci-app-dawnline`.
|
||||
|
||||
## What Dawnline changes on the router
|
||||
</details>
|
||||
|
||||
## ❓ FAQ
|
||||
|
||||
<details>
|
||||
<summary><b>Which apps do people use?</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
AmneziaVPN or AmneziaWG on phones and computers, and plain WireGuard when the
|
||||
disguise is off. The portal shows each person the app for their system and how
|
||||
to add the connection in it.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>What happens when someone loses their link?</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
Make a new one on their page. The old link stops working at once; their devices
|
||||
keep working, unless you tick the ones to remove with it.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Does it touch the rest of my router?</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
Only what it created, and `dawnline teardown` removes all of it. The full list
|
||||
is under [What Dawnline changes on the router](#-what-dawnline-changes-on-the-router).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>How do I move to another router?</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
<kbd>Export JSON</kbd> in <kbd>Settings</kbd> › <kbd>Backups</kbd> on the old
|
||||
one, install Dawnline on the new one and import the file there.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Where do the places on the map come from?</b></summary>
|
||||
|
||||
<br>
|
||||
|
||||
From the address a device connects from, looked up at city level and cached on
|
||||
the router. It can be turned off in <kbd>Settings</kbd>.
|
||||
|
||||
</details>
|
||||
|
||||
## 🧾 What Dawnline changes on the router
|
||||
|
||||
Only objects it created: network interfaces tagged `_dawnline`, firewall
|
||||
sections named `dawnline_*`, the `inet dawnline` nft table, `/tmp/hosts/dawnline`,
|
||||
the `dawnline` network namespace with its two veth links (`dlx0`, `dll0`, the
|
||||
latter a port of the LAN bridge), policy rules for the tunnel interfaces with
|
||||
one routing table, a second dnsmasq instance on port 5354
|
||||
(`/var/etc/dawnline-dns.conf`), a cron line for the agent's heartbeat check
|
||||
and, while the portal is on, a uhttpd instance for it. `dawnline teardown`
|
||||
removes all of them.
|
||||
latter a port of the LAN bridge, which needs `kmod-veth`), policy rules for the
|
||||
tunnel interfaces with one routing table, a second dnsmasq instance on port
|
||||
5354 (`/var/etc/dawnline-dns.conf`), a cron line for the agent's heartbeat
|
||||
check and, while the portal is on, a uhttpd instance for it.
|
||||
`dawnline teardown` removes all of them.
|
||||
|
||||
Data lives in `/etc/config/dawnline` (mode 0600, contains private keys) and
|
||||
`/etc/dawnline/` (usage, events, issued configurations, backups). Live counters
|
||||
are kept in `/var/run/dawnline` and flushed to flash at most hourly.
|
||||
are kept in `/var/run/dawnline` and flushed to flash at most hourly. Access
|
||||
changes reach the tunnel with `awg syncconf`, without restarting the interface;
|
||||
`dawnline log` on the router shows the service log.
|
||||
|
||||
## Development
|
||||
## 🛠️ Development
|
||||
|
||||
```
|
||||
package/luci-app-dawnline/
|
||||
@@ -203,18 +384,25 @@ npm ci
|
||||
npm run format # Prettier
|
||||
npm run ci # format check, types, tests, minified bundles
|
||||
|
||||
scripts/lint-ucode.py # static ucode checks
|
||||
scripts/check-ucode.sh root@router # compile every ucode file on a router
|
||||
scripts/deploy.sh root@router # install the working tree (backs up configs first)
|
||||
scripts/build-packages.sh all # .ipk and .apk with the OpenWrt SDK in Docker
|
||||
scripts/capture-screenshots.mjs # capture docs/screenshots/raw/*.png from a router
|
||||
scripts/frame-screenshots.py # frame them for this README
|
||||
scripts/lint-ucode.py # static ucode checks
|
||||
scripts/check-ucode.sh root@router # compile every ucode file on a router
|
||||
scripts/deploy.sh root@router # install the working tree (backs up configs first)
|
||||
scripts/build-packages.sh all # .ipk and .apk with the OpenWrt SDK in Docker
|
||||
scripts/capture-screenshots.mjs --demo # README screenshots from a router, a demo cast in place of its people
|
||||
scripts/frame-screenshots.py # frame them for this README
|
||||
```
|
||||
|
||||
The web bundles are committed: CI fails when they are out of date. Pushing a
|
||||
tag `vX.Y.Z` (matching `PKG_VERSION`) builds both packages with the OpenWrt SDK
|
||||
and publishes a release with `sha256sums.txt`.
|
||||
|
||||
## License
|
||||
---
|
||||
|
||||
[MIT](LICENSE)
|
||||
<div align="center">
|
||||
<sub>Made for OpenWrt · <a href="LICENSE">MIT license</a> · <a href="#readme">Back to top ↑</a></sub>
|
||||
</div>
|
||||
|
||||
[AmneziaWG]: https://docs.amnezia.org/
|
||||
[Liminal]: https://github.com/tickcount/openwrt-liminal
|
||||
[Slava-Shchipunov]: https://github.com/Slava-Shchipunov/awg-openwrt
|
||||
[2Grey]: https://github.com/2Grey/awg-openwrt
|
||||
Reference in new issue
Block a user