linkding

Starlight projects follow a specific directory structure for content and assets:

• Documentation Content: Place .md or .mdx files in src/content/docs/. Each file is automatically exposed as a route based on its filename.
• Images: Add images to src/assets/ and embed them in Markdown using relative links.
• Static Assets: Place files like favicons in the public/ directory.

Project structure overview:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Several community-developed clients are available for accessing linkding on various platforms:

Desktop

• cosmicding: Desktop client built using libcosmic.

Mobile

• LinkBuddy: Open-source Android and iOS client (React Native).
• Linkdy: Open-source Android and iOS client (Flutter).
• Linklater: Open-source Android client (Kotlin).
• LinkThing: iOS client.
• Pinkt: Android client.

Browser Extensions

• linkding-extension: An alternative to the official extension that wraps the linkding bookmarklet.
• linkding-injector: Injects linkding search results into search engine sidebars (e.g., Google, DuckDuckGo).

To create a new Astro project using the Starlight template, use the npm create astro@latest command with the Starlight template flag.

npm create astro@latest -- --template starlight

When running linkding using docker run, you can configure the application by passing options as environment variables using the -e flag. Each option requires its own -e argument.

docker run --name linkding -p 9090:9090 -d -e LD_DISABLE_URL_VALIDATION=True sissbruecker/linkding:latest

Since Chrome on Android does not support standard bookmarklet execution, you can use this workaround to save the current page to your linkding instance:

1. Create a bookmark of your linkding deployment in Chrome (using the star icon in the three-dots menu).
2. Edit the bookmark and replace the URL with the following bookmarklet code, substituting <YOUR_INSTANCE_HERE> with your actual linkding URL:
3. To use it, type the name you gave the bookmark (e.g., bm or ld) into the Chrome address bar and select it from the results while browsing any website.

javascript:window.open(`http://<YOUR_INSTANCE_HERE>/bookmarks/new?url=${encodeURIComponent(window.location)}&auto_close`)

Nginx rewrites the Host header by default, which can cause login or CSRF issues. To forward the correct headers to linkding, add proxy_set_header Host $host; and proxy_set_header X-Forwarded-Proto $scheme; to your Nginx location block.

location /linkding {
    ...
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-Proto $scheme;
}

Use the Tags section in the administration page to perform bulk cleanup of your tags.

1. Navigate to Tags in the administration page.
2. Filter and select the tags you wish to manage.
3. Select an action from the Action dropdown:
   • Delete: Removes the tag. Note that this does not delete the bookmarks themselves; it only removes the tag association from them.
   • Delete unused tags: Deletes only the selected tags that are not currently assigned to any bookmark.
4. Click the button next to the checkbox to execute the operation.

You can use the SingleFile browser extension to save web pages as HTML files and upload them directly to linkding's REST API. This method captures the page exactly as seen in your browser.

Configuration Steps:

1. Install the SingleFile extension.
2. Open the extension settings.
3. Set Destination to upload to a REST Form API.
4. Set URL to your linkding instance URL followed by /api/bookmarks/singlefile/ (e.g., https://linkding.example.com/api/bookmarks/singlefile/).
5. Set authorization token to your linkding REST API token (found in your linkding settings page).
6. Set data field name to file.
7. Set URL field name to url.

Behavior:

• If the URL does not exist in linkding, a new bookmark is created.
• If the URL already exists, the snapshot is added to the existing bookmark.

Use the full_backup CLI command to create a compressed zip file containing the SQLite database, assets, favicons, and preview images. This method is recommended for default SQLite installations.

1. Create the backup inside the container: Execute the full_backup command via docker exec. This creates backup.zip in /etc/linkding/data/ inside the container.
2. Copy the backup to your host: Use docker cp to move the file from the container to your host system.
3. Restore the backup:
   • Extract the zip file into a folder for your new installation.
   • Rename the extracted folder to data.
   • Mount this folder to /etc/linkding/data in your Docker configuration and start the container.