Skip to content

Commit fa489e4

Browse files
committed
docs(website): 补全中英文档并更新安装/快速上手内容
- 新增中文 browser-extension、installation、interface、settings、 ed2k、ftp、hls-dash 等页面 - 新增英文 interface、settings、ed2k 页面 - 更新 quickstart、extension install/usage、bittorrent 等既有页面
1 parent 05ee9be commit fa489e4

25 files changed

Lines changed: 1142 additions & 49 deletions

File tree

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,73 @@
11
---
22
title: Install the Extension
3-
description: Set up the FluxDown browser extension.
3+
description: Add the FluxDown browser extension for Chrome or Firefox and connect it to the desktop app.
44
section: browser-extension
55
order: 1
66
---
77

8-
The FluxDown extension integrates the download manager with Chrome and Firefox.
8+
The FluxDown browser extension hooks into Chrome's or Firefox's download pipeline and hands matching downloads off to the FluxDown desktop app for high-speed, multi-threaded downloading. The extension can't download anything by itself — it needs the [desktop app](/docs/en/getting-started/installation/) installed, and started at least once. Install order doesn't matter: whichever piece you set up second will find the other automatically.
99

10-
> This page is a placeholder — full documentation is coming soon.
10+
Chrome (Manifest V3) and Firefox are supported directly. The desktop app also registers itself for Microsoft Edge, and other Chromium-based browsers (Brave, Vivaldi, Opera, …) generally pick up the same registration Chrome uses, so loading the Chrome package manually (see below) works there too.
11+
12+
## Install from the Chrome Web Store
13+
14+
1. Open the [FluxDown extension page](https://chromewebstore.google.com/detail/fluxdown/meleenglfggcmcajknpeeeiobnpfmahc) on the Chrome Web Store.
15+
2. Click **Add to Chrome**, then **Add extension** in the confirmation dialog.
16+
3. Pin the extension (puzzle-piece icon in the toolbar → the pin next to FluxDown) so its status badge is always one click away.
17+
18+
<!-- TODO(screenshot): Chrome Web Store listing page for FluxDown with the "Add to Chrome" button highlighted -->
19+
20+
## Install from Firefox Add-ons
21+
22+
1. Open the [FluxDown add-on page](https://addons.mozilla.org/firefox/addon/fluxdown/) on addons.mozilla.org.
23+
2. Click **Add to Firefox**, then **Add** in the permissions prompt.
24+
3. Firefox 140 or later is required. If the install button is greyed out, update Firefox first.
25+
26+
## Manual install from a GitHub Release
27+
28+
Use this if you want a build newer than what's currently live on a store, or your organization only allows manually reviewed extensions.
29+
30+
**Chrome (and other Chromium browsers):**
31+
32+
1. Download `FluxDown-<version>-chrome.zip` from the [latest GitHub Release](https://github.com/zerx-lab/fluxdown/releases/latest) and unzip it somewhere permanent — Chrome loads the extension from that folder directly, not from the zip.
33+
2. Open `chrome://extensions` and turn on **Developer mode** (top-right toggle).
34+
3. Click **Load unpacked** and select the unzipped folder.
35+
4. The unpacked build keeps the same extension identity as the Chrome Web Store build, so it connects to the desktop app exactly the same way — no extra setup needed.
36+
37+
**Firefox:**
38+
39+
Release builds ship as a signed `FluxDown-<version>-firefox.xpi`, which a regular (non-Developer-Edition) Firefox installs without extra flags:
40+
41+
1. Download `FluxDown-<version>-firefox.xpi` from the same Release.
42+
2. Open `about:addons`, click the gear icon → **Install Add-on From File…**, and select the downloaded `.xpi`.
43+
44+
<!-- TODO(screenshot): chrome://extensions with Developer mode enabled and the Load unpacked button visible -->
45+
46+
## How the extension talks to the desktop app
47+
48+
The extension never opens a network connection to reach FluxDown. It uses the browser's Native Messaging mechanism: the browser launches a small relay process that the desktop app registered on your machine, and the extension exchanges messages with it over stdin/stdout. That relay forwards everything to the already-running desktop app over a local, OS-native channel — a Named Pipe on Windows, a Unix domain socket on Linux and macOS. The desktop app sets up this registration itself the first time it starts, which is why **it must be installed and opened at least once before the extension can do anything**.
49+
50+
## Confirm the connection
51+
52+
Click the FluxDown icon in the toolbar to open the popup. The badge in its top-right corner shows the live connection state:
53+
54+
| Badge | Meaning |
55+
| --- | --- |
56+
| Checking... (grey, pulsing) | The popup just opened and is pinging the desktop app. |
57+
| Connected (green dot) | The desktop app answered — downloads will be handed off normally. |
58+
| Disconnected (red dot) | The desktop app didn't answer in time — downloads fall back to the plain browser download until it does. |
59+
60+
Opening the popup only *checks* the connection; it doesn't start the app on its own — a plain connectivity check is intentionally not allowed to launch anything. If the badge reads Disconnected, either start FluxDown yourself, or click any download link: the extension launches the app automatically the moment it actually needs to hand off a file.
61+
62+
<!-- TODO(screenshot): extension popup header showing the Connected status badge -->
63+
64+
## Troubleshooting
65+
66+
| Symptom | What to check |
67+
| --- | --- |
68+
| Badge stuck on Disconnected | Confirm the FluxDown desktop app has been installed and opened at least once — the extension can't reach an app that has never registered itself. |
69+
| Badge only turns Connected after a download | Expected. The app auto-launches on the first real download request, not when you merely open the popup. Give it a few seconds — usually well under 10 — then reopen the popup to re-check. |
70+
| Downloads keep falling back to the browser with a "FluxDown app not detected" notification | The app was unreachable when a download was attempted. Make sure FluxDown is running and try again; the extension stops falling back automatically as soon as it can reach the app, and won't repeat the notification for about 30 seconds either way. |
71+
| Nothing changes after reinstalling or updating the desktop app | Restart the browser once. The desktop app registers its Native Messaging manifest on startup, and the browser only rereads that registration when it (re)launches. |
72+
| Security software seems to block the connection | Native Messaging runs over a local pipe/socket rather than the network, so antivirus or sandboxing tools that intercept inter-process communication can still interfere. Allow FluxDown if you run this kind of software. |
73+
| A specific site is never intercepted | Check whether its domain was added to **Excluded Domains** in the popup — see [Using the Extension](/docs/en/browser-extension/usage/). |
Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,79 @@
11
---
22
title: Using the Extension
3-
description: Interception, sniffing and bypass tips.
3+
description: How download interception, interception modes, resource sniffing, and the popup controls work.
44
section: browser-extension
55
order: 2
66
---
77

8-
Learn how download interception works, how to sniff media resources, and how to bypass interception with Alt+Click.
8+
## How download interception works
99

10-
> This page is a placeholder — full documentation is coming soon.
10+
When **Download Intercept** is on (it is by default) and you click something the extension recognizes as a downloadable file, FluxDown steps in before the browser's own download UI appears — the native "Save As" prompt and download bar stay hidden — and hands the request to the FluxDown desktop app over the local connection described in [Install the Extension](/docs/en/browser-extension/install/). By default the desktop app then opens its own quick-download dialog so you can confirm the filename, save folder, and thread count before the transfer starts. This works the same way whether the download came from a plain link, a JavaScript redirect, or a form submission — the extension catches it regardless of how the page triggered it.
11+
12+
If the desktop app can't be reached at the moment a download is attempted, the extension automatically lets the browser download the file normally instead of blocking it, and shows one "FluxDown app not detected" notification. It won't repeat that notification for further downloads for about 30 seconds, and it silently resumes intercepting as soon as the app answers again.
13+
14+
<!-- TODO(screenshot): a browser download click flowing into FluxDown's quick-download confirmation dialog -->
15+
16+
## Choose an interception mode
17+
18+
Open the popup → **Quick Settings****Intercept Mode**:
19+
20+
| Mode | Label in the popup | Behavior |
21+
| --- | --- | --- |
22+
| `smart` | Smart *(default)* | Combines file extension, MIME type, and file size. Falls back to intercepting anything the browser itself already treats as a download, unless it looks like an ordinary web resource (HTML/CSS/JS, small inline images). |
23+
| `extension` | Extension Only | Only intercepts when the filename or URL ends in one of the extensions configured below. Nothing else is considered. |
24+
| `all` | Intercept All | Intercepts every download except URLs on an excluded domain. |
25+
26+
Whichever mode is active, two checks always run first: excluded domains are skipped outright, and files below **Min File Size** are left to the browser.
27+
28+
## Fine-tune what gets intercepted
29+
30+
- **Min File Size** (Quick Settings): `No limit`, `100 KB`, `512 KB`, `1 MB`, `5 MB`, or `10 MB`. Downloads smaller than this are left to the browser — handy for keeping tiny files like icons or snippets out of FluxDown. It only applies when the browser reports a size; downloads with an unknown size are still evaluated normally.
31+
- **Intercept File Types**: the extension ships with roughly three dozen extensions pre-listed — archives, installers, disk images, video, audio, office documents, plus `.apk`, `.ipa`, and `.torrent`. Click the **+** button to add one (`pdf` or `.pdf` both work) and the **×** on a tag to remove it. This list is the only thing that matters in Extension Only mode; in Smart mode it's one of several signals.
32+
- **Excluded Domains**: downloads from a listed domain are always left to the browser, regardless of mode. Click **+** to type a domain in manually, or **Current Site** to exclude whatever domain the active tab is on with one click. Remove one with the **×** next to it.
33+
34+
<!-- TODO(screenshot): popup Intercept File Types and Excluded Domains sections with a few entries added -->
35+
36+
## Turn interception on or off
37+
38+
The **Download Intercept** toggle at the top of the popup is the master switch. Turn it off and every download goes back through the browser's normal flow, including the confirmation dialog interception would otherwise suppress.
39+
40+
You don't need to open the popup to flip it: press **Alt+Shift+D** anywhere in the browser to toggle interception instantly, confirmed by a brief system notification. That's the fastest way to grab one file with the browser's own downloader — flip it off, click the link, flip it back on — for example on a site where FluxDown's detection guesses wrong for that one link. (Remap the shortcut from the browser's extension-shortcuts settings page if Alt+Shift+D collides with something else.) For a site you never want intercepted, add it to **Excluded Domains** instead — it's permanent and doesn't rely on remembering to switch anything back on.
41+
42+
The toolbar icon itself reflects the current state too (it dims when interception is off), so you can tell at a glance without opening the popup.
43+
44+
## Send links, images, and media to FluxDown from the right-click menu
45+
46+
Right-clicking exposes FluxDown entries independent of the Download Intercept toggle — they work even while interception is off:
47+
48+
| Right-click target | Menu item |
49+
| --- | --- |
50+
| A link | Download this link with FluxDown |
51+
| An image | Download this image with FluxDown |
52+
| A video or audio element | Download this video/audio with FluxDown |
53+
| Empty page area | Download this page with FluxDown |
54+
55+
The last option sends the current page's own URL to FluxDown — useful when the "page" the browser opened is actually a raw file, like a video or PDF viewed directly in a tab.
56+
57+
## Detect media and downloadable resources on a page
58+
59+
FluxDown continuously scans each page for downloadable resources — video and audio elements, streaming manifests (HLS `.m3u8`, DASH `.mpd`), subtitles, and links or network responses that look like files — combining a DOM scan with live monitoring of the page's network activity. Detected items are classified (video, audio, document, archive, image, torrent, stream, subtitle, magnet link, other) and lightly filtered, so the list stays about real downloadable content instead of every icon, ad ping, or preload fragment: very small files are dropped per type, tracker/analytics traffic is ignored, and raw streaming segments stay hidden unless they're large enough to plausibly be a real file on their own. Image sniffing is off by default, so ordinary page images don't clutter the results.
60+
61+
Two pieces of on-page UI surface what's found:
62+
63+
- **Floating ball** — a small draggable dot that docks to the left or right edge of the page (drag it and let go; it snaps to the nearest edge) and shows a badge with the number of resources found. Click it to open the resource panel. Hide it from the popup's **Floating Ball** toggle, or from the eye icon in the resource panel's own header, if you'd rather not see it — detection and the toolbar badge keep working either way.
64+
- **Resource panel** — opens next to the floating ball, listing detected resources grouped into tabs (All, Video, Audio, Docs, Archive, Stream, Subtitle, Magnet, Other) with per-tab counts. Check individual items — or use **Select All** — and click the **Download** button to send everything checked to FluxDown in one batch, or use the small download button on a single row to grab just that one.
65+
66+
Hovering over a video element also pops up a small floating download button for that video specifically, without opening the panel.
67+
68+
The extension's toolbar icon shows a numeric badge with the resource count for the current tab, so you know something downloadable is on the page without opening anything.
69+
70+
<!-- TODO(screenshot): floating ball docked to the page edge next to an open resource panel with tabs and a batch selection -->
71+
72+
## Track today's stats
73+
74+
The popup's **Today's Stats** section shows two running counters for the current day: **Intercepted** (downloads successfully handed off to FluxDown) and **Failed** (hand-offs that didn't go through, typically because the desktop app was unreachable at the time). Both reset automatically at the start of a new day, or immediately if you click **Reset Stats** in the popup's footer.
75+
76+
## Switch theme and language
77+
78+
- **Theme** — the sun/moon icon in the header toggles the popup between light and dark. Until you click it, the popup follows your OS theme automatically.
79+
- **Language** — the language button in the header (showing `EN` or ``) switches the popup and the on-page floating ball/resource panel between English and Chinese together. FluxDown picks a default from your browser's language the first time it runs; using this button overrides that choice and is remembered from then on.
Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,63 @@
11
---
22
title: Installation
3-
description: Install FluxDown on Windows.
3+
description: Install FluxDown on Windows, macOS, or Linux and get it running for the first time.
44
section: getting-started
55
order: 1
66
---
77

8-
FluxDown currently ships for **Windows**, with macOS and Linux builds planned.
8+
FluxDown ships full-featured native builds for Windows, macOS, and Linux. Every package contains the same Rust download engine and the same interface — there's no "lite" edition and no account to create.
99

10-
> This page is a placeholder — the full installation guide is coming soon.
10+
## System Requirements
1111

12-
## Download
12+
| Platform | Requirement |
13+
|---|---|
14+
| Windows | Windows 10 (64-bit) or later, x64 or ARM64 |
15+
| macOS | macOS 10.15 (Catalina) or later, Apple Silicon or Intel |
16+
| Linux | A 64-bit desktop distribution with a modern GTK3 stack |
1317

14-
Grab the latest installer from the [download page](https://fluxdown.zerx.dev/#download).
18+
## Windows
1519

16-
## System requirements
20+
Grab a build from the [download page](/#download). Two options, both offered for x64 and ARM64:
1721

18-
- Windows 10 or later (64-bit)
22+
- **Installer**`FluxDown-<version>-setup.exe`. Runs the standard Inno Setup wizard and installs for the current user only (no admin rights required). During setup you can optionally check boxes to create a desktop shortcut, launch FluxDown at system startup, and associate `.torrent` files with FluxDown — all unchecked by default.
23+
- **Portable**`FluxDown-<version>-windows-<arch>-portable.zip`. Extract anywhere and run `flux_down.exe`. Nothing is written outside the extracted folder except whatever you opt into at first launch.
24+
25+
The build isn't code-signed, so Windows SmartScreen may flag it as coming from an "unknown publisher" the first time you run it. Click **More info → Run anyway** to continue.
26+
27+
## macOS
28+
29+
- **DMG**`FluxDown-<version>-macos-<arch>.dmg` (`arm64` for Apple Silicon, `x64` for Intel). Open it and drag FluxDown into **Applications**.
30+
- **Portable**`FluxDown-<version>-macos-<arch>.tar.gz`. Extract it and run the app bundle directly.
31+
32+
The build isn't notarized, so Gatekeeper blocks the first launch with an "unidentified developer" warning. Right-click (or Control-click) the app and choose **Open**, or approve it under **System Settings → Privacy & Security → Open Anyway**.
33+
34+
## Linux
35+
36+
All Linux packages are x64:
37+
38+
- **AppImage**`FluxDown-<version>-linux-x64.AppImage`. Make it executable (`chmod +x`) and run it. Distributions released in the last few years may need `libfuse2` installed for AppImages to launch.
39+
- **deb**`FluxDown-<version>-linux-x64.deb`, for Debian/Ubuntu and derivatives: `sudo apt install ./FluxDown-<version>-linux-x64.deb`.
40+
- **Arch package**`FluxDown-<version>-linux-x64.pkg.tar.zst`: `sudo pacman -U FluxDown-<version>-linux-x64.pkg.tar.zst`.
41+
- **Portable**`FluxDown-<version>-linux-x64.tar.gz`. Extract it and run the bundled binary.
42+
43+
## First Launch
44+
45+
FluxDown quietly wires itself into the OS the first time it starts, so links and files from other apps reach it without extra setup:
46+
47+
- **`fluxdown://` protocol** — registered automatically on every startup so the browser extension and other apps can hand off downloads to FluxDown.
48+
- **Native Messaging Host** — registered automatically so the browser extension can talk to FluxDown over Native Messaging (a Windows Named Pipe or a Linux/macOS Unix socket).
49+
- **`.torrent` file association***not* automatic. If you didn't check the installer's association box, FluxDown shows a one-time dialog on first launch asking whether to make it the default `.torrent` handler. Accept, dismiss, or change your mind later in **Settings → General → Associate .torrent Files**.
50+
51+
<!-- TODO(screenshot): 首次启动的 .torrent 文件关联提示对话框 -->
52+
53+
## Automatic Updates
54+
55+
Five seconds after startup, FluxDown silently checks GitHub Releases for a newer version in the background (this can be turned off in **Settings → About → Auto-check for Updates**). If an update is available, a dialog shows the changelog with **Update Now** and **Remind Me Later**. You can trigger a manual check any time from **Settings → About**, or from the version indicator at the bottom of the sidebar.
56+
57+
## Uninstalling
58+
59+
- **Windows (installer)** — open **Settings → Apps → Installed apps**, find FluxDown, and uninstall. For a portable install, just delete the extracted folder.
60+
- **macOS** — drag FluxDown from **Applications** to the Trash.
61+
- **Linux**`sudo apt remove fluxdown` (deb), `sudo pacman -R fluxdown` (Arch), or delete the AppImage/extracted folder.
62+
63+
Uninstalling only removes the application itself — files you've already downloaded stay wherever you saved them.

0 commit comments

Comments
 (0)