Skip to content

⚡️⚡️⚡️ Self-hosted collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place.

2.5 KB
Raw Blame

Linkwarden Browser Extension

The Official Browser Extension for Linkwarden.

Features

  • Add and organize new links to Linkwarden with a single click.
  • Upload screenshots of the current page to Linkwarden.
  • Save all tabs in the current window to Linkwarden.
  • Sign in using API key or Username/Password.

Image

Installation

You can get the browser extension from both the Chrome Web Store and Firefox Add-ons:

Chrome Web Store Firefox Add-ons

Issues and Feature Requests

Please report any issues or feature requests by starting the title with "[Browser Extension]" here.

Build From Source

Requirements

  • NodeJS 20.19.x or later
  • Yarn 4.x, enabled with corepack enable
  • Bash
  • Git

Step 1: Clone this repo

Clone this repository by running the following in your terminal:

git clone https://github.com/linkwarden/browser-extension.git

Step 2: Build

Head to the generated folder:

cd browser-extension

And run:

yarn install
yarn build

After the above command, use the /dist folder as an unpacked extension in your browser.

Development

For live reload in Chrome or Firefox:

yarn dev:chrome
yarn dev:firefox

Safari

yarn build:safari

Then Cmd+R to run it, or Product → Archive to build for the App Store.

Cmd+R launches Linkwarden for Safari.app. Launching it registers the extension with Safari.

First run

Safari hides locally built extensions until the developer settings are on:

  1. Safari → Settings → Advanced → Show features for web developers
  2. The new Develop menu → Allow unsigned extensions
  3. Safari → Settings → Extensions → enable Linkwarden

Step 2 resets every time Safari restarts, so expect to repeat it. Steps 1 and 3 are one-time.

Iterating

There is no live reload here, unlike yarn dev:chrome and yarn dev:firefox. The build output is copied into the app extension at compile time, so every change to src/ means yarn build:safari followed by another Cmd+R. Develop against Chrome or Firefox and use Safari to verify, rather than working in it directly.