linkding README

The project's README from github.com/sissbruecker/linkding. As one markdown file: README.md.



Introduction

linkding is a bookmark manager that you can host yourself. It's designed be to be minimal, fast, and easy to set up using Docker.

The name comes from:

Feature Overview:

Demo: https://demo.linkding.link/

Screenshot:

Screenshot

Getting Started

The following links help you to get started with linkding:

Documentation

The full documentation is now available at linkding.link.

If you want to contribute to the documentation, you can find the source files in the docs folder.

If you want to contribute a community project, feel free to submit a PR.

Contributing

Small improvements, bugfixes and documentation improvements are always welcome. If you want to contribute a larger feature, consider opening an issue first to discuss it. I may choose to ignore PRs for features that don't align with the project's goals or that I don't want to maintain.

Development

The application is built using the Django web framework. You can get started by checking out the excellent Django docs. The bookmarks folder contains the actual bookmark application. Other than that the code should be self-explanatory / standard Django stuff 🙂.

Prerequisites

Setup

Initialize the development environment with:

make init

This sets up a virtual environment using uv, installs NPM dependencies and runs migrations to create the initial database.

Create a user for the frontend:

uv run manage.py createsuperuser --username=joe [email protected]

Run the frontend build for bundling frontend components with:

make frontend

Then start the Django development server with:

make serve

The frontend is now available under http://localhost:8000

Tests

Run all tests with pytest:

make test

Linting

Run linting with ruff:

make lint

Formatting

Format Python code with ruff, Django templates with djlint, and JavaScript code with prettier:

make format

DevContainers

This repository also supports DevContainers: Open in Remote - Containers

Once checked out, only the following commands are required to get started:

Create a user for the frontend:

uv run manage.py createsuperuser --username=joe [email protected]

Start the Node.js development server (used for compiling JavaScript components like tag auto-completion) with:

make frontend

Start the Django development server with:

make serve

The frontend is now available under http://localhost:8000

linkding (sissbruecker/linkding)

progressive-web-app
Searching Database…

11.3K ·GitHub
Linkding
What is this?Linkding is a self-hosted bookmark manager built to be minimal, fast, and quick to set up with Docker, so you keep full control of your own bookmarks instead of relying on a third-party service.
Is this a web app I run myself, or something installed on my device?It's a self-hosted web application built on Django that you run on your own server; the Firefox/Chrome extensions and bookmarklet are just lightweight clients that send bookmarks into it.
How do I get it running?You deploy linkding with Docker on your own server (or use a managed hosting option), then optionally install the matching browser extension to save bookmarks directly from Firefox or Chrome.
Do I need anything beyond Docker to run it?For normal use, just Docker (or Docker Compose) on your server is enough. Building from source yourself requires Python 3.13, uv, and Node.js.
Where does my bookmark data actually live?Since linkding is self-hosted, all your bookmarks, tags, and archived pages stay on the server you run it on rather than in a third-party cloud.
Can it keep working copies of pages in case links go dead?Yes, linkding can automatically archive bookmarked pages either as a local HTML file or by submitting them to the Internet Archive.
What happens to titles and icons when I save a URL?linkding automatically fetches and stores the title, description, and favicon of each bookmarked site for you.
Can other people see or use my bookmarks?You can share individual bookmarks with other users or with guests, and the app supports SSO via OIDC or an authentication proxy for access control.
Can I bring in bookmarks from another bookmark manager?Yes, linkding supports import and export of bookmarks in the standard Netscape HTML format used by most browsers and bookmark tools.
What are similar projects?karakeep, omnivore, edgeever, docs, memos, ArchiveBox, planka, linkwarden
Which topics is it in?bookmarks, progressive-web-app, django, admin, oidc, firefox-extension, pwa, note-taking, chrome-extension, browser-extension, docker-compose, rest-api
Creator
sissbruecker
Size
6.4 MB
Stars
11.3K
Updated
CommitSep 13Releasev1.47.0Sep 13
Age
7y
Commits · 90 Days