Skip to content

About

An open source browser extension for adding/managing download tasks to your Synology DiskStation.

Topics

Resources

Stars

280 stars

Watchers

16 watching

Forks

Repository files navigation

NAS Download Manager

An open source browser extension for adding/managing download tasks to your Synology DiskStation.

Donate

🔧 Maintenance Mode 🔧

NAS Download Manager is in maintenance mode. See the announcement for details.

Having an Issue?

If you're here because of an issue with the extension, please check the FAQ first. If you can't find an answer there, feel free to open an issue!

About

NAS Download Manager allows you to add and manage your download tasks on your Synology DiskStation right from your browser. It requires a Synology NAS with DSM version 6 or higher.

Please note that NAS Download Manager is not an official Synology offering.

Features

  • Right-click and download many types of media (<video> and <audio> tags) and files (e.g. .torrent files).
  • Clear all completed tasks with one click.
  • Choose destination folder for new download tasks.
  • View, filter and sort all the current download tasks in the extension popup.
  • Add/pause/resume/remove download tasks in the extension popup.
  • System notifications for completed download tasks.
  • Open some types of links (e.g. magnet:) in the extension rather than a desktop application.

Officially Supported Browsers

Older browsers will not be offered the update, and will stay on the last version that worked for them.

Unsupported Browsers

There are currently no plans to support the following browsers.

  • Safari

Privacy

NAS Download Manager needs your login credentials to communicate with your NAS. It doesn't collect, store or transmit any other information. Read more.

Development

Prerequisites

The Node version is pinned in .nvmrc. Run nvm use if you have nvm.

Actively Developing the Extension

These instructions describe how to build and automatically re-build the assets for the extension for quick iteration during active development. For building, optimizing and packaging the extension for distribution, see the next section.

Please note that while the build tasks will auto-recompile, the browser may not pick up changes automatically. In particular, changes to code running in the extension's background generally requires you to explicitly refresh the extension (for which there is usually a button in the debugging interface). Changes to language support may require you to remove the development extension entirely and re-add it.

  1. Install dependencies.

    npm install
  2. Start a build to watch files and auto-recompile code on change.

    npm run watch
  3. In a second terminal, launch a browser with the extension already installed.

    npm run browser:firefox # or browser:chrome

    This uses web-ext, which opens the browser with the extension loaded and reloads it as files change.

    Each runs with a dedicated directory-local profile created on first use, so the connection settings you enter survive between runs instead of needing to be re-entered every time. Note that this means your NAS password is stored there unencrypted, the same way the browser stores it for the installed extension. Delete the directory to start from a clean slate.

    To load it by hand instead: in Firefox, open about:debugging > This Firefox > Load Temporary Add-on... and select dist/manifest.json; in Chrome, open chrome://extensions > Enable "Developer mode" > Load unpacked > select dist.

Packing the Extension for Distribution

  1. Install dependencies.

    npm install
  2. Build the extension, check it against the validation rules addons.mozilla.org applies, and zip it into a file suitable for distribution.

    npm run package
  3. (Optional) Zip all source code into a file suitable for distribution.

    npm run zip-sources

Translating the Extension

I need help localizing NAS Download Manager! Read in detail about how to localize WebExtensions, or skip to the sections below for short summaries.

Adding a New Language

In order to add the new language, base your translation file off the English messages file.

  1. Copy _locales/en/messages.json into a new file at _locales/<your language code>/messages.json.
  2. Edit the message field in each item with your translation.
  3. In src/common/format.ts, add your language code to TRANSLATED_LOCALES so that relative times ("updated 5 minutes ago") are rendered in it too. A test checks this list against _locales/.
  4. Load (or reload) the extension to test it out. You may need to remove the extension entirely and then re-add it for changes to be reflected.
  5. Open a pull request!

There are automated checks to ensure that you're only defining translated strings that the extension actually uses.

Editing an Existing Language

If you're adding more strings for an incomplete translation, you can use ./scripts/diff-messages <your language code> to get a list of all the entries you need to add to the messages.json in a format that is easily copy-pasted:

$ ./scripts/diff-messages ru
"Badge_shows": {
  "message": "Badge shows",
  "description": "Prefix text for badge-display-type dropdown."
},

About

An open source browser extension for adding/managing download tasks to your Synology DiskStation.

Topics

Resources

Stars

280 stars

Watchers

16 watching

Forks

Releases

Packages

Used by

Contributors

Languages