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, а также букмарклет — это лёгкие клиенты, которые отправляют в него закладки.
Как его запустить?Вы разворачиваете linkding с помощью Docker на своём сервере (или используете услугу управляемого хостинга), а затем по желанию устанавливаете подходящее расширение для браузера, чтобы сохранять закладки прямо из Firefox или Chrome.
Нужно ли мне что-то помимо Docker, чтобы это запустить?Для обычного использования достаточно только Docker (или Docker Compose) на вашем сервере. Для сборки из исходного кода самостоятельно потребуются Python 3.13, uv и Node.js.
Где на самом деле хранятся мои данные закладок?Поскольку linkding самохостируемый, все ваши закладки, теги и архивные копии страниц остаются на сервере, где вы его запускаете, а не в стороннем облачном сервисе.
Может ли оно сохранять рабочие копии страниц на случай, если ссылки перестанут работать?Да, linkding может автоматически архивировать сохранённые страницы либо как локальный HTML-файл, либо отправляя их в Internet Archive.
Что происходит с заголовками и иконками, когда я сохраняю URL?linkding автоматически загружает и сохраняет заголовок, описание и значок сайта (favicon) для каждого сохранённого сайта.
Могут ли другие люди видеть или использовать мои закладки?Вы можете делиться отдельными закладками с другими пользователями или гостями, а приложение поддерживает единый вход (SSO) через OIDC или прокси-сервер аутентификации для контроля доступа.
Можно ли импортировать закладки из другого менеджера закладок?Да, 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