mirror of
https://github.com/sissbruecker/linkding.git
synced 2025-08-06 10:28:27 +02:00
d87dde6bae
* Implement initial background tasks concept * fix property reference * update requirements.txt * simplify bookmark null check * improve web archive url display * add background tasks test * add basic supervisor setup * schedule missing snapshot creation on login * remove task locks and clear task history before starting background task processor * batch create snapshots after import * fix script reference in supervisord.conf * add option to disable background tasks * restructure feature overview
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# Options
|
|
|
|
This document lists the options that linkding can be configured with and explains how to use them in the individual install scenarios.
|
|
|
|
## Using options
|
|
|
|
### Docker
|
|
|
|
Options are passed as environment variables to the Docker container by using the `-e` argument when using `docker run`. For example:
|
|
|
|
```
|
|
docker run --name linkding -p 9090:9090 -d -e LD_DISABLE_URL_VALIDATION=True sissbruecker/linkding:latest
|
|
```
|
|
|
|
For multiple options, use one `-e` argument per option.
|
|
|
|
### Docker-compose
|
|
|
|
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`.
|
|
|
|
### Manual setup
|
|
|
|
All options need to be defined as environment variables in the environment that linkding runs in.
|
|
|
|
## List of options
|
|
|
|
### `LD_DISABLE_BACKGROUND_TASKS`
|
|
|
|
Values: `True`, `False` | Default = `False`
|
|
|
|
Disables background tasks, such as creating snapshots for bookmarks on the web archive.
|
|
Enabling this flag will prevent the background task processor from starting up, and prevents scheduling tasks.
|
|
This might be useful if you are experiencing performance issues or other problematic behaviour due to background task processing.
|
|
|
|
### `LD_DISABLE_URL_VALIDATION`
|
|
|
|
Values: `True`, `False` | Default = `False`
|
|
|
|
Completely disables URL validation for bookmarks.
|
|
This can be useful if you intend to store non fully qualified domain name URLs, such as network paths, or you want to store URLs that use another protocol than `http` or `https`.
|
|
|
|
### `LD_REQUEST_TIMEOUT`
|
|
|
|
Values: `Integer` as seconds | Default = `60`
|
|
|
|
Configures the request timeout in the uwsgi application server. This can be useful if you want to import a bookmark file with a high number of bookmarks and run into request timeouts. |