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)

Searching Database…

11.3K ·GitHub
Linkding
这是什么？linkding 是一款自托管的书签管理器，设计简洁、速度快，而且用 Docker 就能快速搭建。这样你就能完全掌控自己的书签，不必依赖第三方服务。
这是我要自己运行的网页应用，还是装在设备上的软件？它是一个基于 Django 构建的自托管网页应用，运行在你自己的服务器上。Firefox/Chrome 扩展程序和书签小工具只是轻量的客户端，负责把书签发送到这个应用里。
我该怎样让它运行起来？你可以在自己的服务器上用 Docker 部署 linkding（或使用托管服务），然后根据需要安装对应的浏览器扩展程序，直接从 Firefox 或 Chrome 保存书签。
除了 Docker，运行它还需要别的东西吗？日常使用的话，服务器上有 Docker（或 Docker Compose）就够了。如果要自己从源码构建，则需要 Python 3.13、uv 和 Node.js。
我的书签数据究竟存放在哪里？由于 linkding 是自托管的，你所有的书签、标签和存档页面都保存在运行它的服务器上，而不是第三方云端。
链接失效时，它能保存网页的可用副本吗？可以。linkding 能自动归档已收藏的网页，既可以保存为本地 HTML 文件，也可以提交到 Internet Archive。
我保存网址时，标题和图标会怎样？linkding 会自动为你获取并保存每个收藏网站的标题、描述和网站图标。
别人能看到或使用我的书签吗？你可以把单个书签分享给其他用户或访客。应用还支持通过 OIDC 或身份验证代理实现单点登录（SSO），用于访问控制。
我能从其他书签管理器导入书签吗？可以。linkding 支持以 Netscape HTML 格式导入和导出书签，这是大多数浏览器和书签工具通用的标准格式。
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