mirror of
https://github.com/sissbruecker/linkding
synced 2024-11-24 20:33:04 +00:00
Add documentation website (#833)
* test frontmatter rendering * restructure files * add docs website * move postcss config * revert postcss config * update readme * update logo * fix internal links
This commit is contained in:
Sascha Ißbrücker
GitHub
parent
53e4aeb1c1
commit
0e488b7ce3
37 changed files with 8153 additions and 248 deletions
226
README.md
226
README.md
|
|
@ -1,25 +1,11 @@
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<br>
|
<br>
|
||||||
<a href="https://github.com/sissbruecker/linkding">
|
<a href="https://github.com/sissbruecker/linkding">
|
||||||
<img src="docs/header.svg" height="50">
|
<img src="assets/header.svg" height="50">
|
||||||
</a>
|
</a>
|
||||||
<br>
|
<br>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Overview
|
|
||||||
- [Introduction](#introduction)
|
|
||||||
- [Installation](#installation)
|
|
||||||
- [Using Docker](#using-docker)
|
|
||||||
- [Using Docker Compose](#using-docker-compose)
|
|
||||||
- [User Setup](#user-setup)
|
|
||||||
- [Reverse Proxy Setup](#reverse-proxy-setup)
|
|
||||||
- [Managed Hosting Options](#managed-hosting-options)
|
|
||||||
- [Documentation](#documentation)
|
|
||||||
- [Browser Extension](#browser-extension)
|
|
||||||
- [Community](#community)
|
|
||||||
- [Acknowledgements + Donations](#acknowledgements--donations)
|
|
||||||
- [Development](#development)
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
linkding is a bookmark manager that you can host yourself.
|
linkding is a bookmark manager that you can host yourself.
|
||||||
|
|
@ -49,216 +35,30 @@ The name comes from:
|
||||||
|
|
||||||
**Screenshot:**
|
**Screenshot:**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Getting Started
|
||||||
|
|
||||||
linkding is designed to be run with container solutions like [Docker](https://docs.docker.com/get-started/).
|
The following links help you to get started with linkding:
|
||||||
The Docker image is compatible with ARM platforms, so it can be run on a Raspberry Pi.
|
- [Install linkding on your own server](https://linkding.link/installation) or [check managed hosting options](https://linkding.link/managed-hosting)
|
||||||
|
- [Install the browser extension](https://linkding.link/browser-extension)
|
||||||
linkding uses an SQLite database by default.
|
- [Check out community projects](https://linkding.link/community), which include mobile apps, browser extensions, libraries and more
|
||||||
Alternatively linkding supports PostgreSQL, see the [database options](docs/Options.md#LD_DB_ENGINE) for more information.
|
|
||||||
|
|
||||||
### Using Docker
|
|
||||||
|
|
||||||
The Docker image comes in several variants. To use a different image than the default, replace `latest` with the desired tag in the commands below, or in the docker-compose file.
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Tag</th>
|
|
||||||
<th>Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><code>latest</code></td>
|
|
||||||
<td>Provides the basic functionality of linkding</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>latest-plus</code></td>
|
|
||||||
<td>
|
|
||||||
Includes feature for archiving websites as HTML snapshots
|
|
||||||
<ul>
|
|
||||||
<li>Significantly larger image size as it includes a Chromium installation</li>
|
|
||||||
<li>Requires more runtime memory to run Chromium</li>
|
|
||||||
<li>Requires more disk space for storing HTML snapshots</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>latest-alpine</code></td>
|
|
||||||
<td><code>latest</code>, but based on Alpine Linux. 🧪 Experimental</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><code>latest-plus-alpine</code></td>
|
|
||||||
<td><code>latest-plus</code>, but based on Alpine Linux. 🧪 Experimental</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
To install linkding using Docker you can just run the image from [Docker Hub](https://hub.docker.com/repository/docker/sissbruecker/linkding):
|
|
||||||
```shell
|
|
||||||
docker run --name linkding -p 9090:9090 -v {host-data-folder}:/etc/linkding/data -d sissbruecker/linkding:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
In the command above, replace the `{host-data-folder}` placeholder with an absolute path to a folder on your host system where you want to store the linkding database.
|
|
||||||
|
|
||||||
If everything completed successfully, the application should now be running and can be accessed at http://localhost:9090.
|
|
||||||
|
|
||||||
To upgrade the installation to a new version, remove the existing container, pull the latest version of the linkding Docker image, and then start a new container using the same command that you used above. There is a [shell script](https://github.com/sissbruecker/linkding/blob/master/install-linkding.sh) available to automate these steps. The script can be configured using environment variables, or you can just modify it.
|
|
||||||
|
|
||||||
To complete the setup, you still have to [create an initial user](#user-setup), so that you can access your installation.
|
|
||||||
|
|
||||||
### Using Docker Compose
|
|
||||||
|
|
||||||
To install linkding using [Docker Compose](https://docs.docker.com/compose/), you can use the [`docker-compose.yml`](https://github.com/sissbruecker/linkding/blob/master/docker-compose.yml) file. Copy the [`.env.sample`](https://github.com/sissbruecker/linkding/blob/master/.env.sample) file to `.env`, configure the parameters, and then run:
|
|
||||||
```shell
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
To complete the setup, you still have to [create an initial user](#user-setup), so that you can access your installation.
|
|
||||||
|
|
||||||
### User Setup
|
|
||||||
|
|
||||||
For security reasons, the linkding Docker image does not provide an initial user, so you have to create one after setting up an installation. To do so, replace the credentials in the following command and run it:
|
|
||||||
|
|
||||||
**Docker**
|
|
||||||
```shell
|
|
||||||
docker exec -it linkding python manage.py createsuperuser --username=joe --email=joe@example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
**Docker Compose**
|
|
||||||
```shell
|
|
||||||
docker-compose exec linkding python manage.py createsuperuser --username=joe --email=joe@example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
The command will prompt you for a secure password. After the command has completed you can start using the application by logging into the UI with your credentials.
|
|
||||||
|
|
||||||
Alternatively you can automatically create an initial superuser on startup using the [`LD_SUPERUSER_NAME` option](docs/Options.md#LD_SUPERUSER_NAME).
|
|
||||||
|
|
||||||
### Reverse Proxy Setup
|
|
||||||
|
|
||||||
When using a reverse proxy, such as Nginx or Apache, you may need to configure your proxy to correctly forward the `Host` header to linkding, otherwise certain requests, such as login, might fail.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Apache</summary>
|
|
||||||
|
|
||||||
Apache2 does not change the headers by default, and should not
|
|
||||||
need additional configuration.
|
|
||||||
|
|
||||||
An example virtual host that proxies to linkding might look like:
|
|
||||||
```
|
|
||||||
<VirtualHost *:9100>
|
|
||||||
<Proxy *>
|
|
||||||
Order deny,allow
|
|
||||||
Allow from all
|
|
||||||
</Proxy>
|
|
||||||
|
|
||||||
ProxyPass / http://linkding:9090/
|
|
||||||
ProxyPassReverse / http://linkding:9090/
|
|
||||||
</VirtualHost>
|
|
||||||
```
|
|
||||||
|
|
||||||
For a full example, see the docker-compose configuration in [jhauris/apache2-reverse-proxy](https://github.com/jhauris/linkding/tree/apache2-reverse-proxy)
|
|
||||||
|
|
||||||
If you still run into CSRF issues, please check out the [`LD_CSRF_TRUSTED_ORIGINS` option](docs/Options.md#LD_CSRF_TRUSTED_ORIGINS).
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Caddy 2</summary>
|
|
||||||
|
|
||||||
Caddy does not change the headers by default, and should not need any further configuration.
|
|
||||||
|
|
||||||
If you still run into CSRF issues, please check out the [`LD_CSRF_TRUSTED_ORIGINS` option](docs/Options.md#LD_CSRF_TRUSTED_ORIGINS).
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Nginx</summary>
|
|
||||||
|
|
||||||
Nginx by default rewrites the `Host` header to whatever URL is used in the `proxy_pass` directive.
|
|
||||||
To forward the correct headers to linkding, add the following directives to the location block of your Nginx config:
|
|
||||||
```
|
|
||||||
location /linkding {
|
|
||||||
...
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
Instead of configuring header forwarding in your proxy, you can also configure the URL from which you want to access your linkding instance with the [`LD_CSRF_TRUSTED_ORIGINS` option](docs/Options.md#LD_CSRF_TRUSTED_ORIGINS).
|
|
||||||
|
|
||||||
### Managed Hosting Options
|
|
||||||
|
|
||||||
Self-hosting web applications still requires a lot of technical know-how and commitment to maintenance, in order to keep everything up-to-date and secure. This section is intended to provide simple alternatives in form of managed hosting solutions.
|
|
||||||
|
|
||||||
- [linkding on fly.io](https://github.com/fspoettel/linkding-on-fly) - Guide for hosting a linkding installation on [fly.io](https://fly.io). By [fspoettel](https://github.com/fspoettel)
|
|
||||||
- [PikaPods.com](https://www.pikapods.com/) - Managed hosting for linkding, EU and US regions available. [1-click setup link](https://www.pikapods.com/pods?run=linkding) ([Disclosure](#pikapods))
|
|
||||||
- [CapRover](https://caprover.com/) - Linkding is included as a default one-click app
|
|
||||||
- [linkding on railway.app](https://github.com/tianheg/linkding-on-railway) - Guide for hosting a linkding installation on [railway.app](https://railway.app/). By [tianheg](https://github.com/tianheg)
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
| Document | Description |
|
The full documentation is now available at [linkding.link](https://linkding.link/).
|
||||||
|-------------------------------------------------------------------------------------------------|----------------------------------------------------------|
|
|
||||||
| [Options](https://github.com/sissbruecker/linkding/blob/master/docs/Options.md) | Lists available options, and describes how to apply them |
|
|
||||||
| [Backups](https://github.com/sissbruecker/linkding/blob/master/docs/backup.md) | How to backup the linkding database |
|
|
||||||
| [Troubleshooting](https://github.com/sissbruecker/linkding/blob/master/docs/troubleshooting.md) | Advice for troubleshooting common problems |
|
|
||||||
| [How To](https://github.com/sissbruecker/linkding/blob/master/docs/how-to.md) | Tips and tricks around using linking |
|
|
||||||
| [Keyboard shortcuts](https://github.com/sissbruecker/linkding/blob/master/docs/shortcuts.md) | List of available keyboard shortcuts |
|
|
||||||
| [Admin documentation](https://github.com/sissbruecker/linkding/blob/master/docs/Admin.md) | User documentation for the Admin UI |
|
|
||||||
| [API documentation](https://github.com/sissbruecker/linkding/blob/master/docs/API.md) | Documentation for the REST API |
|
|
||||||
|
|
||||||
## Browser Extension
|
If you want to contribute to the documentation, you can find the source files in the `docs` folder.
|
||||||
|
|
||||||
linkding comes with an official browser extension that allows to quickly add bookmarks, and search bookmarks through the browser's address bar. You can get the extension here:
|
If you want to contribute a community project, feel free to [submit a PR](https://github.com/sissbruecker/linkding/edit/master/docs/community.md).
|
||||||
- [Mozilla Addon Store](https://addons.mozilla.org/firefox/addon/linkding-extension/)
|
|
||||||
- [Chrome Web Store](https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe)
|
|
||||||
|
|
||||||
The extension is open-source as well, and can be found [here](https://github.com/sissbruecker/linkding-extension).
|
## Contributing
|
||||||
|
|
||||||
## Community
|
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.
|
||||||
|
|
||||||
This section lists community projects around using linkding, in alphabetical order. If you have a project that you want to share with the linkding community, feel free to submit a PR to add your project to this section.
|
|
||||||
|
|
||||||
- [aiolinkding](https://github.com/bachya/aiolinkding) A Python3, async library to interact with the linkding REST API. By [bachya](https://github.com/bachya)
|
|
||||||
- [feed2linkding](https://codeberg.org/strubbl/feed2linkding) A commandline utility to add all web feed item links to linkding via API call. By [Strubbl](https://github.com/Strubbl)
|
|
||||||
- [Helm Chart](https://charts.pascaliske.dev/charts/linkding/) Helm Chart for deploying linkding inside a Kubernetes cluster. By [pascaliske](https://github.com/pascaliske)
|
|
||||||
- [iOS Shortcut using API and Tagging](https://gist.github.com/andrewdolphin/a7dff49505e588d940bec55132fab8ad) An iOS shortcut using the Linkding API (no extra logins required) that pulls previously used tags and allows tagging at the time of link creation.
|
|
||||||
- [k8s + s3](https://github.com/jzck/linkding-k8s-s3) - Setup for hosting stateless linkding on k8s with sqlite replicated to s3. By [jzck](https://github.com/jzck)
|
|
||||||
- [Linka!](https://github.com/cmsax/linka) Web app (also a PWA) for quickly searching & opening bookmarks in linkding, support multi keywords, exclude mode and other advance options. By [cmsax](https://github.com/cmsax)
|
|
||||||
- [linkding-cli](https://github.com/bachya/linkding-cli) A command-line interface (CLI) to interact with the linkding REST API. Powered by [aiolinkding](https://github.com/bachya/aiolinkding). By [bachya](https://github.com/bachya)
|
|
||||||
- [linkding-extension](https://github.com/jeroenpardon/linkding-extension) Chromium compatible extension that wraps the linkding bookmarklet. Tested with Chrome, Edge, Brave. By [jeroenpardon](https://github.com/jeroenpardon)
|
|
||||||
- [linkding-injector](https://github.com/Fivefold/linkding-injector) Injects search results from linkding into the sidebar of search pages like google and duckduckgo. Tested with Firefox and Chrome. By [Fivefold](https://github.com/Fivefold)
|
|
||||||
- [Linkdy](https://github.com/JGeek00/linkdy): An open source mobile and desktop (not yet) client created with Flutter. Available at the [Google Play Store](https://play.google.com/store/apps/details?id=com.jgeek00.linkdy). By [JGeek00](https://github.com/JGeek00).
|
|
||||||
- [LinkThing](https://apps.apple.com/us/app/linkthing/id1666031776) An iOS client for linkding. By [amoscardino](https://github.com/amoscardino)
|
|
||||||
- [Open all links bookmarklet](https://gist.github.com/ukcuddlyguy/336dd7339e6d35fc64a75ccfc9323c66) A browser bookmarklet to open all links on the current Linkding page in new tabs. By [ukcuddlyguy](https://github.com/ukcuddlyguy)
|
|
||||||
- [Pinkt](https://github.com/fibelatti/pinboard-kotlin) An Android client for linkding. By [fibelatti](https://github.com/fibelatti)
|
|
||||||
- [Postman collection](https://gist.github.com/gingerbeardman/f0b42502f3bc9344e92ce63afd4360d3) a group of saved request templates for API testing. By [gingerbeardman](https://github.com/gingerbeardman)
|
|
||||||
|
|
||||||
## Acknowledgements + Donations
|
|
||||||
|
|
||||||
### PikaPods
|
|
||||||
|
|
||||||
[PikaPods](https://www.pikapods.com/) has a revenue sharing agreement with this project, sharing some of their revenue from hosting linkding instances. I do not intend to profit from this project financially, so I am in turn donating that revenue. Big thanks to PikaPods for making this possible.
|
|
||||||
|
|
||||||
See the table below for a list of donations.
|
|
||||||
|
|
||||||
| Source | Description | Amount | Donated to |
|
|
||||||
|---------------------------------------|---------------------------------------------|---------|---------------------------------------------------------------------|
|
|
||||||
| [PikaPods](https://www.pikapods.com/) | Linkding hosting June 2022 - September 2023 | $163.50 | [Internet Archive](/docs/donations/2023-10-11-internet-archive.png) |
|
|
||||||
|
|
||||||
### JetBrains
|
|
||||||
|
|
||||||
JetBrains has previously provided an open-source license of [IntelliJ IDEA](https://www.jetbrains.com/idea/) for the development of linkding.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
The application is open source, so you are free to modify or contribute. The application is built using the Django web framework. You can get started by checking out the excellent [Django docs](https://docs.djangoproject.com/en/4.1/). The `bookmarks` folder contains the actual bookmark application, `siteroot` is the Django root application. Other than that the code should be self-explanatory / standard Django stuff 🙂.
|
The application is built using the Django web framework. You can get started by checking out the excellent [Django docs](https://docs.djangoproject.com/en/4.1/). The `bookmarks` folder contains the actual bookmark application, `siteroot` is the Django root application. Other than that the code should be self-explanatory / standard Django stuff 🙂.
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Python 3.10
|
- Python 3.10
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
BIN
assets/logo.png
BIN
assets/logo.png
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 24 KiB |
|
|
@ -1 +1,17 @@
|
||||||
<svg clip-rule="evenodd" fill-rule="evenodd" height="512" stroke-linejoin="round" stroke-miterlimit="1.5" viewBox="0 0 512 512" width="512" xmlns="http://www.w3.org/2000/svg"><circle cx="255.0164" cy="254.9236" fill="#5856e0" r="224.78528" stroke-width="1.18"/><g fill="none" stroke="#fff" stroke-width="31.25"><path d="m1244.39 1293.95v199.64s-.81 67.89 74.9 68.88c75.98.99 74.88-68.88 74.88-68.88v-199.64" transform="matrix(.70710678 .70710678 -.70710678 .70710678 284.139117 -1684.198509)"/><path d="m1244.39 1293.95v199.64s-.81 67.89 74.9 68.88c75.98.99 74.88-68.88 74.88-68.88v-199.64" transform="matrix(-.70957074 -.70463421 .70463421 -.70957074 235.113139 2195.434643)"/></g></svg>
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg width="100%" height="100%" viewBox="0 0 450 450" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.5;">
|
||||||
|
<g transform="matrix(1,0,0,1,-70.3466,-70.3466)">
|
||||||
|
<g transform="matrix(1.18075,0,0,1.18075,-1257.39,-1386.74)">
|
||||||
|
<circle cx="1314.98" cy="1424.52" r="190.496" style="fill:rgb(88,86,224);"/>
|
||||||
|
</g>
|
||||||
|
<g transform="matrix(0.793058,0,0,0.793058,-739.034,-836.215)">
|
||||||
|
<g transform="matrix(0.707351,0.706862,-0.706862,0.707351,1331.93,-512.804)">
|
||||||
|
<path d="M1244.39,1293.95L1244.39,1493.59C1244.39,1493.59 1243.58,1561.48 1319.29,1562.47C1395.27,1563.46 1394.17,1493.59 1394.17,1493.59L1394.17,1293.95" style="fill:none;stroke:white;stroke-width:34.15px;"/>
|
||||||
|
</g>
|
||||||
|
<g transform="matrix(-0.710067,-0.704134,0.704134,-0.710067,1284.12,3366.41)">
|
||||||
|
<path d="M1244.39,1293.95L1244.39,1493.59C1244.39,1493.59 1243.58,1561.48 1319.29,1562.47C1395.27,1563.46 1394.17,1493.59 1394.17,1493.59L1394.17,1293.95" style="fill:none;stroke:white;stroke-width:34.15px;"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 688 B After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
21
docs/.gitignore
vendored
Normal file
21
docs/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# build output
|
||||||
|
dist/
|
||||||
|
# generated types
|
||||||
|
.astro/
|
||||||
|
|
||||||
|
# dependencies
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# logs
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
|
||||||
|
|
||||||
|
# environment variables
|
||||||
|
.env
|
||||||
|
.env.production
|
||||||
|
|
||||||
|
# macOS-specific files
|
||||||
|
.DS_Store
|
||||||
55
docs/README.md
Normal file
55
docs/README.md
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
# Starlight Starter Kit: Basics
|
||||||
|
|
||||||
|
[](https://starlight.astro.build)
|
||||||
|
|
||||||
|
```
|
||||||
|
npm create astro@latest -- --template starlight
|
||||||
|
```
|
||||||
|
|
||||||
|
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
|
||||||
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||||
|
|
||||||
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||||
|
|
||||||
|
## 🚀 Project Structure
|
||||||
|
|
||||||
|
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── public/
|
||||||
|
├── src/
|
||||||
|
│ ├── assets/
|
||||||
|
│ ├── content/
|
||||||
|
│ │ ├── docs/
|
||||||
|
│ │ └── config.ts
|
||||||
|
│ └── env.d.ts
|
||||||
|
├── astro.config.mjs
|
||||||
|
├── package.json
|
||||||
|
└── tsconfig.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||||
|
|
||||||
|
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||||
|
|
||||||
|
Static assets, like favicons, can be placed in the `public/` directory.
|
||||||
|
|
||||||
|
## 🧞 Commands
|
||||||
|
|
||||||
|
All commands are run from the root of the project, from a terminal:
|
||||||
|
|
||||||
|
| Command | Action |
|
||||||
|
| :------------------------ | :----------------------------------------------- |
|
||||||
|
| `npm install` | Installs dependencies |
|
||||||
|
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||||
|
| `npm run build` | Build your production site to `./dist/` |
|
||||||
|
| `npm run preview` | Preview your build locally, before deploying |
|
||||||
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||||
|
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||||
|
|
||||||
|
## 👀 Want to learn more?
|
||||||
|
|
||||||
|
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||||
50
docs/astro.config.mjs
Normal file
50
docs/astro.config.mjs
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
// @ts-check
|
||||||
|
import { defineConfig } from 'astro/config';
|
||||||
|
import starlight from '@astrojs/starlight';
|
||||||
|
|
||||||
|
// https://astro.build/config
|
||||||
|
export default defineConfig({
|
||||||
|
integrations: [
|
||||||
|
starlight({
|
||||||
|
title: 'linkding',
|
||||||
|
logo: {
|
||||||
|
src: './src/assets/logo.svg',
|
||||||
|
},
|
||||||
|
social: {
|
||||||
|
github: 'https://github.com/sissbruecker/linkding',
|
||||||
|
},
|
||||||
|
sidebar: [
|
||||||
|
{
|
||||||
|
label: 'Getting Started',
|
||||||
|
items: [
|
||||||
|
{ label: 'Installation', slug: 'installation' },
|
||||||
|
{ label: 'Managed Hosting', slug: 'managed-hosting' },
|
||||||
|
{ label: 'Browser Extension', slug: 'browser-extension' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Guides',
|
||||||
|
items: [
|
||||||
|
{ label: 'Options', slug: 'options' },
|
||||||
|
{ label: 'Backups', slug: 'backups' },
|
||||||
|
{ label: 'Admin', slug: 'admin' },
|
||||||
|
{ label: 'Keyboard Shortcuts', slug: 'shortcuts' },
|
||||||
|
{ label: 'How To', slug: 'how-to' },
|
||||||
|
{ label: 'Troubleshooting', slug: 'troubleshooting' },
|
||||||
|
{ label: 'REST API', slug: 'api' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Resources',
|
||||||
|
items: [
|
||||||
|
{ label: 'Community', slug: 'community' },
|
||||||
|
{ label: 'Acknowledgements', slug: 'acknowledgements' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
customCss: [
|
||||||
|
'./src/styles/custom.css',
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 107 KiB |
7640
docs/package-lock.json
generated
Normal file
7640
docs/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
19
docs/package.json
Normal file
19
docs/package.json
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
{
|
||||||
|
"name": "linkding-docs",
|
||||||
|
"type": "module",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "astro dev",
|
||||||
|
"start": "astro dev",
|
||||||
|
"build": "rm -rf dist && astro check && astro build",
|
||||||
|
"preview": "astro preview",
|
||||||
|
"astro": "astro"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@astrojs/check": "^0.9.3",
|
||||||
|
"@astrojs/starlight": "^0.27.1",
|
||||||
|
"astro": "^4.15.3",
|
||||||
|
"sharp": "^0.32.5",
|
||||||
|
"typescript": "^5.6.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Before Width: | Height: | Size: 189 KiB After Width: | Height: | Size: 189 KiB |
1
docs/public/favicon.svg
Normal file
1
docs/public/favicon.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.5" viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><circle cx="255.0164" cy="254.9236" fill="#5856e0" r="224.78528" stroke-width="1.18"/><g fill="none" stroke="#fff" stroke-width="31.25"><path d="m1244.39 1293.95v199.64s-.81 67.89 74.9 68.88c75.98.99 74.88-68.88 74.88-68.88v-199.64" transform="matrix(.70710678 .70710678 -.70710678 .70710678 284.139117 -1684.198509)"/><path d="m1244.39 1293.95v199.64s-.81 67.89 74.9 68.88c75.98.99 74.88-68.88 74.88-68.88v-199.64" transform="matrix(-.70957074 -.70463421 .70463421 -.70957074 235.113139 2195.434643)"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 663 B |
|
Before Width: | Height: | Size: 447 KiB After Width: | Height: | Size: 447 KiB |
17
docs/src/assets/logo.svg
Normal file
17
docs/src/assets/logo.svg
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg width="100%" height="100%" viewBox="0 0 450 450" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.5;">
|
||||||
|
<g transform="matrix(1,0,0,1,-70.3466,-70.3466)">
|
||||||
|
<g transform="matrix(1.18075,0,0,1.18075,-1257.39,-1386.74)">
|
||||||
|
<circle cx="1314.98" cy="1424.52" r="190.496" style="fill:rgb(88,86,224);"/>
|
||||||
|
</g>
|
||||||
|
<g transform="matrix(0.793058,0,0,0.793058,-739.034,-836.215)">
|
||||||
|
<g transform="matrix(0.707351,0.706862,-0.706862,0.707351,1331.93,-512.804)">
|
||||||
|
<path d="M1244.39,1293.95L1244.39,1493.59C1244.39,1493.59 1243.58,1561.48 1319.29,1562.47C1395.27,1563.46 1394.17,1493.59 1394.17,1493.59L1394.17,1293.95" style="fill:none;stroke:white;stroke-width:34.15px;"/>
|
||||||
|
</g>
|
||||||
|
<g transform="matrix(-0.710067,-0.704134,0.704134,-0.710067,1284.12,3366.41)">
|
||||||
|
<path d="M1244.39,1293.95L1244.39,1493.59C1244.39,1493.59 1243.58,1561.48 1319.29,1562.47C1395.27,1563.46 1394.17,1493.59 1394.17,1493.59L1394.17,1293.95" style="fill:none;stroke:white;stroke-width:34.15px;"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.4 KiB |
6
docs/src/content/config.ts
Normal file
6
docs/src/content/config.ts
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
import { defineCollection } from 'astro:content';
|
||||||
|
import { docsSchema } from '@astrojs/starlight/schema';
|
||||||
|
|
||||||
|
export const collections = {
|
||||||
|
docs: defineCollection({ schema: docsSchema() }),
|
||||||
|
};
|
||||||
18
docs/src/content/docs/acknowledgements.md
Normal file
18
docs/src/content/docs/acknowledgements.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
title: "Acknowledgements"
|
||||||
|
description: "Acknowledgements and thanks to contributors and sponsors"
|
||||||
|
---
|
||||||
|
|
||||||
|
## PikaPods
|
||||||
|
|
||||||
|
[PikaPods](https://www.pikapods.com/) has a revenue sharing agreement with this project, sharing some of their revenue from hosting linkding instances. I do not intend to profit from this project financially, so I am in turn donating that revenue. Thanks to PikaPods for making this possible.
|
||||||
|
|
||||||
|
See the table below for a list of donations.
|
||||||
|
|
||||||
|
| Source | Description | Amount | Donated to |
|
||||||
|
|---------------------------------------|---------------------------------------------|---------|------------------------------------------------------------------|
|
||||||
|
| [PikaPods](https://www.pikapods.com/) | Linkding hosting June 2022 - September 2023 | $163.50 | [Internet Archive](/2023-10-11-internet-archive.png) |
|
||||||
|
|
||||||
|
## JetBrains
|
||||||
|
|
||||||
|
JetBrains has previously provided an open-source license of [IntelliJ IDEA](https://www.jetbrains.com/idea/) for the development of linkding. Thanks!
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# Administration
|
---
|
||||||
|
title: "Admin"
|
||||||
|
description: "How to use the linkding admin app"
|
||||||
|
---
|
||||||
|
|
||||||
This document describes how to make use of the admin app that comes as part of each linkding installation. This is the default Django admin app with some linkding specific customizations.
|
This document describes how to make use of the admin app that comes as part of each linkding installation. This is the default Django admin app with some linkding specific customizations.
|
||||||
|
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# API
|
---
|
||||||
|
title: "API"
|
||||||
|
description: "How to use the REST API of linkding"
|
||||||
|
---
|
||||||
|
|
||||||
The application provides a REST API that can be used by 3rd party applications to manage bookmarks.
|
The application provides a REST API that can be used by 3rd party applications to manage bookmarks.
|
||||||
|
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# Backups
|
---
|
||||||
|
title: "Backups"
|
||||||
|
description: "How to back up your Linkding installation"
|
||||||
|
---
|
||||||
|
|
||||||
Linkding stores all data in the application's data folder.
|
Linkding stores all data in the application's data folder.
|
||||||
The full path to that folder in the Docker container is `/etc/linkding/data`.
|
The full path to that folder in the Docker container is `/etc/linkding/data`.
|
||||||
|
|
@ -16,9 +19,10 @@ The following sections explain how to back up the individual contents.
|
||||||
|
|
||||||
linkding provides a CLI command to create a full backup of the data folder. This creates a zip file that contains backups of the database, assets, favicons, and preview images.
|
linkding provides a CLI command to create a full backup of the data folder. This creates a zip file that contains backups of the database, assets, favicons, and preview images.
|
||||||
|
|
||||||
> [!NOTE]
|
:::note
|
||||||
> This method assumes that you are using the default SQLite database.
|
This method assumes that you are using the default SQLite database.
|
||||||
> If you are using a different database, such as Postgres, you'll have to back up the database and other contents of the data folder manually.
|
If you are using a different database, such as Postgres, you'll have to back up the database and other contents of the data folder manually.
|
||||||
|
:::
|
||||||
|
|
||||||
To create a full backup, execute the following command:
|
To create a full backup, execute the following command:
|
||||||
```shell
|
```shell
|
||||||
|
|
@ -47,14 +51,16 @@ If you can't use the full backup method, this section describes alternatives how
|
||||||
|
|
||||||
linkding includes a CLI command for creating a backup copy of the database.
|
linkding includes a CLI command for creating a backup copy of the database.
|
||||||
|
|
||||||
> [!WARNING]
|
:::caution
|
||||||
> While the SQLite database is just a single file, it is not recommended to just copy that file.
|
While the SQLite database is just a single file, it is not recommended to just copy that file.
|
||||||
> This method is not transaction safe and may result in a [corrupted database](https://www.sqlite.org/howtocorrupt.html).
|
This method is not transaction safe and may result in a [corrupted database](https://www.sqlite.org/howtocorrupt.html).
|
||||||
> Use one of the backup methods described below.
|
Use one of the backup methods described below.
|
||||||
|
:::
|
||||||
|
|
||||||
> [!WARNING]
|
:::caution
|
||||||
> This method is deprecated and may be removed in the future.
|
This method is deprecated and may be removed in the future.
|
||||||
> Please use the full backup method described above.
|
Please use the full backup method described above.
|
||||||
|
:::
|
||||||
|
|
||||||
To create a backup, execute the following command:
|
To create a backup, execute the following command:
|
||||||
```shell
|
```shell
|
||||||
10
docs/src/content/docs/browser-extension.md
Normal file
10
docs/src/content/docs/browser-extension.md
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
---
|
||||||
|
title: "Browser Extension"
|
||||||
|
description: "Browser extension for linkding"
|
||||||
|
---
|
||||||
|
|
||||||
|
linkding comes with an official browser extension that allows to quickly add bookmarks, and search bookmarks through the browser's address bar. You can get the extension here:
|
||||||
|
- [Mozilla Addon Store](https://addons.mozilla.org/firefox/addon/linkding-extension/)
|
||||||
|
- [Chrome Web Store](https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe)
|
||||||
|
|
||||||
|
The extension is open-source as well, and can be found [here](https://github.com/sissbruecker/linkding-extension).
|
||||||
21
docs/src/content/docs/community.md
Normal file
21
docs/src/content/docs/community.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
---
|
||||||
|
title: "Community"
|
||||||
|
description: "Community projects around linkding"
|
||||||
|
---
|
||||||
|
|
||||||
|
This section lists community projects around using linkding, in alphabetical order. If you have a project that you want to share with the linkding community, feel free to [submit a PR](https://github.com/sissbruecker/linkding/edit/master/docs/community.md) to add your project to this section.
|
||||||
|
|
||||||
|
- [aiolinkding](https://github.com/bachya/aiolinkding) A Python3, async library to interact with the linkding REST API. By [bachya](https://github.com/bachya)
|
||||||
|
- [feed2linkding](https://codeberg.org/strubbl/feed2linkding) A commandline utility to add all web feed item links to linkding via API call. By [Strubbl](https://github.com/Strubbl)
|
||||||
|
- [Helm Chart](https://charts.pascaliske.dev/charts/linkding/) Helm Chart for deploying linkding inside a Kubernetes cluster. By [pascaliske](https://github.com/pascaliske)
|
||||||
|
- [iOS Shortcut using API and Tagging](https://gist.github.com/andrewdolphin/a7dff49505e588d940bec55132fab8ad) An iOS shortcut using the Linkding API (no extra logins required) that pulls previously used tags and allows tagging at the time of link creation.
|
||||||
|
- [k8s + s3](https://github.com/jzck/linkding-k8s-s3) - Setup for hosting stateless linkding on k8s with sqlite replicated to s3. By [jzck](https://github.com/jzck)
|
||||||
|
- [Linka!](https://github.com/cmsax/linka) Web app (also a PWA) for quickly searching & opening bookmarks in linkding, support multi keywords, exclude mode and other advance options. By [cmsax](https://github.com/cmsax)
|
||||||
|
- [linkding-cli](https://github.com/bachya/linkding-cli) A command-line interface (CLI) to interact with the linkding REST API. Powered by [aiolinkding](https://github.com/bachya/aiolinkding). By [bachya](https://github.com/bachya)
|
||||||
|
- [linkding-extension](https://github.com/jeroenpardon/linkding-extension) Chromium compatible extension that wraps the linkding bookmarklet. Tested with Chrome, Edge, Brave. By [jeroenpardon](https://github.com/jeroenpardon)
|
||||||
|
- [linkding-injector](https://github.com/Fivefold/linkding-injector) Injects search results from linkding into the sidebar of search pages like google and duckduckgo. Tested with Firefox and Chrome. By [Fivefold](https://github.com/Fivefold)
|
||||||
|
- [Linkdy](https://github.com/JGeek00/linkdy): An open source mobile and desktop (not yet) client created with Flutter. Available at the [Google Play Store](https://play.google.com/store/apps/details?id=com.jgeek00.linkdy). By [JGeek00](https://github.com/JGeek00).
|
||||||
|
- [LinkThing](https://apps.apple.com/us/app/linkthing/id1666031776) An iOS client for linkding. By [amoscardino](https://github.com/amoscardino)
|
||||||
|
- [Open all links bookmarklet](https://gist.github.com/ukcuddlyguy/336dd7339e6d35fc64a75ccfc9323c66) A browser bookmarklet to open all links on the current Linkding page in new tabs. By [ukcuddlyguy](https://github.com/ukcuddlyguy)
|
||||||
|
- [Pinkt](https://github.com/fibelatti/pinboard-kotlin) An Android client for linkding. By [fibelatti](https://github.com/fibelatti)
|
||||||
|
- [Postman collection](https://gist.github.com/gingerbeardman/f0b42502f3bc9344e92ce63afd4360d3) a group of saved request templates for API testing. By [gingerbeardman](https://github.com/gingerbeardman)
|
||||||
|
|
@ -1,14 +1,10 @@
|
||||||
# How To
|
---
|
||||||
|
title: "How to"
|
||||||
|
description: "Collection of tips and tricks around using linkding"
|
||||||
|
---
|
||||||
|
|
||||||
Collection of tips and tricks around using linkding.
|
Collection of tips and tricks around using linkding.
|
||||||
|
|
||||||
**Table of Contents:**
|
|
||||||
|
|
||||||
* [Using the bookmarklet on Android/Chrome](#using-the-bookmarklet-on-androidchrome)
|
|
||||||
* [Using HTTP Shortcuts app on Android](#using-http-shortcuts-app-on-android)
|
|
||||||
* [Create a share action on iOS for adding bookmarks to linkding](#create-a-share-action-on-ios-for-adding-bookmarks-to-linkding)
|
|
||||||
* [Increase the font size](#increase-the-font-size)
|
|
||||||
|
|
||||||
## Using the bookmarklet on Android/Chrome
|
## Using the bookmarklet on Android/Chrome
|
||||||
|
|
||||||
This how-to explains the usage of the standard linkding bookmarklet on Android / Chrome.
|
This how-to explains the usage of the standard linkding bookmarklet on Android / Chrome.
|
||||||
|
|
@ -33,7 +29,7 @@ For more info see here: https://paul.kinlan.me/use-bookmarklets-on-chrome-on-and
|
||||||
|
|
||||||
- Install HTTP Shortcuts from [Play Store](https://play.google.com/store/apps/details?id=ch.rmy.android.http_shortcuts) or [F-Droid](https://f-droid.org/en/packages/ch.rmy.android.http_shortcuts/).
|
- Install HTTP Shortcuts from [Play Store](https://play.google.com/store/apps/details?id=ch.rmy.android.http_shortcuts) or [F-Droid](https://f-droid.org/en/packages/ch.rmy.android.http_shortcuts/).
|
||||||
|
|
||||||
- Copy the URL of [linkding_shortcut.json](https://raw.githubusercontent.com/sissbruecker/linkding/master/docs/linkding_shortcut.json).
|
- Copy the URL of [linkding_shortcut.json](https://raw.githubusercontent.com/sissbruecker/linkding/master/docs/src/assets/linkding_shortcut.json).
|
||||||
|
|
||||||
- Open HTTP Shortcuts, tap the 3-dot-button at the top-right corner, tap `Import/Export`, then tap `Import from URL`.
|
- Open HTTP Shortcuts, tap the 3-dot-button at the top-right corner, tap `Import/Export`, then tap `Import from URL`.
|
||||||
|
|
||||||
|
|
@ -48,7 +44,7 @@ Try using share button on an app, a new item `Send to...` should appear on the s
|
||||||
This how-to explains how to make use of the app shortcuts iOS app to create a share action that can be used in Safari for adding bookmarks to your linkding instance.
|
This how-to explains how to make use of the app shortcuts iOS app to create a share action that can be used in Safari for adding bookmarks to your linkding instance.
|
||||||
|
|
||||||
To install the shortcut:
|
To install the shortcut:
|
||||||
- Download the [Shortcut](https://raw.githubusercontent.com/sissbruecker/linkding/master/docs/Add%20To%20Linkding.shortcut) on your iOS device
|
- Download the [Shortcut](https://raw.githubusercontent.com/sissbruecker/linkding/master/docs/src/assets/Add%20To%20Linkding.shortcut) on your iOS device
|
||||||
- Tap the downloaded file, which brings up the Shortcuts app
|
- Tap the downloaded file, which brings up the Shortcuts app
|
||||||
- Confirm that you want to add the shortcut
|
- Confirm that you want to add the shortcut
|
||||||
- In the shortcut, change `https://linkding.mydomain.com` to the URL of your linkding instance
|
- In the shortcut, change `https://linkding.mydomain.com` to the URL of your linkding instance
|
||||||
|
|
@ -64,8 +60,9 @@ To use the shortcut:
|
||||||
|
|
||||||
At the bottom of the share sheet there is a button for configuring share actions. You can use this to move the "Add To Linkding" action to the top of the share sheet if you like.
|
At the bottom of the share sheet there is a button for configuring share actions. You can use this to move the "Add To Linkding" action to the top of the share sheet if you like.
|
||||||
|
|
||||||
> [!NOTE]
|
:::note
|
||||||
> You can also check the [Community section](https://github.com/sissbruecker/linkding#community) for other pre-made shortcuts that you can use.
|
You can also check the [Community section](/community) for other pre-made shortcuts that you can use.
|
||||||
|
:::
|
||||||
|
|
||||||
## Increase the font size
|
## Increase the font size
|
||||||
|
|
||||||
33
docs/src/content/docs/index.md
Normal file
33
docs/src/content/docs/index.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
---
|
||||||
|
title: "Linkding"
|
||||||
|
description: "Linkding is a self-hosted bookmarking service that is designed be to be minimal, fast, and easy to set up using Docker."
|
||||||
|
---
|
||||||
|
|
||||||
|
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:
|
||||||
|
- *link* which is often used as a synonym for URLs and bookmarks in common language
|
||||||
|
- *Ding* which is German for thing
|
||||||
|
- ...so basically something for managing your links
|
||||||
|
|
||||||
|
**Feature Overview:**
|
||||||
|
- Clean UI optimized for readability
|
||||||
|
- Organize bookmarks with tags
|
||||||
|
- Bulk editing, Markdown notes, read it later functionality
|
||||||
|
- Share bookmarks with other users or guests
|
||||||
|
- Automatically provides titles, descriptions and icons of bookmarked websites
|
||||||
|
- Automatically archive websites, either as local HTML file or on Internet Archive
|
||||||
|
- Import and export bookmarks in Netscape HTML format
|
||||||
|
- Installable as a Progressive Web App (PWA)
|
||||||
|
- Extensions for [Firefox](https://addons.mozilla.org/firefox/addon/linkding-extension/) and [Chrome](https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe), as well as a bookmarklet
|
||||||
|
- SSO support via OIDC or authentication proxies
|
||||||
|
- REST API for developing 3rd party apps
|
||||||
|
- Admin panel for user self-service and raw data access
|
||||||
|
|
||||||
|
|
||||||
|
**Demo:** https://demo.linkding.link/
|
||||||
|
|
||||||
|
**Screenshot:**
|
||||||
|
|
||||||
|
|
||||||
143
docs/src/content/docs/installation.md
Normal file
143
docs/src/content/docs/installation.md
Normal file
|
|
@ -0,0 +1,143 @@
|
||||||
|
---
|
||||||
|
title: "Installation"
|
||||||
|
description: "How to install linkding"
|
||||||
|
---
|
||||||
|
|
||||||
|
linkding is designed to be run with container solutions like [Docker](https://docs.docker.com/get-started/).
|
||||||
|
The Docker image is compatible with ARM platforms, so it can be run on a Raspberry Pi.
|
||||||
|
|
||||||
|
linkding uses an SQLite database by default.
|
||||||
|
Alternatively, linkding supports PostgreSQL, see the [database options](/options#ld_db_engine) for more information.
|
||||||
|
|
||||||
|
## Using Docker
|
||||||
|
|
||||||
|
The Docker image comes in several variants. To use a different image than the default, replace `latest` with the desired tag in the commands below, or in the docker-compose file.
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Tag</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>latest</code></td>
|
||||||
|
<td>Provides the basic functionality of linkding</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>latest-plus</code></td>
|
||||||
|
<td>
|
||||||
|
Includes feature for archiving websites as HTML snapshots
|
||||||
|
<ul>
|
||||||
|
<li>Significantly larger image size as it includes a Chromium installation</li>
|
||||||
|
<li>Requires more runtime memory to run Chromium</li>
|
||||||
|
<li>Requires more disk space for storing HTML snapshots</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>latest-alpine</code></td>
|
||||||
|
<td><code>latest</code>, but based on Alpine Linux. 🧪 Experimental</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>latest-plus-alpine</code></td>
|
||||||
|
<td><code>latest-plus</code>, but based on Alpine Linux. 🧪 Experimental</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
To install linkding using Docker you can just run the image from [Docker Hub](https://hub.docker.com/repository/docker/sissbruecker/linkding):
|
||||||
|
```shell
|
||||||
|
docker run --name linkding -p 9090:9090 -v {host-data-folder}:/etc/linkding/data -d sissbruecker/linkding:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
In the command above, replace the `{host-data-folder}` placeholder with an absolute path to a folder on your host system where you want to store the linkding database.
|
||||||
|
|
||||||
|
If everything completed successfully, the application should now be running and can be accessed at http://localhost:9090.
|
||||||
|
|
||||||
|
To upgrade the installation to a new version, remove the existing container, pull the latest version of the linkding Docker image, and then start a new container using the same command that you used above. There is a [shell script](https://github.com/sissbruecker/linkding/blob/master/install-linkding.sh) available to automate these steps. The script can be configured using environment variables, or you can just modify it.
|
||||||
|
|
||||||
|
To complete the setup, you still have to [create an initial user](#user-setup), so that you can access your installation.
|
||||||
|
|
||||||
|
## Using Docker Compose
|
||||||
|
|
||||||
|
To install linkding using [Docker Compose](https://docs.docker.com/compose/), you can download the [`docker-compose.yml`](https://github.com/sissbruecker/linkding/blob/master/docker-compose.yml) file. Also download the [`.env.sample`](https://github.com/sissbruecker/linkding/blob/master/.env.sample) file, rename it to `.env`, configure the parameters, and then run:
|
||||||
|
```shell
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
To complete the setup, you still have to [create an initial user](#user-setup), so that you can access your installation.
|
||||||
|
|
||||||
|
## User Setup
|
||||||
|
|
||||||
|
The linkding Docker image does not provide an initial user, so you have to create one after setting up an installation. To do so, replace the credentials in the following command and run it:
|
||||||
|
|
||||||
|
**Docker**
|
||||||
|
```shell
|
||||||
|
docker exec -it linkding python manage.py createsuperuser --username=joe --email=joe@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
**Docker Compose**
|
||||||
|
```shell
|
||||||
|
docker-compose exec linkding python manage.py createsuperuser --username=joe --email=joe@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
The command will prompt you for a secure password. After the command has completed you can start using the application by logging into the UI with your credentials.
|
||||||
|
|
||||||
|
Alternatively, you can automatically create an initial superuser on startup using the [`LD_SUPERUSER_NAME` option](/options#ld_superuser_name).
|
||||||
|
|
||||||
|
## Reverse Proxy Setup
|
||||||
|
|
||||||
|
When using a reverse proxy, such as Nginx or Apache, you may need to configure your proxy to correctly forward the `Host` header to linkding, otherwise certain requests, such as login, might fail.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Apache</summary>
|
||||||
|
|
||||||
|
Apache2 does not change the headers by default, and should not
|
||||||
|
need additional configuration.
|
||||||
|
|
||||||
|
An example virtual host that proxies to linkding might look like:
|
||||||
|
```
|
||||||
|
<VirtualHost *:9100>
|
||||||
|
<Proxy *>
|
||||||
|
Order deny,allow
|
||||||
|
Allow from all
|
||||||
|
</Proxy>
|
||||||
|
|
||||||
|
ProxyPass / http://linkding:9090/
|
||||||
|
ProxyPassReverse / http://linkding:9090/
|
||||||
|
</VirtualHost>
|
||||||
|
```
|
||||||
|
|
||||||
|
For a full example, see the docker-compose configuration in [jhauris/apache2-reverse-proxy](https://github.com/jhauris/linkding/tree/apache2-reverse-proxy)
|
||||||
|
|
||||||
|
If you still run into CSRF issues, please check out the [`LD_CSRF_TRUSTED_ORIGINS` option](/options#ld_csrf_trusted_origins).
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Caddy 2</summary>
|
||||||
|
|
||||||
|
Caddy does not change the headers by default, and should not need any further configuration.
|
||||||
|
|
||||||
|
If you still run into CSRF issues, please check out the [`LD_CSRF_TRUSTED_ORIGINS` option](/options#ld_csrf_trusted_origins).
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Nginx</summary>
|
||||||
|
|
||||||
|
Nginx by default rewrites the `Host` header to whatever URL is used in the `proxy_pass` directive.
|
||||||
|
To forward the correct headers to linkding, add the following directives to the location block of your Nginx config:
|
||||||
|
```
|
||||||
|
location /linkding {
|
||||||
|
...
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
Instead of configuring header forwarding in your proxy, you can also configure the URL from which you want to access your linkding instance with the [`LD_CSRF_TRUSTED_ORIGINS` option](/options#ld_csrf_trusted_origins).
|
||||||
20
docs/src/content/docs/managed-hosting.md
Normal file
20
docs/src/content/docs/managed-hosting.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
title: "Managed Hosting"
|
||||||
|
description: "Managed hosting options for linkding"
|
||||||
|
---
|
||||||
|
|
||||||
|
Self-hosting web applications still requires a lot of technical know-how and commitment to maintenance, in order to keep everything up-to-date and secure. This section is intended to provide simple alternatives in form of managed hosting solutions.
|
||||||
|
|
||||||
|
## Fully Managed
|
||||||
|
|
||||||
|
The following services provide fully managed hosting for linkding, including automatic updates and backups:
|
||||||
|
|
||||||
|
- [PikaPods.com](https://www.pikapods.com/) - Managed hosting for linkding, EU and US regions available. [1-click setup link](https://www.pikapods.com/pods?run=linkding) ([Disclosure](/acknowledgements#pikapods))
|
||||||
|
|
||||||
|
## Self-Managed
|
||||||
|
|
||||||
|
The following guides provide instructions for hosting a linkding installation on various platforms, however you are still responsible for updates and backups:
|
||||||
|
|
||||||
|
- [linkding on fly.io](https://github.com/fspoettel/linkding-on-fly) - Guide for hosting a linkding installation on [fly.io](https://fly.io). By [fspoettel](https://github.com/fspoettel)
|
||||||
|
- [CapRover](https://caprover.com/) - Linkding is included as a default one-click app
|
||||||
|
- [linkding on railway.app](https://github.com/tianheg/linkding-on-railway) - Guide for hosting a linkding installation on [railway.app](https://railway.app/). By [tianheg](https://github.com/tianheg)
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# Options
|
---
|
||||||
|
title: "Options"
|
||||||
|
description: "Options for configuring linkding"
|
||||||
|
---
|
||||||
|
|
||||||
This document lists the options that linkding can be configured with and explains how to use them in the individual install scenarios.
|
This document lists the options that linkding can be configured with and explains how to use them in the individual install scenarios.
|
||||||
|
|
||||||
|
|
@ -19,10 +22,6 @@ For multiple options, use one `-e` argument per option.
|
||||||
For docker-compose options are configured using an `.env` file.
|
For docker-compose options are configured using an `.env` file.
|
||||||
Follow the docker-compose setup in the README and copy `.env.sample` to `.env`. Then modify the options in `.env`.
|
Follow the docker-compose setup in the README and copy `.env.sample` to `.env`. Then modify the options in `.env`.
|
||||||
|
|
||||||
### Manual setup
|
|
||||||
|
|
||||||
All options need to be defined as environment variables in the environment that linkding runs in.
|
|
||||||
|
|
||||||
## List of options
|
## List of options
|
||||||
|
|
||||||
### `LD_SUPERUSER_NAME`
|
### `LD_SUPERUSER_NAME`
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# Keyboard Shortcuts
|
---
|
||||||
|
title: "Keyboard Shortcuts"
|
||||||
|
description: "Keyboard Shortcuts"
|
||||||
|
---
|
||||||
|
|
||||||
The following keyboard shortcuts are currently available:
|
The following keyboard shortcuts are currently available:
|
||||||
|
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
# Troubleshooting
|
---
|
||||||
|
title: "Troubleshooting"
|
||||||
|
description: "Common issues and solutions"
|
||||||
|
---
|
||||||
|
|
||||||
## Login fails with `403 CSRF verfication failed`
|
## Login fails with `403 CSRF verfication failed`
|
||||||
|
|
||||||
|
|
@ -6,13 +9,13 @@ This can be the case when using a reverse proxy that rewrites the `Host` header,
|
||||||
Since linkding version 1.15, the application includes a CSRF check that verifies that the `Origin` request header matches the `Host` header.
|
Since linkding version 1.15, the application includes a CSRF check that verifies that the `Origin` request header matches the `Host` header.
|
||||||
If the `Host` header is modified by the reverse proxy then this check fails.
|
If the `Host` header is modified by the reverse proxy then this check fails.
|
||||||
|
|
||||||
To fix this, check the [reverse proxy setup documentation](../README.md#reverse-proxy-setup) on how to configure header forwarding for your proxy server, or alternatively configure the [`LD_CSRF_TRUSTED_ORIGINS` option](Options.md#LD_CSRF_TRUSTED_ORIGINS) to the URL from which you are accessing your linkding instance.
|
To fix this, check the [reverse proxy setup documentation](/installation#reverse-proxy-setup) on how to configure header forwarding for your proxy server, or alternatively configure the [`LD_CSRF_TRUSTED_ORIGINS` option](/options#ld_csrf_trusted_origins) to the URL from which you are accessing your linkding instance.
|
||||||
|
|
||||||
## Import fails with `502 Bad Gateway`
|
## Import fails with `502 Bad Gateway`
|
||||||
|
|
||||||
The default timeout for requests is 60 seconds, after which the application server will cancel the request and return the above error.
|
The default timeout for requests is 60 seconds, after which the application server will cancel the request and return the above error.
|
||||||
Depending on the system that the application runs on, and the number of bookmarks that need to be imported, the import may take longer than the default 60 seconds.
|
Depending on the system that the application runs on, and the number of bookmarks that need to be imported, the import may take longer than the default 60 seconds.
|
||||||
|
|
||||||
To increase the timeout you can configure the [`LD_REQUEST_TIMEOUT` option](Options.md#LD_REQUEST_TIMEOUT).
|
To increase the timeout you can configure the [`LD_REQUEST_TIMEOUT` option](/options#ld_request_timeout).
|
||||||
|
|
||||||
Note that any proxy servers that you are running in front of linkding may have their own timeout settings, which are not affected by the variable.
|
Note that any proxy servers that you are running in front of linkding may have their own timeout settings, which are not affected by the variable.
|
||||||
2
docs/src/env.d.ts
vendored
Normal file
2
docs/src/env.d.ts
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
/// <reference path="../.astro/types.d.ts" />
|
||||||
|
/// <reference types="astro/client" />
|
||||||
16
docs/src/styles/custom.css
Normal file
16
docs/src/styles/custom.css
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
:root[data-theme='light'],
|
||||||
|
[data-theme='light'] ::backdrop {
|
||||||
|
--sl-color-accent: hsl(241, 63%, 59%);
|
||||||
|
--sl-color-text-accent: hsl(241, 63%, 55%);
|
||||||
|
|
||||||
|
--sl-nav-gap: 0.8rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Align site search */
|
||||||
|
.header .title-wrapper + div.sl-flex {
|
||||||
|
justify-content: flex-end;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-title img {
|
||||||
|
height: 36px;
|
||||||
|
}
|
||||||
3
docs/tsconfig.json
Normal file
3
docs/tsconfig.json
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
{
|
||||||
|
"extends": "astro/tsconfigs/strict"
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue