DOCSEARCHbyAlgolia
Submit Docs

Linkwarden Documentation

website·Indexed 35 days ago

https://docs.linkwarden.app

Documentation for Linkwarden, a collaborative bookmarking tool. Includes guides on usage of links, tags, and collections, self-hosting instructions for NGINX reverse proxies and OIDC SSO, and comprehensive API reference for managing archives, users, and dashboard layouts.

Tokens
21.2K
Snippets
169
Records
226
Agent score
69%

What's inside Linkwarden

  1. Overview of Linkwarden

    Linkwarden is a self-hosted, open-source collaborative bookmark manager designed to collect, read, annotate, and preserve webpages. To prevent data loss from link rot, it automatically saves copies of webpages in multiple formats, ensuring content remains accessible even if the original source is deleted. Key features include a read-it-later experience with highlighting and annotations, as well as collaboration tools for sharing links publicly or working with multiple users.

  2. Use the Linkwarden Dashboard to manage links and collections

    The Linkwarden Dashboard provides a centralized overview of all your Links, Collections, and Tags. It allows users to quickly navigate their saved content and Pin favorite Links for faster access.

  3. Understand Linkwarden seats and link limits

    A seat is a user slot in a Linkwarden subscription. Each seat allows for one invited user. Beyond user access, each seat increases the total link storage capacity for the entire subscription by 30,000 links. For example, a subscription with 3 seats can store up to 90,000 links across all users. Every subscription includes one default seat for the account owner.

  4. Understand Linkwarden core data entities

    Linkwarden organizes data using three primary entities:

    • Link: A bookmark, webpage, or URL.
    • Collection: A folder-like container used to group links. Collections can be shared with teams or the public.
    • Tags: Keyword-based categorizations applied to individual links to enable precise filtering and searching.

    Users are permitted an unlimited number of Links, Tags, and Collections.

  5. Install Linkwarden manually from source

    Manual installation is intended for technical users. Requirements include Git, Node (20+), Yarn (with Corepack enabled), Postgres (16+), Nano, and Monolith.
    # 1. Clone repository
git clone https://github.com/linkwarden/linkwarden.git
cd linkwarden

# 2. Install dependencies
yarn workspaces focus linkwarden @linkwarden/web @linkwarden/worker

# 3. Configure environment
cd linkwarden
cp .env.sample .env
nano .env

# 4. Build and setup database
yarn prisma:generate
yarn web:build
yarn prisma:deploy

# 5. Start the app
yarn concurrently:start

  6. Configure Linkwarden for minimum memory footprint (Bookmarks only)

    To achieve the lowest possible memory footprint (approximately 350 MB idle), disable all preservation and the search engine. This setup requires removing the meilisearch service from your docker-compose.yml file and applying the following environment variables.
    DISABLE_BROWSER=true
MALLOC_ARENA_MAX=2
NODE_OPTIONS=--max-old-space-size=400

  7. Configure Linkwarden browser extension for first-time use

    After installing the extension, a one-time setup is required to connect the extension to your Linkwarden instance. You must provide the following three pieces of information:

    1. Cloud instance address: The URL where your Linkwarden instance is hosted. For the official cloud instance, use https://cloud.linkwarden.app.
    2. Username or Email: The credentials used to create your Linkwarden account.
    3. Password: Your current Linkwarden account password.
    https://cloud.linkwarden.app

  8. Install NGINX and Certbot on Ubuntu

    Install the NGINX web server and Certbot (along with the NGINX plugin) to handle reverse proxying and automated TLS certificate management.
    sudo apt update
sudo apt install -y nginx certbot python3-certbot-nginx

  9. Register a new Linkwarden account

    To create a new account, visit https://cloud.linkwarden.app/register and provide a display name, email address, and password. After signing up, you must click the confirmation link sent to your email to validate the account. This email is the primary method for account recovery and dedicated support.

  10. Run Linkwarden containers as a non-root user

    By default, Linkwarden containers run as root. To limit permissions and ensure data folders are owned by the host user, you can use the user option in Docker Compose. This requires that the mounted host folders (data, pgdata, and meili_data) are owned by the same UID and GID specified in the compose file. On most Linux systems, the first regular user is 1000:1000. You can verify your own IDs using the commands id -u and id -g.

  12. Install Linkwarden PWA on iOS

    To install Linkwarden as a Progressive Web App (PWA) on iOS, use the Safari browser. This allows the application to be used like a native app without an app store download. For self-hosted instances, use your specific instance URL instead of the cloud URL.
    1. Open https://cloud.linkwarden.app (or your self-hosted URL) in Safari.
    2. Tap the Share button at the bottom of the screen.
    3. Tap the 'Add to Home Screen' icon.
    4. Tap 'Add' in the upper-right corner.