dosyago / dn

💾 dn - offline full-text search and archiving for your Chromium-based browser.
https://localhost:22120
Other
3.78k stars 145 forks source link
archive archiver disk internet web-archive web-browsing

:floppy_disk: DownloadNet (dn) – Your Offline Web Archive with Full Text Search

source lines of code binary downloads visitors+++ DownloadNet slogan

Imagine a world where everything you browse online is saved and accessible, even when you're offline. That's the magic of DownloadNet (dn).

Why dn?

Getting Started

1. Download a Pre-built Binary (Simplest Option) :package:

If you’re not familiar with Git or npm, this is the easiest way to get started:

  1. Go to the Releases Page
  2. Download the binary for your operating system (e.g., Windows, macOS, Linux).
  3. Run the downloaded file. That’s it! You’re ready to start archiving.

2. Install via npm (For Users Familiar with Command Line) :rocket:

  1. Open your terminal (Command Prompt on Windows, Terminal on macOS/Linux).
  2. Install dn globally with npm:
    npm i -g downloadnet@latest
  3. Start dn by typing:
    dn

[!NOTE] Make sure you have Node.js installed before attempting to use npm. If you're new to npm, see the next section for guidance.

3. New to npm? No Problem! :bulb:

If you’ve never used npm before, don’t worry—it’s easy to get started.

To install nvm:

  1. Visit the nvm GitHub page for installation instructions.
  2. Follow the steps to install nvm on your system.
  3. Once nvm is installed, install the latest version of Node.js by running:
    nvm install node
  4. Now you can install dn using npm as described in the section above!

[!TIP] Using nvm allows you to easily switch between Node.js versions and manage your environment more effectively.

4. Build Your Own Binary (For Developers or Power Users) :hammer_and_wrench:

If you like to tinker and want to build the binary yourself, here’s how:

  1. Download Git: If you haven’t used Git before, download and install it from git-scm.com.

  2. Clone the Repository:

    git clone https://github.com/dosyago/DownloadNet.git
  3. Navigate to the Project Directory:

    cd DownloadNet
  4. Install Dependencies:

    npm i
  5. Build the Binary:

    npm run build
  6. Find Your Binary: The newly built binary will be in the ./build/bin directory, ready to be executed!

5. Run Directly from the Repository (Quick Start) :runner:

Want to get dn up and running without building a binary? No problem!

  1. Clone the Repository:
    git clone https://github.com/dosyago/DownloadNet.git
  2. Navigate to the Project Directory:
    cd DownloadNet
  3. Install Dependencies:
    npm i
  4. Start dn:
    npm start

And just like that, you’re archiving!

How It Works

dn runs as an intercepting proxy, hooking into your browser's internal fetch cycle. Once you fire up dn, it automatically configures your browser, and you’re good to go. Everything you browse is archived, and you can choose to save everything or just what you bookmark.

Modes:

[!CAUTION] As your archive grows, you may encounter performance issues. If that happens, you can adjust the memory settings by setting environment variables for NODE runtime arguments, like --max-old-space-size.

Accessing Your Archive

Once dn is running, your archive is at your fingertips. Just go to http://localhost:22120 in your browser. Your archive’s control panel opens automatically, and from there, you can search, configure settings, and explore everything you’ve saved.

Minimalistic Interface, Maximum Power

dn’s interface is basic but functional. It’s not about flashy design; it’s about delivering what you need—offline access to the web, as if you were still connected.

Advanced Settings (If Needed)

As your archive grows, you may want to adjust where it's stored, manage memory settings, or blacklist domains you don’t want to archive. All of these settings can be tweaked directly from the control panel or command line.

Get Started Now

With dn, you’ll never lose track of anything you’ve read online. It’s all right there in your own offline archive, fully searchable and always accessible. Whether you're in save mode or serve mode, dn keeps your digital life intact.

:arrow_down: Download | :rocket: Install | :runner: Run | :mag_right: Never Lose Anything Again

Get Started with dn